Update an identity provider

How to update an existing identity provider via API

To update an existing identity provider, send a PATCH request to the /api/identity_providers/:id endpoint, where id is the ID of the resource that you want to update.

Here below the list of all the possible arguments that you can pass with the request body.

Request

PATCH https://provisioning.commercelayer.io/api/identity_providers/:id

Arguments

Body Parameter	Type	Required
type	string	Required
id	string	Required
attributes.name	string	Optional
attributes.client_id	string	Optional
attributes.client_secret	string	Optional
attributes.issuer	string	Optional
attributes.domains	string	Optional
attributes.token_url	string	Optional
attributes.authorize_url	string	Optional
attributes.jwks_url	string	Optional
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 updates the identity provider identified by the ID "xYZkjABcde":

curl -g -X PATCH \
  'https://provisioning.commercelayer.io/api/identity_providers/xYZkjABcde' \
  -H 'Accept: application/vnd.api+json' \
  -H 'Authorization: Bearer {{your_access_token}}' \
  -H 'Content-Type: application/vnd.api+json' \
  -d '{
  "data": {
    "type": "identity_providers",
    "id": "xYZkjABcde",
    "attributes": {
      "reference": "ANY-EXTERNAL-REFEFERNCE"
    }
  }
}'

Response

On success, the API responds with a 200 OK status code, returning the updated 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"
        }
      }
    }
  }
}