Skip to main content

Get OAuth Client

This gets details of an OAuth client.

Path Parameters
  • id string required

    The OAuth client id

    Example: ef38f94347e94562b5bb8424a56397d8
Responses

Request succeeded.


Schema
  • id string

    ID of the OAuth client

  • businessName string

    The name of the business the API Client should belong to

  • homepageUrl string

    The homepage URL associated with the owner of the API Client

  • name string

    A human-readable name for the API Client

  • description string

    A description of the API Client

  • accessTokenValiditySeconds int32

    The number of seconds an access token generated for this API Client is valid for

  • refreshTokenValiditySeconds int32

    The number of seconds a refresh token generated for this API Client is valid for

  • redirectUris string[]

    A list of the approved redirect URIs used with the authorization_code flow

  • grantTypes string[]

    Possible values: [CLIENT_CREDENTIALS, AUTHORIZATION_CODE, REFRESH_TOKEN]

    A list of OAuth 2.0 grant types this API Client can be used with

  • accessType string

    Possible values: [ONLINE, OFFLINE]

    The access type (online or offline) of this API Client

  • type string

    Possible values: [CONFIDENTIAL, PUBLIC]

    The type of the API Client (public or confidential)

  • internal boolean

    An indicator of whether the API Client can be used for requests internal to IDN

  • enabled boolean

    An indicator of whether the API Client is enabled for use

  • strongAuthSupported boolean

    An indicator of whether the API Client supports strong authentication

  • claimsSupported boolean

    An indicator of whether the API Client supports the serialization of SAML claims when used with the authorization_code flow

  • created date-time

    The date and time, down to the millisecond, when the API Client was created

  • modified date-time

    The date and time, down to the millisecond, when the API Client was last updated

  • lastUsed date-time

    The date and time, down to the millisecond, when this API Client was last used to generate an access token. This timestamp does not get updated on every API Client usage, but only once a day. This property can be useful for identifying which API Clients are no longer actively used and can be removed.

  • scope string[]

    Scopes of the API Client.

Loading...