Get Identity Provider Logout Url V2 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	✔️	✔️

Request

URI

POST

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

COPY

Query Parameters

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.

string

orgId

Optional

The organization id

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

Header Parameters

string

Optional

The session cookie used during login

Request Body

Defines the properties of ID token object

IdTokenDto of type(s) application/json

Required

{
    "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

This operation uses the following authentication methods.

Bearer

Responses

302

Found

Returns string of type(s) application/json

Operation doesn't return any data structure

404

The requested resource could not be found

Returns CspErrorResponse of type(s) application/json

"CspErrorResponse Object"

string

cspErrorCode

Optional

cspErrorCode

string

message

Optional

message

string

errorCode

Optional

errorCode

string

requestId

Optional

requestId

integer As int32 As int32

moduleCode

Optional

moduleCode

integer As int32 As int32

statusCode

Optional

statusCode

409

The request could not be processed due to a conflict

Returns CspErrorResponse of type(s) application/json

"CspErrorResponse Object"

string

cspErrorCode

Optional

cspErrorCode

string

message

Optional

message

string

errorCode

Optional

errorCode

string

requestId

Optional

requestId

integer As int32 As int32

moduleCode

Optional

moduleCode

integer As int32 As int32

statusCode

Optional

statusCode

429

The user has sent too many requests

Returns CspErrorResponse of type(s) application/json

"CspErrorResponse Object"

string

cspErrorCode

Optional

cspErrorCode

string

message

Optional

message

string

errorCode

Optional

errorCode

string

requestId

Optional

requestId

integer As int32 As int32

moduleCode

Optional

moduleCode

integer As int32 As int32

statusCode

Optional

statusCode

500

An unexpected error has occurred while processing the request

Returns CspErrorResponse of type(s) application/json

"CspErrorResponse Object"

string

cspErrorCode

Optional

cspErrorCode

string

message

Optional

message

string

errorCode

Optional

errorCode

string

requestId

Optional

requestId

integer As int32 As int32

moduleCode

Optional

moduleCode

integer As int32 As int32

statusCode

Optional

statusCode

Code Samples

COPY

                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}' https://{api_host}/csp/gateway/am/api/v2/auth/logout

On This Page

Description

Request

Query Parameters

Header Parameters

Request Body

Authentication

Response

Errors

Authentication Operations

POST

Get Identity Provider Logout Url Using POST