Rotate OAuth Client Secret

client.iam.oauthClients.rotateSecret(, , ?): OAuthClientRotateSecretResponse { client_secret }

POST/accounts/{account_id}/oauth_clients/{oauth_client_id}/rotate_secret

Creates a second client secret so you can update your client configuration before deleting the old one. The has_rotated_secret field on the client will be set to true.

Security

API Token

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example:Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

Example:X-Auth-Email: user@example.com

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

Example:X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194

Accepted Permissions (at least one required)

OAuth Client Write

ParametersExpand Collapse

oauthClientId: string

The unique identifier for an OAuth client.

params: OAuthClientRotateSecretParams { account_id }

account_id: string

Account identifier tag.

maxLength32

minLength32

ReturnsExpand Collapse

OAuthClientRotateSecretResponse { client_secret }

client_secret?: string

The new client secret.

Rotate OAuth Client Secret

import Cloudflare from 'cloudflare';

const client = new Cloudflare({
  apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted
});

const response = await client.iam.oauthClients.rotateSecret('a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4', {
  account_id: '023e105f4ecef8ad9ca31a8372d0c353',
});

console.log(response.client_secret);

{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "success": true,
  "result": {
    "client_secret": "cf-oauth-secret-new-example"
  }
}

Returns Examples

{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "success": true,
  "result": {
    "client_secret": "cf-oauth-secret-new-example"
  }
}