[{"label":"Latest (v1.0)","version":"latest"}]
csp

Get Identity Provider Logout URL

Description

This end-point returns the identity provider logout url. In order to logout, an explicit redirect to this url is needed

Access Policy

Role User Accounts Service Accounts (Client Credentials Applications)
Anonymous ✔️ ✔️

Request

Request

URL

URL


post
https://{api_host}/csp/gateway/am/api/auth/logout
Copy

Query Parameters

Query Parameters

string
orgId Optional

The organization id

Parameter Serialization Style: form Explode:true

string
orgLink Optional

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

Parameter Serialization Style: form Explode:true
orgLink example
"/csp/am/api/orgs/{orgId}"

string
post_logout_redirect_uri Optional

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.

Parameter Serialization Style: form Explode:true

string
state Optional

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

Parameter Serialization Style: form Explode:true

Request Body

Request Body

IdTokenDto of mimetype application/json Required

Defines the properties of ID token object

{
	"idToken": "string"
}
string
idToken Optional

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.

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK

Returns UrlResponse of type application/json
{
	"url": "string"
}
string
url Optional

The identity provider logout URL.

Errors

Errors

404

The requested resource could not be found


409

The request could not be processed due to a conflict


429

The user has sent too many requests


500

An unexpected error has occurred while processing the request

Code Samples

Code Samples

cURL Command

curl -X POST -H "Content-Type: application/json" -d '{"idToken":"string"}' https://{api_host}/csp/gateway/am/api/auth/logout
Vendor Extensions

Vendor Extensions

This operation contains the following vendor extensions defined in the spec:
x-required-roles: ""
x-slo-tier: TIER2


Feedback

Was this page helpful?