Skip to main content

Create OAuth Client

POST 

/oauth-clients

This creates an OAuth client.

Request

Body

required

    businessName stringnullable

    The name of the business the API Client should belong to

    homepageUrl stringnullable

    The homepage URL associated with the owner of the API Client

    name stringnullablerequired

    A human-readable name for the API Client

    description stringnullablerequired

    A description of the API Client

    accessTokenValiditySeconds int32required

    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[]nullable

    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 GrantType (string)[]nullablerequired

    Possible values: [CLIENT_CREDENTIALS, AUTHORIZATION_CODE, REFRESH_TOKEN]

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

    accessType AccessType (string)required

    Possible values: [ONLINE, OFFLINE]

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

    type ClientType (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 booleanrequired

    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[]nullable

    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 stringrequired

    ID of the OAuth client

    secret stringrequired

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

    businessName stringrequired

    The name of the business the API Client should belong to

    homepageUrl stringrequired

    The homepage URL associated with the owner of the API Client

    name stringrequired

    A human-readable name for the API Client

    description stringrequired

    A description of the API Client

    accessTokenValiditySeconds int32required

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

    refreshTokenValiditySeconds int32required

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

    redirectUris string[]required

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

    grantTypes GrantType (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 AccessType (string)required

    Possible values: [ONLINE, OFFLINE]

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

    type ClientType (string)required

    Possible values: [CONFIDENTIAL, PUBLIC]

    The type of the API Client (public or confidential)

    internal booleanrequired

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

    enabled booleanrequired

    An indicator of whether the API Client is enabled for use

    strongAuthSupported booleanrequired

    An indicator of whether the API Client supports strong authentication

    claimsSupported booleanrequired

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

    created date-timerequired

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

    modified date-timerequired

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

    scope string[]nullablerequired

    Scopes of the API Client.

Loading...