Get OIDC Auth Request details
Get OIDC Auth Request details by ID, obtained from the redirect URL. Returns details that are parsed from the application's Auth Request.
Path Parameters
- authRequestId string required
ID of the Auth Request, as obtained from the redirect URL.
- 200
- 403
- 404
- default
OK
- application/json
- application/grpc
- application/grpc-web+proto
- Schema
- Example (from schema)
Schema
authRequest object
id stringID of the authorization request
creationDate date-timeTime when the auth request was created
clientId stringOIDC client ID of the application that created the auth request
scope string[]Requested scopes by the application, which the user must consent to.
redirectUri stringBase 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 stringLogin hint can be set by the application with a user identifier such as an email or phone number.
maxAge stringSpecifies 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 stringUser ID taken from a ID Token Hint if it was present and valid.
{
"authRequest": {
"id": "string",
"creationDate": "2023-07-31",
"clientId": "string",
"scope": [
"string"
],
"redirectUri": "string",
"prompt": [
"PROMPT_UNSPECIFIED"
],
"uiLocales": [
"string"
],
"loginHint": "string",
"maxAge": "string",
"hintUserId": "string"
}
}
- Schema
- Example (from schema)
Schema
authRequest object
id stringID of the authorization request
creationDate date-timeTime when the auth request was created
clientId stringOIDC client ID of the application that created the auth request
scope string[]Requested scopes by the application, which the user must consent to.
redirectUri stringBase 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 stringLogin hint can be set by the application with a user identifier such as an email or phone number.
maxAge stringSpecifies 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 stringUser ID taken from a ID Token Hint if it was present and valid.
{
"authRequest": {
"id": "string",
"creationDate": "2023-07-31",
"clientId": "string",
"scope": [
"string"
],
"redirectUri": "string",
"prompt": [
"PROMPT_UNSPECIFIED"
],
"uiLocales": [
"string"
],
"loginHint": "string",
"maxAge": "string",
"hintUserId": "string"
}
}
- Schema
- Example (from schema)
Schema
authRequest object
id stringID of the authorization request
creationDate date-timeTime when the auth request was created
clientId stringOIDC client ID of the application that created the auth request
scope string[]Requested scopes by the application, which the user must consent to.
redirectUri stringBase 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 stringLogin hint can be set by the application with a user identifier such as an email or phone number.
maxAge stringSpecifies 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 stringUser ID taken from a ID Token Hint if it was present and valid.
{
"authRequest": {
"id": "string",
"creationDate": "2023-07-31",
"clientId": "string",
"scope": [
"string"
],
"redirectUri": "string",
"prompt": [
"PROMPT_UNSPECIFIED"
],
"uiLocales": [
"string"
],
"loginHint": "string",
"maxAge": "string",
"hintUserId": "string"
}
}
Returned when the user does not have permission to access the resource.
- application/json
- application/grpc
- application/grpc-web+proto
- Schema
- Example (from schema)
Schema
- code int32
- message string
details object[]
Array [@type string]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
- code int32
- message string
details object[]
Array [@type string]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
- code int32
- message string
details object[]
Array [@type string]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Returned when the resource does not exist.
- application/json
- application/grpc
- application/grpc-web+proto
- Schema
- Example (from schema)
Schema
- code int32
- message string
details object[]
Array [@type string]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
- code int32
- message string
details object[]
Array [@type string]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
- code int32
- message string
details object[]
Array [@type string]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
An unexpected error response.
- application/json
- application/grpc
- application/grpc-web+proto
- Schema
- Example (from schema)
Schema
- code int32
- message string
details object[]
Array [@type string]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
- code int32
- message string
details object[]
Array [@type string]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
- code int32
- message string
details object[]
Array [@type string]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}