Skip to main content

Create OAuth Client

This creates an OAuth client.

Request Body required
  • 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 required

    A human-readable name for the API Client

  • description string required

    A description of the API Client

  • accessTokenValiditySeconds int32 required

    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. Provide one or more URIs when assigning the AUTHORIZATION_CODE grant type to a new OAuth Client.

  • grantTypes string[] required

    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 required

    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 within the product.

  • enabled boolean required

    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

  • scope string[]

    Scopes of the API Client. If no scope is specified, the client will be created with the default scope "sp:scopes:all". This means the API Client will have all the rights of the owner who created it.

Responses

Request succeeded.


Schema
  • id string

    ID of the OAuth client

  • secret string

    Secret of the OAuth client (This field is only returned on the intial create call.)

  • 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

  • scope string[]

    Scopes of the API Client.

Loading...