Skip to main content

Get OIDC Auth Request details

GET 
https://$CUSTOM-DOMAIN/v2/oidc/auth_requests/:authRequestId

Get OIDC Auth Request details by ID, obtained from the redirect URL. Returns details that are parsed from the application's Auth Request.

Request​

Path Parameters

    authRequestId stringrequired

    ID of the Auth Request, as obtained from the redirect URL.

Responses​

OK

Schema

    authRequest

    object

    id string

    ID of the authorization request

    creationDate date-time

    Time when the auth request was created

    clientId string

    OIDC client ID of the application that created the auth request

    scope string[]

    Requested scopes by the application, which the user must consent to.

    redirectUri string

    Base URI that points back to the application

    prompt string[]

    Possible values: [PROMPT_UNSPECIFIED, PROMPT_NONE, PROMPT_LOGIN, PROMPT_CONSENT, PROMPT_SELECT_ACCOUNT, PROMPT_CREATE]

    Prompts that must be displayed to the user

    uiLocales string[]

    End-User's preferred languages and scripts for the user interface, represented as a list of BCP47 [RFC5646] language tag values, ordered by preference. For instance, the value [fr-CA, fr, en] represents a preference for French as spoken in Canada, then French (without a region designation), followed by English (without a region designation). An error SHOULD NOT result if some or all of the requested locales are not supported.

    loginHint string

    Login hint can be set by the application with a user identifier such as an email or phone number.

    maxAge string

    Specifies the allowable elapsed time in seconds since the last time the End-User was actively authenticated. If the elapsed time is greater than this value, or the field is present with 0 duration, the user must be re-authenticated.

    hintUserId string

    User ID taken from a ID Token Hint if it was present and valid.

curl -L 'https://$CUSTOM-DOMAIN/v2/oidc/auth_requests/:authRequestId' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'
Request Collapse all
Base URL
https://$CUSTOM-DOMAIN
Auth
Parameters
— pathrequired
ResponseClear

Click the Send API Request button above and see the response here!