Get Identity Provider Logout Url Using POST
This end-point returns the identity provider logout url as a redirect url. In order to logout, an explicit redirect to this url is needed
Access Policy
| Role | User Accounts | Service Accounts (Client Credentials Applications) |
|---|---|---|
| Anonymous | ✔️ | ✔️ |
A post logout redirect URI used to navigate the user to another page than the default Cloud Services Platform logout page.
The URL must be registered in the 'post logout redirect URIs list' of the client that was used in the user login flow and must appear in the provided ID token
Notes: Must be a URLEncoded string with UTF-8 scheme and an absolute URI.
The organization id
The link to the organization trying to access. If not provided, the user's default organization link will be used. Requires to be in the format: /csp/am/api/orgs/{orgId} where {orgId} refers to the organization id. Deprecated, use orgId parameter instead
/csp/am/api/orgs/{orgId}Opaque value used by the browser to maintain state between the logout request and the callback to the endpoint specified by the post_logout_redirect_uri parameter
The session cookie used during login
Defines the properties of ID token object
{
"idToken": "string"
}The ID Token is a signed JWT token returned from the authorization server and contains the user's profile information, including the domain of the identity provider. This domain is used to obtain the identity provider URL. This token is used for optimization so the application can know the identity of the user, without having to make any additional network requests. This token can be generated via the Authorization Code flow only.
OK
"UrlResponse Object"The identity provider logout URL.
The requested resource could not be found
"CspErrorResponse Object"cspErrorCode
message
errorCode
requestId
moduleCode
statusCode
The request could not be processed due to a conflict
"CspErrorResponse Object"cspErrorCode
message
errorCode
requestId
moduleCode
statusCode
The user has sent too many requests
"CspErrorResponse Object"cspErrorCode
message
errorCode
requestId
moduleCode
statusCode
An unexpected error has occurred while processing the request
"CspErrorResponse Object"cspErrorCode
message
errorCode
requestId
moduleCode
statusCode
curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}' https://{api_host}/csp/gateway/am/api/auth/logout