SAML

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.

Authorizations

basicAuthjwtAuth

AuthorizationstringRequired

Path parameters

typestring · enumRequiredPossible values:

Body

multipart/form-data

fileobjectOptional

Responses

200

Certificate successfully changed

No content

post/security/saml/certificate/{type}

HTTPcURLJavaScriptPython

POST /rest/2.0/security/saml/certificate/{type} HTTP/1.1
Authorization: Basic username:password
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.

Authorizations

basicAuthjwtAuth

AuthorizationstringRequired

Path parameters

typestring · enumRequiredPossible values:

Responses

200

The certificate was successfully deleted.

No content

delete/security/saml/certificate/{type}

HTTPcURLJavaScriptPython

DELETE /rest/2.0/security/saml/certificate/{type} HTTP/1.1
Authorization: Basic username:password
Accept: */*

200

The certificate was successfully deleted.

No content

Returns the SAML Service Provider metadata for this instance.

get

Returns the SAML Service Provider metadata for this instance.

Authorizations

basicAuthjwtAuth

AuthorizationstringRequired

Query parameters

completebooleanOptional

Whether or not the meta data generated should include the non-required attributes (completeMetadata = true means all the non-essential attributes too).

Responses

200

metadata successfully found.

application/xml

get/security/saml

HTTPcURLJavaScriptPython

GET /rest/2.0/security/saml HTTP/1.1
Authorization: Basic username:password
Accept: */*

200

metadata successfully found.