[{"label":"Latest (v1.0)","version":"latest"}]
csp

Update Organization OAuth Application Secret By Orgnization ID And Application ID

Description

Regenerate Organization Managed OAuth App Secret An empty JSON body {} is required in order to invoke the API.
Important:
Changing the client secret via the client management APIs will reset existing secret rotation (meaning, the provided secret in the management APIs will be the only valid secret).

Access Policy

Role User Accounts Service Accounts (Client Credentials Applications)
Organization Owner ✔️ ✔️
Developer ✔️ ✔️

Request

Request

URL

URL


put
https://{api_host}/csp/gateway/am/api/orgs/{orgId}/oauth-apps/{oauthAppId}/secret
Copy

Path Parameters

Path Parameters

string
orgId Required

Unique identifier (GUID) of the organization.

Parameter Serialization Style: simple Explode:false

string
oauthAppId Required

The unique identifier of the OAuth Application (client).

Parameter Serialization Style: simple Explode:false

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK returns ClientIdAndSecretResponse of type application/json
{
	"clientId": "string",
	"clientSecret": "string"
}
string
clientId Optional

The unique identifier of the OAuth Application (client).


string
clientSecret Optional

The organization OAuth Application secret

Errors

Errors

401

The user is not authorized to use the API


403

The user is forbidden to use the API


404

The requested resource could not be found


409

The request could not be processed due to a conflict


429

The user has sent too many requests


500

An unexpected error has occurred while processing the request

Code Samples

Code Samples

cURL Command

curl -X PUT https://{api_host}/csp/gateway/am/api/orgs/{orgId}/oauth-apps/{oauthAppId}/secret
Vendor Extensions

Vendor Extensions

This operation contains the following vendor extensions defined in the spec:
x-required-roles: org_owner,developer
x-slo-tier: TIER2


Feedback

Was this page helpful?