Create OAuth Client

POST 
/oauth-clients

This creates an OAuth client.

Request

application/json

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

200

Request succeeded.

application/json

Schema

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.

Example (from schema)

{
  "id": "2c9180835d2e5168015d32f890ca1581",
  "secret": "5c32dd9b21adb51c77794d46e71de117a1d0ddb36a7ff941fa28014ab7de2cf3",
  "businessName": "Acme-Solar",
  "homepageUrl": "http://localhost:12345",
  "name": "Demo API Client",
  "description": "An API client used for the authorization_code, refresh_token, and client_credentials flows",
  "accessTokenValiditySeconds": 750,
  "refreshTokenValiditySeconds": 86400,
  "redirectUris": [
    "http://localhost:12345"
  ],
  "grantTypes": [
    "AUTHORIZATION_CODE",
    "CLIENT_CREDENTIALS",
    "REFRESH_TOKEN"
  ],
  "accessType": "OFFLINE",
  "type": "CONFIDENTIAL",
  "internal": false,
  "enabled": true,
  "strongAuthSupported": false,
  "claimsSupported": false,
  "created": "2017-07-11T18:45:37.098Z",
  "modified": "2018-06-25T20:22:28.104Z",
  "scope": [
    "demo:api-client-scope:first",
    "demo:api-client-scope:second"
  ]
}

400

Client Error - Returned if the request body is invalid.

application/json

Schema

Schema

detailCode string

Fine-grained error code providing more detail of the error.

trackingId string

Unique tracking id for the error.

messages

object[]

Generic localized reason for error

Array [

locale stringnullable

The locale for the message text, a BCP 47 language tag.

localeOrigin LocaleOrigin (string)nullable

Possible values: [DEFAULT, REQUEST, null]

An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.

text string

Actual text of the error message in the indicated locale.

]

causes

object[]

Plain-text descriptive reasons to provide additional detail to the text provided in the messages field

Array [

locale stringnullable

The locale for the message text, a BCP 47 language tag.

localeOrigin LocaleOrigin (string)nullable

Possible values: [DEFAULT, REQUEST, null]

An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.

text string

Actual text of the error message in the indicated locale.

]

Example (from schema)

{
  "detailCode": "400.1 Bad Request Content",
  "trackingId": "e7eab60924f64aa284175b9fa3309599",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ],
  "causes": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ]
}

401

Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.

application/json

Schema

Schema

error

A message describing the error

Example (from schema)

{
  "error": "JWT validation failed: JWT is expired"
}

403

Forbidden - Returned if the user you are running as, doesn't have access to this end-point.

application/json

Schema

Schema

detailCode string

Fine-grained error code providing more detail of the error.

trackingId string

Unique tracking id for the error.

messages

object[]

Generic localized reason for error

Array [

locale stringnullable

The locale for the message text, a BCP 47 language tag.

localeOrigin LocaleOrigin (string)nullable

Possible values: [DEFAULT, REQUEST, null]

An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.

text string

Actual text of the error message in the indicated locale.

]

causes

object[]

Plain-text descriptive reasons to provide additional detail to the text provided in the messages field

Array [

locale stringnullable

The locale for the message text, a BCP 47 language tag.

localeOrigin LocaleOrigin (string)nullable

Possible values: [DEFAULT, REQUEST, null]

An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.

text string

Actual text of the error message in the indicated locale.

]

Example (from schema)

{
  "detailCode": "400.1 Bad Request Content",
  "trackingId": "e7eab60924f64aa284175b9fa3309599",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ],
  "causes": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ]
}

403

An example of a 403 response object

{
  "detailCode": "403 Forbidden",
  "trackingId": "b21b1f7ce4da4d639f2c62a57171b427",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The server understood the request but refuses to authorize it."
    }
  ]
}

429

Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.

application/json

Schema

Schema

message

A message describing the error

Example (from schema)

{
  "message": " Rate Limit Exceeded "
}

500

Internal Server Error - Returned if there is an unexpected error.

application/json

Schema

Schema

detailCode string

Fine-grained error code providing more detail of the error.

trackingId string

Unique tracking id for the error.

messages

object[]

Generic localized reason for error

Array [

locale stringnullable

The locale for the message text, a BCP 47 language tag.

localeOrigin LocaleOrigin (string)nullable

Possible values: [DEFAULT, REQUEST, null]

An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.

text string

Actual text of the error message in the indicated locale.

]

causes

object[]

Plain-text descriptive reasons to provide additional detail to the text provided in the messages field

Array [

locale stringnullable

The locale for the message text, a BCP 47 language tag.

localeOrigin LocaleOrigin (string)nullable

Possible values: [DEFAULT, REQUEST, null]

An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.

text string

Actual text of the error message in the indicated locale.

]

Example (from schema)

{
  "detailCode": "400.1 Bad Request Content",
  "trackingId": "e7eab60924f64aa284175b9fa3309599",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ],
  "causes": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ]
}

500

An example of a 500 response object

{
  "detailCode": "500.0 Internal Fault",
  "trackingId": "b21b1f7ce4da4d639f2c62a57171b427",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "An internal fault occurred."
    }
  ]
}

Loading...