/clients/delete

Deletes an API client. Only an owner client may call the /clients/delete endpoint. 

This endpoint accepts the following methods:

  • POST

POST

Authentication

This endpoint supports Basic authentication. 

How to Create an Authentication String

Base URL

The base URL for this endpoint is your Identity Cloud Capture domain; for example:

https://educationcenter.us-dev.janraincapture.com

Your Capture domains (also known as Registration domains) can be found in the Console on the Manage Application page:

Examples

Example

This command deletes the API client with the ID 67890fghij67890fghij.


curl -X POST \
  -H "Authorization: Basic c2dueXZ1czZwYzRqbTdraHIybmVxNWdzODlnYnIyZXE6d3Q0YzN1bjl3a2tjZnZ5a25xeDQ0eW5jNDc2YWZzNjg=" \
  --data-urlencode client_id_for_deletion=67890fghij67890fghij \
  https://my-app.janraincapture.com/clients/delete
  
      Running this command in Postman


Authorized Clients

  • owner

Security

  •  janrain-signed
  •  basic-auth

Query Parameters

Parameter Type Required Description
client_id_for_deletion string Yes The ID of the client to delete.
 

Responses

200 OK

Example Error Response


{
  "argument_name": "client_id_for_deletion",
  "request_id": "cepqfrsvtyqmyxf8",
  "code": 200,
  "error_description": "client_id_for_deletion was not valid for the
    following reason: client_id_for_deletion is not a valid id",
  "error": "invalid_argument",
  "stat": "error"
}
  

Response Example (application/json)


{
  "stat": "ok"
}