Skip to main content

Create OAuth Client

POST 

https://sailpoint.api.identitynow.com/beta/oauth-clients

This creates an OAuth client.

Request

Bodyrequired

    businessNamestringnullable

    The name of the business the API Client should belong to

    Example: Acme-Solar
    homepageUrlstringnullable

    The homepage URL associated with the owner of the API Client

    Example: http://localhost:12345
    namestringnullablerequired

    A human-readable name for the API Client

    Example: Demo API Client
    descriptionstringnullablerequired

    A description of the API Client

    Example: An API client used for the authorization_code, refresh_token, and client_credentials flows
    accessTokenValiditySecondsint32required

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

    Example: 750
    refreshTokenValiditySecondsint32

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

    Example: 86400
    redirectUrisstring[]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.

    Example: ["http://localhost:12345","http://localhost:67890"]
    grantTypesstring[]nullablerequired

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

    Possible values: [CLIENT_CREDENTIALS, AUTHORIZATION_CODE, REFRESH_TOKEN]

    Example: ["AUTHORIZATION_CODE","CLIENT_CREDENTIALS","REFRESH_TOKEN"]
    accessTypestringrequired

    Access type of API Client indicating online or offline use

    Possible values: [ONLINE, OFFLINE]

    Example: OFFLINE
    typestring

    Type of an API Client indicating public or confidentials use

    Possible values: [CONFIDENTIAL, PUBLIC]

    Example: CONFIDENTIAL
    internalboolean

    An indicator of whether the API Client can be used for requests internal within the product.

    Example: false
    enabledbooleanrequired

    An indicator of whether the API Client is enabled for use

    Example: true
    strongAuthSupportedboolean

    An indicator of whether the API Client supports strong authentication

    Example: false
    claimsSupportedboolean

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

    Example: false
    scopestring[]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.

    Example: ["demo:api-client-scope:first","demo:api-client-scope:second"]

Responses

Request succeeded.

Schema
    idstringrequired

    ID of the OAuth client

    Example: 2c9180835d2e5168015d32f890ca1581
    secretstringrequired

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

    Example: 5c32dd9b21adb51c77794d46e71de117a1d0ddb36a7ff941fa28014ab7de2cf3
    businessNamestringrequired

    The name of the business the API Client should belong to

    Example: Acme-Solar
    homepageUrlstringrequired

    The homepage URL associated with the owner of the API Client

    Example: http://localhost:12345
    namestringrequired

    A human-readable name for the API Client

    Example: Demo API Client
    descriptionstringrequired

    A description of the API Client

    Example: An API client used for the authorization_code, refresh_token, and client_credentials flows
    accessTokenValiditySecondsint32required

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

    Example: 750
    refreshTokenValiditySecondsint32required

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

    Example: 86400
    redirectUrisstring[]required

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

    Example: ["http://localhost:12345"]
    grantTypesstring[]required

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

    Possible values: [CLIENT_CREDENTIALS, AUTHORIZATION_CODE, REFRESH_TOKEN]

    Example: ["AUTHORIZATION_CODE","CLIENT_CREDENTIALS","REFRESH_TOKEN"]
    accessTypestringrequired

    Access type of API Client indicating online or offline use

    Possible values: [ONLINE, OFFLINE]

    Example: OFFLINE
    typestringrequired

    Type of an API Client indicating public or confidentials use

    Possible values: [CONFIDENTIAL, PUBLIC]

    Example: CONFIDENTIAL
    internalbooleanrequired

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

    Example: false
    enabledbooleanrequired

    An indicator of whether the API Client is enabled for use

    Example: true
    strongAuthSupportedbooleanrequired

    An indicator of whether the API Client supports strong authentication

    Example: false
    claimsSupportedbooleanrequired

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

    Example: false
    createddate-timerequired

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

    Example: 2017-07-11T18:45:37.098Z
    modifieddate-timerequired

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

    Example: 2018-06-25T20:22:28.104Z
    scopestring[]nullablerequired

    Scopes of the API Client.

    Example: ["demo:api-client-scope:first","demo:api-client-scope:second"]

Authorization: oauth2

type: Personal Access Token
scopes: sp:oauth-client:manage

Request Collapse all
Base URL
https://sailpoint.api.identitynow.com/beta
Auth
Body required
{
  "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",
    "http://localhost:67890"
  ],
  "grantTypes": [
    "AUTHORIZATION_CODE",
    "CLIENT_CREDENTIALS",
    "REFRESH_TOKEN"
  ],
  "accessType": "OFFLINE",
  "type": "CONFIDENTIAL",
  "internal": false,
  "enabled": true,
  "strongAuthSupported": false,
  "claimsSupported": false,
  "scope": [
    "demo:api-client-scope:first",
    "demo:api-client-scope:second"
  ]
}
ResponseClear

Click the Send API Request button above and see the response here!