Reset a client secret

Resets the client secret for an API client. For example, you might reset the secret if you believe the secret has been exposed to unauthorized users or if a user who had access to the secret has left your organization. When calling this operation you need to include the hoursToLive member. When a secret is reset, the new secret takes effect immediately. However, you can allow the old secret to remain in effect for up to 168 hours. That means that, for the specified amount of time, both the old secret and the new secret can be used with the client. This time period is managed by hoursToLive, which can be set to any integer value between 0 and 168 hours, inclusive. Setting hoursToLive to 0 causes the old secret to expire as soon as the new secret takes effect.

Path Params
string
required

Unique identifier of the API client.

string
required

Application ID. You can find your application ID on the Console's Manage Application page.

Body Params

Resets an API client secret.

integer

Number of hours before the previous client secret expires. For example, if you set this value to 8 then, after you reset the client secret, you'll have an 8 hour timespan in which you can use either the old client secret or the new client secret. After 8 hours, the old secret expires and only the new secret works. This can be set to any integer value between 0 hours and 168 hours, inclusive. Setting hoursToLive to 0 causes the old secret to expire as soon as the new secret takes effect.

Responses

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json