Create an identity provider

How to create an identity provider via API

To create a new identity provider, send a POST request to the /api/identity_providers endpoint, passing the resource arguments in the request body.

Request

POST https://provisioning.commercelayer.io/api/identity_providers

Arguments

Body Parameter	Type	Required
type	string	Required
attributes.name	string	Required
attributes.client_id	string	Required
attributes.client_secret	string	Required
attributes.issuer	string	Required
attributes.domains	string	Required
attributes.token_url	string	Required
attributes.authorize_url	string	Required
attributes.jwks_url	string	Required
attributes.organization	string	Optional
attributes.reference	string	Optional
attributes.reference_origin	string	Optional
attributes.metadata	object	Optional
attributes._disable	boolean	Optional
attributes._enable	boolean	Optional

Example

Request

The following request creates a new identity provider:

curl -g -X POST \
  'https://provisioning.commercelayer.io/api/identity_providers' \
  -H 'Accept: application/vnd.api+json' \
  -H 'Authorization: Bearer {{your_access_token}}' \
  -H 'Content-Type: application/vnd.api+json' \
  -d '{
  "data": {
    "type": "identity_providers",
    "attributes": {
      "name": "Org auth0",
      "client_id": "a6CDk5v1ZV99GrtOcfYVEZRnDDt",
      "client_secret": "s6CD55v1ZV99ArtOcfYVEZRnDDf",
      "issuer": "https://dev.auth987.com/",
      "domains": "dev.auth987.com,stg.auth987.com",
      "token_url": "https://dev.auth987.com/oauth/token",
      "authorize_url": "https://dev.auth987.com/authorize",
      "jwks_url": "https://dev.auth987.com/.well-known/jwks.json"
    }
  }
}'

Response

On success, the API responds with a 201 Created status code, returning the created resource object:

{
  "data": {
    "id": "xYZkjABcde",
    "type": "identity_providers",
    "links": {
      "self": "https://provisioning.commercelayer.io/api/identity_providers/xYZkjABcde"
    },
    "attributes": {
      "name": "Org auth0",
      "client_id": "a6CDk5v1ZV99GrtOcfYVEZRnDDt",
      "client_secret": "s6CD55v1ZV99ArtOcfYVEZRnDDf",
      "issuer": "https://dev.auth987.com/",
      "status": "pending",
      "domains": "dev.auth987.com,stg.auth987.com",
      "token_url": "https://dev.auth987.com/oauth/token",
      "authorize_url": "https://dev.auth987.com/authorize",
      "jwks_url": "https://dev.auth987.com/.well-known/jwks.json",
      "txt_record": "cl-verification=a6CDk5v",
      "organization": "org_76gsfs5gd",
      "created_at": "2018-01-01T12:00:00.000Z",
      "updated_at": "2018-01-01T12:00:00.000Z",
      "reference": "ANY-EXTERNAL-REFEFERNCE",
      "reference_origin": "ANY-EXTERNAL-REFEFERNCE-ORIGIN",
      "metadata": {
        "foo": "bar"
      },
      "disabled_at": "2018-01-01T12:00:00.000Z"
    },
    "relationships": {
      "user": {
        "links": {
          "self": "https://provisioning.commercelayer.io/api/identity_providers/xYZkjABcde/relationships/user",
          "related": "https://provisioning.commercelayer.io/api/identity_providers/xYZkjABcde/user"
        }
      }
    }
  }
}