Rename an API Client

Endpoint URL: {registrationDomain} /clients/set_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.

This endpoint includes the following methods:

POST

POST

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

Authorized Clients

owner

Security

janrain-signed
basic-auth

Query Parameters

Parameter	Type	Required	Description
for_client_id	string		Client ID for the client whose description is being changed. If this parameter is not present, the description of the owner client is changed.
description	string	Yes	New 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"
}

How to Create an Authentication String

To create an authentication string, combine your API client ID, a colon (:), and your client secret into a single value. For example, if your client ID is abcdefg and your client secret is hijklmnop, that value would look like this:

abcdefg:hijklmnop

Next, take the string and base64 encode it. For example, on a Mac, you can base encode the string using this command:

echo -n "abcdefg:hijklmnop" | base64

If you’re running Microsoft Windows, you can encode the string by using a Windows PowerShell command similar to this:

[Convert]::ToBase64String([System.Text.Encoding]::UTF8.GetBytes("abcdefg:hijklmn"))

The resulting value (e.g., YWJjZGVmZzpoaWprbG1ub3A=) should be used in your authentication header.

If you are making API calls using Postman, select Basic Auth as your identification type, then use the client ID as the username and the client secret as the password.

Before you actually try your authentication string, make sure that your API client has the all the permissions (for example, the right to read user profile information) needed to complete the API call.

Endpoint URL: {registrationDomain} /clients/set_description

POST

Running this Command in Postman

How to Create an Authentication String

Rate this Article