Class: AuthorizationRequestClass

name: AuthorizationRequestClass
description: 'An [Authorization Request compliant with OAuth 2.0 section 4.1.1](https://www.rfc-editor.org/rfc/rfc6749.html#section-4.1.1).


  JSON schema: [AuthorizationRequest.json](../json-schemas/AuthorizationRequest.json)

  '
from_schema: https://vocab.account.gov.uk/linkml/credentials-schema
see_also:
- ../json-schemas/AuthorizationRequest.json
is_a: JWTClass
slots:
- response_type
- scope
- client_id
- state
- redirect_uri
- nonce

name: AuthorizationRequestClass
description: 'An [Authorization Request compliant with OAuth 2.0 section 4.1.1](https://www.rfc-editor.org/rfc/rfc6749.html#section-4.1.1).


  JSON schema: [AuthorizationRequest.json](../json-schemas/AuthorizationRequest.json)

  '
from_schema: https://vocab.account.gov.uk/linkml/credentials-schema
see_also:
- ../json-schemas/AuthorizationRequest.json
is_a: JWTClass
attributes:
  response_type:
    name: response_type
    description: The response type.  This value currently needs to be set to the value
      `code`.
    from_schema: https://vocab.account.gov.uk/linkml/credentials-schema
    rank: 1000
    alias: response_type
    owner: AuthorizationRequestClass
    domain_of:
    - AuthorizationRequestClass
    range: string
    required: true
  scope:
    name: scope
    description: The scope.  A space-separated list of scopes which must include the
      `openid` value. Other options are `email`, `phone` and `offline_access` (returns
      a refresh token).  Other custom scopes are available for internal requests.
    from_schema: https://vocab.account.gov.uk/linkml/credentials-schema
    rank: 1000
    alias: scope
    owner: AuthorizationRequestClass
    domain_of:
    - AuthorizationRequestClass
    - OpenIDConnectAuthenticationRequestClass
    range: string
    required: true
  client_id:
    name: client_id
    description: The client id.  This value is the client id the Relying Party service
      was provided with for identification upon registration.  Internal system requests
      will use an internal client id.
    from_schema: https://vocab.account.gov.uk/linkml/credentials-schema
    rank: 1000
    alias: client_id
    owner: AuthorizationRequestClass
    domain_of:
    - AuthorizationRequestClass
    range: StringOrURI
    required: true
  state:
    name: state
    description: The state.  This value is used to validate the response sent to the
      redirect URI.  This value will be returned to the client in the authentication
      response.
    from_schema: https://vocab.account.gov.uk/linkml/credentials-schema
    rank: 1000
    alias: state
    owner: AuthorizationRequestClass
    domain_of:
    - AuthorizationRequestClass
    range: string
    required: true
  redirect_uri:
    name: redirect_uri
    description: The redirect uri.  This value must exactly match one of the redirect
      uris registered by the Relying Party service and must be URL-encoded.
    from_schema: https://vocab.account.gov.uk/linkml/credentials-schema
    rank: 1000
    alias: redirect_uri
    owner: AuthorizationRequestClass
    domain_of:
    - AuthorizationRequestClass
    range: uri
    required: true
  nonce:
    name: nonce
    description: The nonce.  A random value provided from the ID token to verify the
      integrity of the ID token.
    from_schema: https://vocab.account.gov.uk/linkml/credentials-schema
    rank: 1000
    alias: nonce
    owner: AuthorizationRequestClass
    domain_of:
    - AuthorizationRequestClass
    range: string
    required: true
  iss:
    name: iss
    description: The `iss` (issuer) claim identifies the principal that issued the
      JWT.
    from_schema: https://vocab.account.gov.uk/linkml/credentials-schema
    rank: 1000
    alias: iss
    owner: AuthorizationRequestClass
    domain_of:
    - JWTClass
    range: uri
  sub:
    name: sub
    description: The `sub` (subject) claim identifies the principal that is the subject
      of the JWT.
    from_schema: https://vocab.account.gov.uk/linkml/credentials-schema
    rank: 1000
    alias: sub
    owner: AuthorizationRequestClass
    domain_of:
    - JWTClass
    range: uri
  nbf:
    name: nbf
    description: The `nbf` (not before) claim identifies the time the JWT is valid
      from.
    from_schema: https://vocab.account.gov.uk/linkml/credentials-schema
    rank: 1000
    alias: nbf
    owner: AuthorizationRequestClass
    domain_of:
    - JWTClass
    range: integer
  exp:
    name: exp
    description: The `exp` (expiration time) claim identifies the time the JWT expires.
    from_schema: https://vocab.account.gov.uk/linkml/credentials-schema
    rank: 1000
    alias: exp
    owner: AuthorizationRequestClass
    domain_of:
    - JWTClass
    range: integer
  aud:
    name: aud
    description: The `aud` (audience) claim identifies the recipients that the JWT
      is intended for.
    from_schema: https://vocab.account.gov.uk/linkml/credentials-schema
    rank: 1000
    alias: aud
    owner: AuthorizationRequestClass
    domain_of:
    - JWTClass
    range: uri
  iat:
    name: iat
    description: The `iat` (issued at) claim identifies the time at which the JWT
      was issued.
    from_schema: https://vocab.account.gov.uk/linkml/credentials-schema
    rank: 1000
    alias: iat
    owner: AuthorizationRequestClass
    domain_of:
    - JWTClass
    range: integer
  jti:
    name: jti
    description: The `jti` (JWT ID) claim identifies the unique identifier of the
      JWT.
    from_schema: https://vocab.account.gov.uk/linkml/credentials-schema
    rank: 1000
    alias: jti
    owner: AuthorizationRequestClass
    domain_of:
    - JWTClass
    range: uri