Skip to main content
Docs

The Backend OAuthApplication object

The Backend OAuthApplication object holds information about an OAuth application.

Properties

  • Name
    authorizeUrl
    Type
    string
    Description

    The URL used to authorize the user and obtain an authorization code.

  • Name
    clientId
    Type
    string
    Description

    The ID of the client associated with the OAuth application.

  • Name
    clientImageUrl
    Type
    null | string
    Description

    The URL of the image or logo representing the OAuth application.

  • Name
    clientSecret?
    Type
    string
    Description

    The client secret associated with the OAuth application. Empty if public client.

  • Name
    clientUri
    Type
    null | string
    Description

    The public-facing URL of the OAuth application, often shown on consent screens.

  • Name
    consentScreenEnabled
    Type
    boolean
    Description

    Specifies whether the consent screen should be displayed in the authentication flow. Cannot be disabled for dynamically registered OAuth applications.

  • Name
    createdAt
    Type
    number
    Description

    The date when the OAuth application was first created.

  • Name
    discoveryUrl
    Type
    string
    Description

    The OpenID Connect discovery endpoint URL for this OAuth application.

  • Name
    dynamicallyRegistered
    Type
    boolean
    Description

    Specifies whether the OAuth application is dynamically registered.

  • Name
    id
    Type
    string
    Description

    The unique identifier for the OAuth application.

  • Name
    instanceId
    Type
    string
    Description

    The ID of the instance that this OAuth application belongs to.

  • Name
    isPublic
    Type
    boolean
    Description

    Indicates whether the client is public. If true, the Proof Key of Code Exchange (PKCE) flow can be used.

  • Name
    name
    Type
    string
    Description

    The name of the new OAuth application.

  • Name
    pkceRequired
    Type
    boolean
    Description

    Specifies whether the Proof Key of Code Exchange (PKCE) flow should be required in the authentication flow.

  • Name
    redirectUris
    Type
    string[]
    Description

    An array of redirect URIs of the new OAuth application.

  • Name
    scopes
    Type
    string
    Description

    Scopes for the new OAuth application.

  • Name
    tokenFetchUrl
    Type
    string
    Description

    The URL used by the client to exchange an authorization code for an access token.

  • Name
    tokenIntrospectionUrl
    Type
    string
    Description

    The URL used to introspect and validate issued access tokens.

  • Name
    updatedAt
    Type
    number
    Description

    The date when the OAuth application was last updated.

  • Name
    userInfoUrl
    Type
    string
    Description

    The URL where the client can retrieve user information using an access token.

Feedback

What did you think of this content?

Last updated on