Update SSO Server Definition Properties
The Update SSO Server Definition Properties operation updates the properties of a single SSO Server Definition object that is designated by its element ID. [Added by feature single-sign-on]
HTTP method and URI
POST /api/console/sso-server-definitions/{sso-server-definition-id}In this request, the URI variable {sso-server-definition-id} is the element ID of the SSO Server Definition object whose properties are to be updated.
Request body contents
The request body is expected to contain a JSON object that provides the new values of any writable property that is to be updated by this operation. Field names and data types in this JSON object are expected to match the corresponding property names and data types defined by the Data Model for this object type. The JSON object can and should omit fields for properties whose values are not to be changed by this operation.
Description
This operation updates writable properties of the SSO Server Definition object specified by {sso-server-definition-id}.
On successful execution, the SSO Server Definition object has been updated with the supplied property values and status code 204 (No Content) is returned without supplying a response body.
The URI path must designate an existing SSO Server Definition object; otherwise, HTTP status code 404 (Not Found) is returned. In addition, the API user must have action/task permission to the Manage Single Sign-On Servers task; otherwise, HTTP status code 403 (Forbidden) is returned.
The request body is validated against the schema described in Request body contents. If the request body is not valid, HTTP status code 400 (Bad Request) is returned with a reason code indicating the validation error encountered.
The request body does not need to specify a value for all writable properties, but rather can and should contain fields only for the properties to be updated. Object properties for which no input value is provided remain unchanged by this operation unless a prerequisite or linked property is changed.
If the update changes the value of any property for which Property Change notifications are due, those notifications are emitted asynchronously to this operation.
Authorization requirements
This operation has the following authorization requirement:
- Action/task permission to the Manage Single Sign-On Servers task
HTTP status and reason codes
On success, HTTP status code 204 (No Content) is returned and no response body is provided.
The following HTTP status codes are returned for the indicated errors, and the response body is a standard error response body providing the reason code indicated and associated error message.
| HTTP error status code | Reason code | Description |
|---|---|---|
| 400 (Bad Request) | Various | Errors were detected during common request validation. See Common request validation reason codes for a list of the possible reason codes. |
| 315 | The authentication-page-servers array contains a duplicate element. | |
| 403 (Forbidden) | 1 | The API user does not have the required permission for this operation. |
| 404 (Not Found) | 1 | The element ID in the request URI {sso-server-definition-id} does not designate an existing SSO Server Definition object or the API user has no access permission to it. |
Additional standard status and reason codes can be returned, as described in Invoking API operations.
Example HTTP interaction
POST /api/console/sso-server-definitions/c6a464c2-a211-11ef-bbc4-fa163e7cf285 HTTP/1.1
Content-Length: 93
Content-Type: application/json
x-api-session: 5h8xh9t2mrd0259hlld3vyw1chbwjkzgf50tah5hpxuq8hg011
{
"description":"SSO server 1, version 1.5",
"logout-url":"https://sso1.example.com/logoff"
}204 No content
Cache-control: no-cache
Date: Wed, 13 Nov 2024 23:06:13 GMT
<No response body>