• auth
• PushedAuthorizationRequest

Interface PushedAuthorizationRequest

interface PushedAuthorizationRequest {
client_id?: string;
client_secret?: string;
client_assertion?: string;
client_assertion_type?: "urn:ietf:params:oauth:client-assertion-type:jwt-bearer";
redirect_uri: string;
response_type: string;
response_mode?: string;
nonce?: string;
state?: string;
connection?: string;
scope?: string;
audience?: string;
organization?: string;
invitation?: string;
code_challenge?: string;
request?: string;
authorization_details?: string;
key: string: any;
}

Hierarchy (View Summary)

• ClientCredentials
  • PushedAuthorizationRequest

Indexable

Allow for any custom property to be sent to Auth0

Index

Properties

client_id?client_secret?client_assertion?client_assertion_type?redirect_uriresponse_typeresponse_mode?nonce?state?connection?scope?audience?organization?invitation?code_challenge?request?authorization_details?

Properties

Optionalclient_id

client_id?: string

Specify this to override the parent class's clientId

Optionalclient_secret

client_secret?: string

Specify this to override the parent class's clientSecret

Optionalclient_assertion

client_assertion?: string

Specify this to provide your own client assertion JWT rather than the class creating one for you from the clientAssertionSigningKey.

Optionalclient_assertion_type

client_assertion_type?: "urn:ietf:params:oauth:client-assertion-type:jwt-bearer"

If you provide your own client_assertion you should also provide the client_assertion_type.

redirect_uri

redirect_uri: string

URI to redirect to.

response_type

response_type: string

The response_type the client expects.

Optionalresponse_mode

response_mode?: string

The response_mode to use.

Optionalnonce

nonce?: string

The nonce.

Optionalstate

state?: string

State value to be passed back on successful authorization.

Optionalconnection

connection?: string

Name of the connection.

Optionalscope

scope?: string

Scopes to request. Multiple scopes must be separated by a space character.

Optionalaudience

audience?: string

The unique identifier of the target API you want to access.

Optionalorganization

organization?: string

The organization to log the user in to.

Optionalinvitation

invitation?: string

The id of an invitation to accept.

Optionalcode_challenge

code_challenge?: string

A Base64-encoded SHA-256 hash of the AuthorizationCodeGrantWithPKCERequest.code_verifier used for the Authorization Code Flow with PKCE.

Optionalrequest

request?: string

Allows JWT-Secured Authorization Request (JAR), when JAR & PAR request are used together. Reference

Optionalauthorization_details

authorization_details?: string

A JSON stringified array of objects. It can carry fine-grained authorization data in OAuth messages as part of Rich Authorization Requests (RAR) Reference

Settings

Member Visibility

• Protected
• Inherited

ThemeOSLightDark

On This Page

Properties client_idclient_secretclient_assertionclient_assertion_typeredirect_uriresponse_typeresponse_modenoncestateconnectionscopeaudienceorganizationinvitationcode_challengerequestauthorization_details