Oihana PHP Enums

OAuth2Parameter uses ConstantsTrait

Enumeration of OAuth 2.0 / OpenID Connect request parameter names.

Centralises the standard parameter names used as keys when building authorization, token, introspection, revocation, device, exchange, pushed authorization or logout requests.

Example:

$response = $client->post( $tokenEndpoint ,
[
    GuzzleOption::FORM_PARAMS =>
    [
        OAuth2Parameter::GRANT_TYPE => ZitadelGrant::JWT_BEARER ,
        OAuth2Parameter::SCOPE      => ZitadelScope::OPENID ,
        OAuth2Parameter::ASSERTION  => $assertion ,
    ]
]) ;

Covered specifications:

  • RFC 6749 (OAuth 2.0 core)
  • RFC 7009 (Token Revocation)
  • RFC 7522 (SAML 2.0 Bearer assertion)
  • RFC 7523 (JWT Bearer assertion)
  • RFC 7636 (PKCE)
  • RFC 7662 (Token Introspection)
  • RFC 8628 (Device Authorization Grant)
  • RFC 8693 (Token Exchange)
  • RFC 8707 (Resource Indicators)
  • RFC 9126 (Pushed Authorization Requests — PAR)
  • RFC 9396 (Rich Authorization Requests — RAR)
  • RFC 9449 (Demonstrating Proof of Possession — DPoP)
  • OpenID Connect Core 1.0
  • OpenID Connect RP-Initiated Logout 1.0
Tags
author

Marc Alcaraz (ekameleon)

since
1.1.0

Table of Contents

Constants

ACR_VALUES  : string = 'acr_values'
ACTOR_TOKEN  : string = 'actor_token'
ACTOR_TOKEN_TYPE  : string = 'actor_token_type'
ASSERTION  : string = 'assertion'
AUDIENCE  : string = 'audience'
AUTHORIZATION_DETAILS  : string = 'authorization_details'
CLAIMS  : string = 'claims'
CLAIMS_LOCALES  : string = 'claims_locales'
CLIENT_ASSERTION  : string = 'client_assertion'
CLIENT_ASSERTION_TYPE  : string = 'client_assertion_type'
CLIENT_ID  : string = 'client_id'
CLIENT_SECRET  : string = 'client_secret'
CODE  : string = 'code'
CODE_CHALLENGE  : string = 'code_challenge'
CODE_CHALLENGE_METHOD  : string = 'code_challenge_method'
CODE_VERIFIER  : string = 'code_verifier'
DEVICE_CODE  : string = 'device_code'
DISPLAY  : string = 'display'
DPOP_JKT  : string = 'dpop_jkt'
GRANT_TYPE  : string = 'grant_type'
ID_TOKEN_HINT  : string = 'id_token_hint'
LOGIN_HINT  : string = 'login_hint'
LOGOUT_HINT  : string = 'logout_hint'
MAX_AGE  : string = 'max_age'
NONCE  : string = 'nonce'
PASSWORD  : string = 'password'
POST_LOGOUT_REDIRECT_URI  : string = 'post_logout_redirect_uri'
PROMPT  : string = 'prompt'
REDIRECT_URI  : string = 'redirect_uri'
REFRESH_TOKEN  : string = 'refresh_token'
REGISTRATION  : string = 'registration'
REQUEST  : string = 'request'
REQUEST_URI  : string = 'request_uri'
REQUESTED_TOKEN_TYPE  : string = 'requested_token_type'
RESOURCE  : string = 'resource'
RESPONSE_MODE  : string = 'response_mode'
RESPONSE_TYPE  : string = 'response_type'
SCOPE  : string = 'scope'
STATE  : string = 'state'
SUBJECT_TOKEN  : string = 'subject_token'
SUBJECT_TOKEN_TYPE  : string = 'subject_token_type'
TOKEN  : string = 'token'
TOKEN_TYPE_HINT  : string = 'token_type_hint'
UI_LOCALES  : string = 'ui_locales'
USER_CODE  : string = 'user_code'
USERNAME  : string = 'username'

Constants

ACTOR_TOKEN_TYPE

public string ACTOR_TOKEN_TYPE = 'actor_token_type'

AUTHORIZATION_DETAILS

public string AUTHORIZATION_DETAILS = 'authorization_details'

CLIENT_ASSERTION

public string CLIENT_ASSERTION = 'client_assertion'

CLIENT_ASSERTION_TYPE

public string CLIENT_ASSERTION_TYPE = 'client_assertion_type'

CODE_CHALLENGE_METHOD

public string CODE_CHALLENGE_METHOD = 'code_challenge_method'

POST_LOGOUT_REDIRECT_URI

public string POST_LOGOUT_REDIRECT_URI = 'post_logout_redirect_uri'

REQUESTED_TOKEN_TYPE

public string REQUESTED_TOKEN_TYPE = 'requested_token_type'

SUBJECT_TOKEN_TYPE

public string SUBJECT_TOKEN_TYPE = 'subject_token_type'
On this page

Search results