Rename an API Client

Endpoint URL: {registrationDomain} /clients/set_description



Description

Changes the description of an API client. This is effectively the same thing as changing the name of the client.

This API call may only be made by the owner client.

Respects the API Client Allow List: Yes


API Client Permissions

The following table indicates the API clients that can (and the API clients that can't) be used to call this endpoint:

owner
access_issuer
direct_access
direct_read_access
login_client
Yes
No
No
No
No


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 Request

This command changes the description of the API client with the ID 67890fghij67890fghij to Documentation Team Client.


curl -X POST \
  -H "Authorization: Basic c2dueXZ1czZwYzRqbTdraHIybmVxNWdzODlnYnIyZXE6d3Q0YzN1bjl3a2tjZnZ5a25xeDQ0eW5jNDc2YWZzNjg="\
  --data-urlencode for_client_id=67890fghij67890fghij \
  --data-urlencode description='Documentation Team Client'\
  https://my-app.janraincapture.com/clients/set_description
  

      Running this command in Postman


Query Parameters

ParameterTypeRequiredDescription
for_client_idstring
Client ID for the client whose description is being changed. If this parameter is not present, the description of the owner client is changed.
 
descriptionstringYesNew description for the client.
 


Responses

200 OK

Example Error Response


{
  "argument_name": "for_client_id",
  "request_id": "73et727cxds4vwtx",
  "code": 200,
  "error_description": "for_client_id was not valid for the following
    reason: for_client_id isnot avalid id",
  "error": "invalid_argument",
  "stat": "error"
}
  

Response Example (application/json)


{
  "stat": "ok"
}