[{"label":"Latest (1.0)","version":"latest"}]
cloud-partner-navigator

Update Client Secret

Description

Rotates an OAuth App client’s secret. This operation does not work if during the app creation ownerOnlySecretRotation is set to true.

Request

Request

URL

URL


post
https://{api_host}/v2/clients/{clientId}/secret
Copy

Path Parameters

Path Parameters

string
clientId Required

The unique identifier of the client.


Header Parameters

Header Parameters

string
authorization Required

Basic auth with client credentials [Basic Base64_Encode(client_id:client_secret)]


Request Body

Request Body

OrgOauthAppNewSecretRequest of mimetype application/json Optional
{
	"newClientSecret": "string",
	"secretExpirationTimeInSeconds": 1
}
string
newClientSecret Required

The new client secret.


integer
secretExpirationTimeInSeconds Required

How much time the previous client secret will last after newClientSecret is set (both will work in that time period, and only the new one after that).

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

200 OK

OK

Errors

Errors

400

Bad Request - The request is either incomplete or incorrect


401

Unauthorized - The user is not authorized to use the API


403

Forbidden - User does not have permission for this operation


500

Internal Server Error - An unexpected error has occurred while processing the request

Code Samples

Code Samples

cURL Command

curl -X POST -H "authorization: string" -H "Content-Type: application/json" -d '{"newClientSecret":"string","secretExpirationTimeInSeconds":1}' https://{api_host}/v2/clients/{clientId}/secret


Feedback

Was this page helpful?