Create secret for client application

Overview

Use this API to create secret for client application.

Permissions

The logged-in user must be a global user and one of the below is required:

  • User must have 'edit' action on the 'integration' resource.
  • User must have 'Manage partition resources' privilege.
Request
path Parameters
id
required
integer

id of object

Example: 1001
header Parameters
Accept-Language
required
string
Default: en-US

Language locale accepted by client (used for locale specific fields in resource representation and in error responses).

Enum: "en-US" "es-ES" "fr-FR" "it-IT" "de-DE" "nl-NL" "pt-BR" "pt-PT" "da-DK" "ru-RU" "fr-CA" "zh-CN" "ja-JP" "ko-KR" "sv-SE"
X-egain-session
required
string

Session ID obtained from Login API response header.

Request Body schema: application/json
name
required
string (name) [ 1 .. 255 ] characters

Friendly name for the password.

endDateTime
required
string <date-time> (endDateTime)
  • The future date and time at which the password expires represented using ISO 8601 format and is always in UTC times.
  • Must be less than 2 years.
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal server error

post/clientapplication/{id}/secret
Request samples
application/json
  • Create secret for a client application
  • POST /ws/v20/administration/integration/clientapplication/1001/secret
{
  • "name": "Access Key SPA",
  • "endDateTime": "2022-12-31T12:00:00"
}
Response samples
application/json

Created secret details of a client application

{
  • "name": "Access Key SPA",
  • "endDateTime": "2022-12-31T12:00:00",
  • "keyId": "452ee110-3440-4fed-b8cb-f30b54534259",
  • "hint": "AbX",
  • "secretText": "AbXyG~rNvARIxHa4j-A~QZcq58dyGN.3-Iu3ccix"
}