string (AcrValue)
An optional parameter that can be included in the authentication request. This parameter increases the level of user assurance.
Enum: Description phrNote: Multiple space-delimited values may be provided. The authorization server chooses one and reflects the chosen value in any resulting tokens.
Phishing-Resistant. Requires users to provide possession factors that cryptographically verify the sign-in server (the origin). Currently, only FIDO2/WebAuthn satisfies this requirement. Because phishing resistance implies device binding, that constraint is selected automatically when phr
is specified.
Phishing-Resistant Hardware-Protected. Requires that you store keys being used to authenticate in secure hardware (TPM, Secure Enclave) on the device. Currently, only Okta Verify meets this constraint. Because hardware protection implies device binding, that constraint is selected automatically when phrh
is specified.
Any one factor. Allows one factor authentication with no requirements on which factor.
urn:okta:loa:1fa:pwdPassword only. Allows one factor authentication that requires the user’s password.
urn:okta:loa:2fa:anyAny two factors. Allows two factor authentication with no requirements on which factors.
urn:okta:loa:2fa:any:ifpossibleAny two factors, if possible. Allows two factor authentication with no requirements on which factors. Any two factors are presented only if the user is enrolled, otherwise any one factor is presented.
client_idrequired
string
Obtained during either manual client registration or through the Dynamic Client Registration API. It identifies the client and must match the value preregistered in Okta.
code_challengestring
A challenge for PKCE. The challenge is verified in the access token request.
code_challenge_methodstring (CodeChallengeMethod)
Method used to derive the code challenge for PKCE.
Value: "S256" displaystring
The display
parameter to be passed to the external Identity Provider when performing social login.
string (AmrValue)
A space-delimited list of values indicating which authenticators to enroll in.
enroll_amr_values
parameter is specified, then the value for prompt
must be enroll_authenticator
.pwd sms okta_verify
is a valid request parameter value. You are prompted in the order of the amr values provided.string
An Okta Extension to the OpenID specification. A space-delimited list of scopes to be provided to the external Identity Provider when performing social login. These scopes are used in addition to the scopes already configured for the Identity Provider.
idpstring
An Okta Extension to the OpenID Specification. The ID of the Identity Provider to use if there's no Okta Session.
login_hintstring
A username to pre-populate if prompting for authentication
max_ageinteger
Allowable elapsed time, in seconds, since the last time the end user was actively authenticated by Okta.
noncestring
A value that is returned in the ID token. It is used to mitigate replay attacks. The value is required for Implicit and Hybrid flows, but optional for Auth Code flows. See OIDC Specs.
promptstring (Prompt)
If no prompt
parameter is specified, the standard behavior occurs:
Don't prompt for authentication or consent. If an Okta session already exists, the user is silently authenticated. Otherwise, an error is returned.
loginAlways prompt the user for authentication, regardless of whether they have an Okta session.
consentDepending on the values set for consent_method
in the app and consent
for the scope, display the Okta consent dialog, even if the user has already given consent. User consent is available for custom authorization servers (requires the API Access Management feature and the User Consent feature enabled).
Can also be consent login
(order doesn't matter). The user is always prompted for authentication, and the user consent dialog appears depending on the values set for consent_method
in the app and consent
on the scope, even if the user has already given consent.
This indicates that the intent is to enroll the user with an authenticator. The following other parameters must be used together with this value for a valid request:
enroll_amr_values
: Value must be specified and indicates which authenticator method you're allowing the user to enroll.response_type
: Value must be none
, which means no tokens should be returned at the end of the flow.acr_values
: Value must be urn:okta:loa:2fa:any:ifpossible
, which means the user is prompted for at least one factor before enrollment.max_age
: Value must be 0
, which means no existing session should be considered.scope
and nonce
must not be specified, because no tokens are generated.required
string
Callback location where the authorization code or tokens should be sent. It must match the value preregistered in Okta during client registration.
response_typerequired
string (ResponseTypesSupported)
Any combination of code
, token
, and id_token
. The combination determines the flow.
string (ResponseMode)
How the authorization response should be returned. If id_token
or token
is specified in the response_type
, then query
isn't allowed as a response mode. Defaults to fragment
in implicit and hybrid flows.
The Referrer-Policy
header is automatically included in the response when either the fragment or query parameter values are used. The header is set to Referrer-Policy: no-referrer
.
Parameters are encoded in the URL fragment added to the redirect_uri
when redirecting back to the client.
Parameters are encoded in the query string added to the redirect_uri
when redirecting back to the client.
Parameters are encoded as HTML form values (application/x-www-form-urlencoded
format) and are transmitted through the HTTP POST method to the client.
Uses HTML5 Web Messaging (for example, window.postMessage()
) instead of the redirect for the authorization response from the /authorize
endpoint.
okta_post_message
is an adaptation of the Web Message Response Mode. This value provides a secure way for a single-page application to perform a sign-in flow in a pop-up window or an iFrame and receive the ID token, access token, and/or authorization code back in the parent page without leaving the context of that page.
Use the postMessage()
data object to help you when working with the okta_post_message
value of the response_mode
request parameter.
response_type
included token
. string error The error code, if something went wrong string error_description Additional error information (if any) string id_token An ID token. This is returned if the response_type
includes id_token
. string state The unmodified state
value from the request string request_uri
string
Location where the authorization request payload data is referenced in an authorization request to the /authorize
endpoint. This is returned from a Pushed Authorization Request at the /par
endpoint.
string
A JWT created by the client that enables requests to be passed as a single, self-contained parameter.
Note: See Build a JWT for client authentication for information on how to build a JWT.
token_endpoint_auth_method
that uses a client_secret
. RSA and ECDSA signatures requires that the client registers a public key.state
, nonce
, code_challenge
, and code_challenge_method
. In those cases, the values in the JWT overrides the query URI values.request
parameter in the following ways:
iss
is required and must be the client_id
.aud
is required and must be the same value as the Authorization Server issuer that mints the ID or access token. This value is published in the metadata for your Authorization Server.iat
and exp
claims, if present. If the JWT is expired or not yet valid, Okta returns an invalid_request_object
error. Okta rejects JWTs that expire more than one hour in the future.jti
claim is present and it has already been processed.required
string
A space-delimited string of scopes requested
sessionTokenstring
Okta one-time session token. This is an Okta extension to the OpenID specification. The sessionToken
allows an API-based user sign-in flow.
required
string
A value to be returned with the token. The client application can use it to remember the state of its interaction with the end user at the time of the authentication call. It can contain alphanumeric, comma, period, underscore, and hyphen characters.
Okta requires the OAuth 2.0 state
parameter on all requests to the /authorize
endpoint to prevent cross-site request forgery (CSRF). The OAuth 2.0 specification requires that clients protect their redirect URIs against CSRF by sending a value in the authorize request that binds the request to the user-agent's authenticated state. Using the state
parameter is also a countermeasure to several other known attacks as outlined in OAuth 2.0 Threat Model and Security Considerations.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4