Authorize the user to use OIDC.

get https://{tenanturl}/oauth2/authorize

Use this API to authorize a user to use OIDC. This endpoint requires valid login session cookies for the tenant.

Query Params

client_id

string

required

The OIDC client ID.

response_type

string

Defaults to code

A space-delimited list of response types. Valid response types are: code, token, id_token.

response_mode

string

The response mode. It defaults to query for the authorization_code flow, and to fragment for the implicit or hybrid flow.

redirect_uri

string

The redirect URI.

state

string

The state. An opaque value that is used to maintain the state between the request and the callback.

nonce

string

Nonce. The string value that is used to associate a client session with an ID Token to mitigate replay attacks. This attribute is required when the response type includes id_token.

prompt

string

Whether the user is prompted for reauthentication. When the value is "login", the user is reauthenticated. When the value is "none", the user is not be prompted for authentication.

max_age

integer

Maximum authentication age. Specifies the allowable elapsed time, in seconds, since the last time the user was authenticated.

code_challenge

string

Code challenge. Required if the OIDC client is configured to require proof key for code exchange (PKCE).

code_challenge_method

string

Code challenge method for PKCE.

scope

string

A space-delimited list of scopes that are associated with this authorization request.

claims

string

The JSON that contains the claims for id_token or userinfo endpoint.

login_hint

string

Login hint. Value to use when prompting the user for login. Optional for OIDC request. This value is the username as a string (e.g. john@ibm.com).

request

string

The request object in the form of a signed JWT. This can be used as an alternative to sending the individual properties in the form.

request_uri

string

The URI referencing the request object.

Responses

200

Form post response.

400

The error page that contains the error and error_description attributes.

Language

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url 'https://tenant_url/oauth2/authorize?response_type=code'

Choose an example:

*/*

302Redirect response.