Enable Identity Provider
You can enable a user to authenticate himself using the identity provider.
Request
To allow a user to authenticate himself using the identity provider, send the HTTP POST request to the /settings/saml2/idp/used endpoint.
HTTP Request
POST https://<hostname>/api/v3/settings/saml2/idp/used |
Request Headers
The request contains the following headers.
Header | Required | Value | Description |
|---|---|---|---|
Authorization | Required | Bearer <Access-Token> | Authenticates a client who sends the request to the server. Must contain the access token for the current logon session in the Bearer <Access-Token> format. |
Request Body
To enable a user to authenticate himself using the identity provider, send the request in the following format:
{ "entityId": "string", "enabled": true } |
Response
The server returns the following response to the client.
Response Codes
A successfully completed operation returns a response code 204 (No Content).
Response Headers
The response to this request contains the following headers. The response may also include additional standard HTTP headers.
Header | Value | Description |
|---|---|---|
Content-length | integer | Identifies the length of the response body message, in bytes. |
Content-type |
| Identifies the media type of the response body message. |
Example
The following request allows a user to authenticate himself using the identity provider.
|