Delete an OpenID Connect Client

Endpoint URL: {identityDomain}/{customerId}config/clients/{oidcClientId}


Description

Deletes the specified OpenID Connect (OIDC) client. 

Deleting an OIDC client only deletes the client itself and the associated application (API) client. The associated login policy and token policy are not affected when a client is deleted.


Authentication

This endpoint requires token-based authentication. To obtain an access token, you must use a configuration client (using the client ID as the username and the client secret as the password) to access the /{customerId}/login/token endpoint. The access token returned from the token endpoint is then used in the Authorization header of your API call. For example, if you get back the access token Ki712dpGq5GPQcsxMHY6ShHY7wU_iTs0o9dPx4TEzf5yLIvddjnDVBJxjPDucf5YVB then your Authorization header would look like this when using Curl:

-H 'Authorization: Bearer Ki712dpGq5GPQcsxMHY6ShHY7wU_iTs0o9dPx4TEzf5yLIvddjnDVBJxjPDucf5YVB'

In Postman, set the Authorization Type to Bearer and use the access token as the value of the Token field.


Path Parameters

The path parameters that must be included in the request are listed in the following table:

NameTypeRequiredDescription

{customerId}

string

Yes

Unique identifier of the customer associated with the OIDC client.

{oidcClientId}

string

Yes

Unique identifier of the OIDC client being deleted.


Sample Request (Curl)

The following command deletes the OIDC client with the client ID 6be73a3a-5bf0-4190-a0de-698aa409ff28:

curl -X DELETE \
  https://v1.api.us.janrain.com/01000000-0000-3000-9000-000000000000/config/clients/6be73a3a-5bf0-4190-a0de-698aa409ff28 \
  -H 'Authorization: Bearer Ki712dpGq5GPQcsxMHY6ShHY7wU_iTs0o9dPx4TEzf5yLIvddjnDVBJxjPDucf5YVB'


Responses

204 No Content

If your call to this endpoint succeeds, you will not get back a response value. Instead, you will simply get back the HTTP response code 204 No Content.


Response Codes

The following table includes information about some of the response codes that you might encounter when calling this endpoint.

Response CodeDescription

401

Authentication required or Invalid credentials. You either did not specify an authentication method for the call (this endpoint requires token-based authentication) or the token was rejected. In the latter case, this could be because the token is not valid or because the token has expired.

403

Forbidden. You do not have permission to access the requested resource.

404

Customer client not found. Either you specified an invalid client (use the /{customerId}/config/clients endpoint to retrieve a list of valid client IDs) or the OIDC client has been deleted.