[{"label":"Latest (v1.0)","version":"latest"}]
csp
Update Organization OAuth Application Secret By Orgnization ID And Application ID
DescriptionRegenerate 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
URLURL
https://{api_host}/csp/gateway/am/api/orgs/{orgId}/oauth-apps/{oauthAppId}/secret
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
This operation uses the following authentication methods.
Response
Response
Response BodyResponse 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
Code Samples
Code Samples
PowerCLI Client SDK Example
Invoke-UpdateOrgOAuthAppSecretUsingPUT -OrgId "MyOrgId" -OauthAppId "MyOauthAppId"
cURL Command
curl -X PUT https://{api_host}/csp/gateway/am/api/orgs/{orgId}/oauth-apps/{oauthAppId}/secret
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-required-roles: org_owner,developer
x-slo-tier: TIER2
[{"label":"Latest (v1.0)","version":"latest"}]
csp
