Console Saml

Download the saml.xml configuration file

get

Responses

200

The file

No content

204

File does not exist

get/samlconsole

GET /rest/samlconsole HTTP/1.1
Accept: */*

No content

Update the saml.xml configuration by uploading a new file

post

Body

entityobjectOptional

messageBodyWorkersobject · MessageBodyWorkersOptional

providersobject · ProvidersOptional

Responses

204

File uploaded

No content

500

File failed to upload

post/samlconsole

POST /rest/samlconsole HTTP/1.1
Content-Type: multipart/form-data
Accept: */*
Content-Length: 12068

{
  "bodyParts": [
    {
      "contentDisposition": {
        "creationDate": "2026-01-01T00:00:00.000Z",
        "fileName": "text",
        "modificationDate": "2026-01-01T00:00:00.000Z",
        "parameters": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "readDate": "2026-01-01T00:00:00.000Z",
        "size": 1,
        "type": "text"
      },
      "entity": {},
      "headers": {
        "empty": true,
        "ANY_ADDITIONAL_PROPERTY": [
          "text"
        ]
      },
      "mediaType": {
        "parameters": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "subtype": "text",
        "type": "text",
        "wildcardSubtype": true,
        "wildcardType": true
      },
      "messageBodyWorkers": {},
      "parameterizedHeaders": {
        "empty": true,
        "ANY_ADDITIONAL_PROPERTY": [
          {
            "parameters": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "value": "text"
          }
        ]
      },
      "parent": {
        "bodyParts": [
          {
            "contentDisposition": {
              "creationDate": "2026-01-01T00:00:00.000Z",
              "fileName": "text",
              "modificationDate": "2026-01-01T00:00:00.000Z",
              "parameters": {
                "ANY_ADDITIONAL_PROPERTY": "text"
              },
              "readDate": "2026-01-01T00:00:00.000Z",
              "size": 1,
              "type": "text"
            },
            "entity": {},
            "headers": {
              "empty": true,
              "ANY_ADDITIONAL_PROPERTY": [
                "text"
              ]
            },
            "mediaType": {
              "parameters": {
                "ANY_ADDITIONAL_PROPERTY": "text"
              },
              "subtype": "text",
              "type": "text",
              "wildcardSubtype": true,
              "wildcardType": true
            },
            "messageBodyWorkers": {},
            "parameterizedHeaders": {
              "empty": true,
              "ANY_ADDITIONAL_PROPERTY": [
                {
                  "parameters": {
                    "ANY_ADDITIONAL_PROPERTY": "text"
                  },
                  "value": "text"
                }
              ]
            },
            "parent": "[Circular Reference]",
            "providers": {}
          }
        ],
        "contentDisposition": {
          "creationDate": "2026-01-01T00:00:00.000Z",
          "fileName": "text",
          "modificationDate": "2026-01-01T00:00:00.000Z",
          "parameters": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "readDate": "2026-01-01T00:00:00.000Z",
          "size": 1,
          "type": "text"
        },
        "entity": {},
        "headers": {
          "empty": true,
          "ANY_ADDITIONAL_PROPERTY": [
            "text"
          ]
        },
        "mediaType": {
          "parameters": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "subtype": "text",
          "type": "text",
          "wildcardSubtype": true,
          "wildcardType": true
        },
        "messageBodyWorkers": {},
        "parameterizedHeaders": {
          "empty": true,
          "ANY_ADDITIONAL_PROPERTY": [
            {
              "parameters": {
                "ANY_ADDITIONAL_PROPERTY": "text"
              },
              "value": "text"
            }
          ]
        },
        "parent": {
          "bodyParts": [
            {
              "contentDisposition": {
                "creationDate": "2026-01-01T00:00:00.000Z",
                "fileName": "text",
                "modificationDate": "2026-01-01T00:00:00.000Z",
                "parameters": {
                  "ANY_ADDITIONAL_PROPERTY": "text"
                },
                "readDate": "2026-01-01T00:00:00.000Z",
                "size": 1,
                "type": "text"
              },
              "entity": {},
              "headers": {
                "empty": true,
                "ANY_ADDITIONAL_PROPERTY": [
                  "text"
                ]
              },
              "mediaType": {
                "parameters": {
                  "ANY_ADDITIONAL_PROPERTY": "text"
                },
                "subtype": "text",
                "type": "text",
                "wildcardSubtype": true,
                "wildcardType": true
              },
              "messageBodyWorkers": {},
              "parameterizedHeaders": {
                "empty": true,
                "ANY_ADDITIONAL_PROPERTY": [
                  {
                    "parameters": {
                      "ANY_ADDITIONAL_PROPERTY": "text"
                    },
                    "value": "text"
                  }
                ]
              },
              "parent": "[Circular Reference]",
              "providers": {}
            }
          ],
          "contentDisposition": {
            "creationDate": "2026-01-01T00:00:00.000Z",
            "fileName": "text",
            "modificationDate": "2026-01-01T00:00:00.000Z",
            "parameters": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "readDate": "2026-01-01T00:00:00.000Z",
            "size": 1,
            "type": "text"
          },
          "entity": {},
          "headers": {
            "empty": true,
            "ANY_ADDITIONAL_PROPERTY": [
              "text"
            ]
          },
          "mediaType": {
            "parameters": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "subtype": "text",
            "type": "text",
            "wildcardSubtype": true,
            "wildcardType": true
          },
          "messageBodyWorkers": {},
          "parameterizedHeaders": {
            "empty": true,
            "ANY_ADDITIONAL_PROPERTY": [
              {
                "parameters": {
                  "ANY_ADDITIONAL_PROPERTY": "text"
                },
                "value": "text"
              }
            ]
          },
          "parent": {
            "bodyParts": "[Circular Reference]",
            "contentDisposition": {
              "creationDate": "2026-01-01T00:00:00.000Z",
              "fileName": "text",
              "modificationDate": "2026-01-01T00:00:00.000Z",
              "parameters": {
                "ANY_ADDITIONAL_PROPERTY": "text"
              },
              "readDate": "2026-01-01T00:00:00.000Z",
              "size": 1,
              "type": "text"
            },
            "entity": {},
            "headers": {
              "empty": true,
              "ANY_ADDITIONAL_PROPERTY": [
                "text"
              ]
            },
            "mediaType": {
              "parameters": {
                "ANY_ADDITIONAL_PROPERTY": "text"
              },
              "subtype": "text",
              "type": "text",
              "wildcardSubtype": true,
              "wildcardType": true
            },
            "messageBodyWorkers": {},
            "parameterizedHeaders": {
              "empty": true,
              "ANY_ADDITIONAL_PROPERTY": [
                {
                  "parameters": {
                    "ANY_ADDITIONAL_PROPERTY": "text"
                  },
                  "value": "text"
                }
              ]
            },
            "parent": "[Circular Reference]",
            "providers": {}
          },
          "providers": {}
        },
        "providers": {}
      },
      "providers": {}
    }
  ],
  "contentDisposition": {
    "creationDate": "2026-01-01T00:00:00.000Z",
    "fileName": "text",
    "modificationDate": "2026-01-01T00:00:00.000Z",
    "parameters": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "readDate": "2026-01-01T00:00:00.000Z",
    "size": 1,
    "type": "text"
  },
  "entity": {},
  "fields": {
    "ANY_ADDITIONAL_PROPERTY": [
      {
        "content": {},
        "contentDisposition": {
          "creationDate": "2026-01-01T00:00:00.000Z",
          "fileName": "text",
          "modificationDate": "2026-01-01T00:00:00.000Z",
          "parameters": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "readDate": "2026-01-01T00:00:00.000Z",
          "size": 1,
          "type": "text"
        },
        "entity": {},
        "fileName": "text",
        "formDataContentDisposition": {
          "creationDate": "2026-01-01T00:00:00.000Z",
          "fileName": "text",
          "modificationDate": "2026-01-01T00:00:00.000Z",
          "name": "text",
          "parameters": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "readDate": "2026-01-01T00:00:00.000Z",
          "size": 1,
          "type": "text"
        },
        "headers": {
          "empty": true,
          "ANY_ADDITIONAL_PROPERTY": [
            "text"
          ]
        },
        "mediaType": {
          "parameters": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "subtype": "text",
          "type": "text",
          "wildcardSubtype": true,
          "wildcardType": true
        },
        "messageBodyWorkers": {},
        "name": "text",
        "parameterizedHeaders": {
          "empty": true,
          "ANY_ADDITIONAL_PROPERTY": [
            {
              "parameters": {
                "ANY_ADDITIONAL_PROPERTY": "text"
              },
              "value": "text"
            }
          ]
        },
        "parent": {
          "bodyParts": [
            {
              "contentDisposition": {
                "creationDate": "2026-01-01T00:00:00.000Z",
                "fileName": "text",
                "modificationDate": "2026-01-01T00:00:00.000Z",
                "parameters": {
                  "ANY_ADDITIONAL_PROPERTY": "text"
                },
                "readDate": "2026-01-01T00:00:00.000Z",
                "size": 1,
                "type": "text"
              },
              "entity": {},
              "headers": {
                "empty": true,
                "ANY_ADDITIONAL_PROPERTY": [
                  "text"
                ]
              },
              "mediaType": {
                "parameters": {
                  "ANY_ADDITIONAL_PROPERTY": "text"
                },
                "subtype": "text",
                "type": "text",
                "wildcardSubtype": true,
                "wildcardType": true
              },
              "messageBodyWorkers": {},
              "parameterizedHeaders": {
                "empty": true,
                "ANY_ADDITIONAL_PROPERTY": [
                  {
                    "parameters": {
                      "ANY_ADDITIONAL_PROPERTY": "text"
                    },
                    "value": "text"
                  }
                ]
              },
              "parent": "[Circular Reference]",
              "providers": {}
            }
          ],
          "contentDisposition": {
            "creationDate": "2026-01-01T00:00:00.000Z",
            "fileName": "text",
            "modificationDate": "2026-01-01T00:00:00.000Z",
            "parameters": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "readDate": "2026-01-01T00:00:00.000Z",
            "size": 1,
            "type": "text"
          },
          "entity": {},
          "headers": {
            "empty": true,
            "ANY_ADDITIONAL_PROPERTY": [
              "text"
            ]
          },
          "mediaType": {
            "parameters": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "subtype": "text",
            "type": "text",
            "wildcardSubtype": true,
            "wildcardType": true
          },
          "messageBodyWorkers": {},
          "parameterizedHeaders": {
            "empty": true,
            "ANY_ADDITIONAL_PROPERTY": [
              {
                "parameters": {
                  "ANY_ADDITIONAL_PROPERTY": "text"
                },
                "value": "text"
              }
            ]
          },
          "parent": {
            "bodyParts": [
              {
                "contentDisposition": {
                  "creationDate": "2026-01-01T00:00:00.000Z",
                  "fileName": "text",
                  "modificationDate": "2026-01-01T00:00:00.000Z",
                  "parameters": {
                    "ANY_ADDITIONAL_PROPERTY": "text"
                  },
                  "readDate": "2026-01-01T00:00:00.000Z",
                  "size": 1,
                  "type": "text"
                },
                "entity": {},
                "headers": {
                  "empty": true,
                  "ANY_ADDITIONAL_PROPERTY": [
                    "text"
                  ]
                },
                "mediaType": {
                  "parameters": {
                    "ANY_ADDITIONAL_PROPERTY": "text"
                  },
                  "subtype": "text",
                  "type": "text",
                  "wildcardSubtype": true,
                  "wildcardType": true
                },
                "messageBodyWorkers": {},
                "parameterizedHeaders": {
                  "empty": true,
                  "ANY_ADDITIONAL_PROPERTY": [
                    {
                      "parameters": {
                        "ANY_ADDITIONAL_PROPERTY": "text"
                      },
                      "value": "text"
                    }
                  ]
                },
                "parent": "[Circular Reference]",
                "providers": {}
              }
            ],
            "contentDisposition": {
              "creationDate": "2026-01-01T00:00:00.000Z",
              "fileName": "text",
              "modificationDate": "2026-01-01T00:00:00.000Z",
              "parameters": {
                "ANY_ADDITIONAL_PROPERTY": "text"
              },
              "readDate": "2026-01-01T00:00:00.000Z",
              "size": 1,
              "type": "text"
            },
            "entity": {},
            "headers": {
              "empty": true,
              "ANY_ADDITIONAL_PROPERTY": [
                "text"
              ]
            },
            "mediaType": {
              "parameters": {
                "ANY_ADDITIONAL_PROPERTY": "text"
              },
              "subtype": "text",
              "type": "text",
              "wildcardSubtype": true,
              "wildcardType": true
            },
            "messageBodyWorkers": {},
            "parameterizedHeaders": {
              "empty": true,
              "ANY_ADDITIONAL_PROPERTY": [
                {
                  "parameters": {
                    "ANY_ADDITIONAL_PROPERTY": "text"
                  },
                  "value": "text"
                }
              ]
            },
            "parent": {
              "bodyParts": "[Circular Reference]",
              "contentDisposition": {
                "creationDate": "2026-01-01T00:00:00.000Z",
                "fileName": "text",
                "modificationDate": "2026-01-01T00:00:00.000Z",
                "parameters": {
                  "ANY_ADDITIONAL_PROPERTY": "text"
                },
                "readDate": "2026-01-01T00:00:00.000Z",
                "size": 1,
                "type": "text"
              },
              "entity": {},
              "headers": {
                "empty": true,
                "ANY_ADDITIONAL_PROPERTY": [
                  "text"
                ]
              },
              "mediaType": {
                "parameters": {
                  "ANY_ADDITIONAL_PROPERTY": "text"
                },
                "subtype": "text",
                "type": "text",
                "wildcardSubtype": true,
                "wildcardType": true
              },
              "messageBodyWorkers": {},
              "parameterizedHeaders": {
                "empty": true,
                "ANY_ADDITIONAL_PROPERTY": [
                  {
                    "parameters": {
                      "ANY_ADDITIONAL_PROPERTY": "text"
                    },
                    "value": "text"
                  }
                ]
              },
              "parent": "[Circular Reference]",
              "providers": {}
            },
            "providers": {}
          },
          "providers": {}
        },
        "providers": {},
        "simple": true,
        "value": "text"
      }
    ]
  },
  "headers": {
    "empty": true,
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "mediaType": {
    "parameters": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "subtype": "text",
    "type": "text",
    "wildcardSubtype": true,
    "wildcardType": true
  },
  "messageBodyWorkers": {},
  "parameterizedHeaders": {
    "empty": true,
    "ANY_ADDITIONAL_PROPERTY": [
      {
        "parameters": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "value": "text"
      }
    ]
  },
  "parent": {
    "bodyParts": [
      {
        "contentDisposition": {
          "creationDate": "2026-01-01T00:00:00.000Z",
          "fileName": "text",
          "modificationDate": "2026-01-01T00:00:00.000Z",
          "parameters": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "readDate": "2026-01-01T00:00:00.000Z",
          "size": 1,
          "type": "text"
        },
        "entity": {},
        "headers": {
          "empty": true,
          "ANY_ADDITIONAL_PROPERTY": [
            "text"
          ]
        },
        "mediaType": {
          "parameters": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "subtype": "text",
          "type": "text",
          "wildcardSubtype": true,
          "wildcardType": true
        },
        "messageBodyWorkers": {},
        "parameterizedHeaders": {
          "empty": true,
          "ANY_ADDITIONAL_PROPERTY": [
            {
              "parameters": {
                "ANY_ADDITIONAL_PROPERTY": "text"
              },
              "value": "text"
            }
          ]
        },
        "parent": "[Circular Reference]",
        "providers": {}
      }
    ],
    "contentDisposition": {
      "creationDate": "2026-01-01T00:00:00.000Z",
      "fileName": "text",
      "modificationDate": "2026-01-01T00:00:00.000Z",
      "parameters": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "readDate": "2026-01-01T00:00:00.000Z",
      "size": 1,
      "type": "text"
    },
    "entity": {},
    "headers": {
      "empty": true,
      "ANY_ADDITIONAL_PROPERTY": [
        "text"
      ]
    },
    "mediaType": {
      "parameters": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "subtype": "text",
      "type": "text",
      "wildcardSubtype": true,
      "wildcardType": true
    },
    "messageBodyWorkers": {},
    "parameterizedHeaders": {
      "empty": true,
      "ANY_ADDITIONAL_PROPERTY": [
        {
          "parameters": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "value": "text"
        }
      ]
    },
    "parent": {
      "bodyParts": [
        {
          "contentDisposition": {
            "creationDate": "2026-01-01T00:00:00.000Z",
            "fileName": "text",
            "modificationDate": "2026-01-01T00:00:00.000Z",
            "parameters": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "readDate": "2026-01-01T00:00:00.000Z",
            "size": 1,
            "type": "text"
          },
          "entity": {},
          "headers": {
            "empty": true,
            "ANY_ADDITIONAL_PROPERTY": [
              "text"
            ]
          },
          "mediaType": {
            "parameters": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "subtype": "text",
            "type": "text",
            "wildcardSubtype": true,
            "wildcardType": true
          },
          "messageBodyWorkers": {},
          "parameterizedHeaders": {
            "empty": true,
            "ANY_ADDITIONAL_PROPERTY": [
              {
                "parameters": {
                  "ANY_ADDITIONAL_PROPERTY": "text"
                },
                "value": "text"
              }
            ]
          },
          "parent": "[Circular Reference]",
          "providers": {}
        }
      ],
      "contentDisposition": {
        "creationDate": "2026-01-01T00:00:00.000Z",
        "fileName": "text",
        "modificationDate": "2026-01-01T00:00:00.000Z",
        "parameters": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "readDate": "2026-01-01T00:00:00.000Z",
        "size": 1,
        "type": "text"
      },
      "entity": {},
      "headers": {
        "empty": true,
        "ANY_ADDITIONAL_PROPERTY": [
          "text"
        ]
      },
      "mediaType": {
        "parameters": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "subtype": "text",
        "type": "text",
        "wildcardSubtype": true,
        "wildcardType": true
      },
      "messageBodyWorkers": {},
      "parameterizedHeaders": {
        "empty": true,
        "ANY_ADDITIONAL_PROPERTY": [
          {
            "parameters": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "value": "text"
          }
        ]
      },
      "parent": {
        "bodyParts": "[Circular Reference]",
        "contentDisposition": {
          "creationDate": "2026-01-01T00:00:00.000Z",
          "fileName": "text",
          "modificationDate": "2026-01-01T00:00:00.000Z",
          "parameters": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "readDate": "2026-01-01T00:00:00.000Z",
          "size": 1,
          "type": "text"
        },
        "entity": {},
        "headers": {
          "empty": true,
          "ANY_ADDITIONAL_PROPERTY": [
            "text"
          ]
        },
        "mediaType": {
          "parameters": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "subtype": "text",
          "type": "text",
          "wildcardSubtype": true,
          "wildcardType": true
        },
        "messageBodyWorkers": {},
        "parameterizedHeaders": {
          "empty": true,
          "ANY_ADDITIONAL_PROPERTY": [
            {
              "parameters": {
                "ANY_ADDITIONAL_PROPERTY": "text"
              },
              "value": "text"
            }
          ]
        },
        "parent": "[Circular Reference]",
        "providers": {}
      },
      "providers": {}
    },
    "providers": {}
  },
  "providers": {}
}

No content

Remove the saml.xml configuration file

delete

Responses

200

File removed

No content

delete/samlconsole

DELETE /rest/samlconsole HTTP/1.1
Accept: */*

200

File removed

No content

Changes the certificate to be used with SAML

post

Replaces the currently used certificate with the one uploaded in PEM format. The PEM file must be unencrypted (no password) and contain both the certificate and the private key.

Body

fileobjectOptional

Responses

200

Certificate successfully changed

No content

post/samlconsole/certificate

POST /rest/samlconsole/certificate HTTP/1.1
Content-Type: multipart/form-data
Accept: */*
Content-Length: 11

{
  "file": {}
}

200

Certificate successfully changed

No content

Delete the specified SAML certificate from the SAML keystore.

delete

Delete the certificate from the SAML keystore and replace it with a generated certificate as done by default.

Responses

200

The certificate was successfully deleted.

No content

delete/samlconsole/certificate

DELETE /rest/samlconsole/certificate HTTP/1.1
Accept: */*

200

The certificate was successfully deleted.

No content

Returns the SAML Service Provider metadata for this instance.

get

Query parameters

completebooleanOptional

Responses

200

metadata successfully found.

No content

get/samlconsole/metadata

GET /rest/samlconsole/metadata HTTP/1.1
Accept: */*

200

metadata successfully found.

No content