/clients/set_description

Change the description of a client. This can also be thought of as the name of the client.

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

This endpoint includes 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 Janrain Capture domain; for example:

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

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

Examples

Example Request

Change the description of the client with the ID "67890fghij67890fghij" to "New client description".


curl -X POST \
    -H "Authorization: Basic aW1fYV...NfbXk="\
    --data-urlencode for_client_id=67890fghij67890fghij \
    --data-urlencode description='New client description'\
    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"
}