Update a SAML Service Provider - PUT /SamlServiceProvider (v2.0 and up)
Update the SAML service provider’s details.
The ‘Manage Authentication Providers’ permission is required to execute this API.
Usage:
GET /SamlServiceProvider and get details of the SAML service provider
PUT /SamlServiceProvider and update the SAML service provider’s details
URL
/cxrestapi/auth/SamlServiceProvider
Method:
PUT
Media Type (header):
Authorization: Bearer <access token value>
Content-Type: application/json;v=1.0
Parameters
Content-type [multipart/form-data]: Specifies the SAML Service Provider details
CertificateFile=[file] – Service provider certificate file
CertificatePassword=[string] – Service provider certificate password
Issuer=[string] - SAML authentication request issuer
Success Response:
Code: 204 Success
Error Response:
Code: 400 Returns error messages
Code: 401 Unauthorized
Code: 403 Forbidden
Sample Response:
no content
Notes:
Updates the SAML service provider details according to the defined parameters. Once the request is successful, it does not return any content. If the request fails, it returns an error response.
Related content
Send Documentation Feedback - If you have comments about this documentation, you can contact the documentation team by sending your feedback to us. We appreciate your feedback!