Iam

Oauth Clients

Oauth Clients endpoint reference.

List

List all the OAuth clients for an account.

Param	Type	Required	Default	Description
`accountId`	`string`	Yes		Account identifier.

php

$response = $client->iam()->oauthClients()->list('ACCOUNT_ID');

View this operation on the Cloudflare API Reference

Create

Create a new OAuth client.

Param	Type	Required	Default	Description
`accountId`	`string`	Yes		Account identifier.
`values`	`array`	Yes		OAuth Client values, requires client_name, grant_types, redirect_uris, response_types, scopes and token_endpoint_auth_method.

php

$response = $client->iam()->oauthClients()->create('ACCOUNT_ID', []);

View this operation on the Cloudflare API Reference

Get

Get details of a specific OAuth client.

Param	Type	Required	Default	Description
`accountId`	`string`	Yes		Account identifier.
`oauthClientId`	`string`	Yes		OAuth Client identifier.

php

$response = $client->iam()->oauthClients()->get('ACCOUNT_ID', 'OAUTH_CLIENT_ID');

View this operation on the Cloudflare API Reference

Update

Update an existing OAuth client.

Param	Type	Required	Default	Description
`accountId`	`string`	Yes		Account identifier.
`oauthClientId`	`string`	Yes		OAuth Client identifier.
`values`	`array`	No	`[]`	OAuth Client values, e.g. client_name, grant_types, redirect_uris.

php

$response = $client->iam()->oauthClients()->update('ACCOUNT_ID', 'OAUTH_CLIENT_ID', []);

View this operation on the Cloudflare API Reference

Delete

Delete an OAuth client.

Param	Type	Required	Default	Description
`accountId`	`string`	Yes		Account identifier.
`oauthClientId`	`string`	Yes		OAuth Client identifier.

php

$response = $client->iam()->oauthClients()->delete('ACCOUNT_ID', 'OAUTH_CLIENT_ID');

View this operation on the Cloudflare API Reference

Rotate Secret

Creates a second client secret so you can update your client configuration before deleting the old one.

Param	Type	Required	Default	Description
`accountId`	`string`	Yes		Account identifier.
`oauthClientId`	`string`	Yes		OAuth Client identifier.

php

$response = $client->iam()->oauthClients()->rotateSecret('ACCOUNT_ID', 'OAUTH_CLIENT_ID');

View this operation on the Cloudflare API Reference

Delete Rotated Secret

Removes the old client secret after a rotation, keeping only the new one.

Param	Type	Required	Default	Description
`accountId`	`string`	Yes		Account identifier.
`oauthClientId`	`string`	Yes		OAuth Client identifier.

php

$response = $client->iam()->oauthClients()->deleteRotatedSecret('ACCOUNT_ID', 'OAUTH_CLIENT_ID');

View this operation on the Cloudflare API Reference

Edit this pageorReport an issue

Sso

Sso endpoint reference.

Oauth Scopes

Oauth Scopes endpoint reference.