--- title: List OAuth Clients --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api) [IAM](https://developers.cloudflare.com/api/resources/iam) [OAuth Clients](https://developers.cloudflare.com/api/resources/iam/subresources/oauth_clients) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # List OAuth Clients GET/accounts/{account\_id}/oauth\_clients List all OAuth clients for an account. ##### 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 Read` ##### P ath ParametersExpand Collapse account\_id: string Account identifier tag. maxLength32 minLength32 [Link to this property](<#(resource)%20iam.oauth_clients%20%3E%20(method)%20list%20%3E%20(params)%20default%20%3E%20(param)%20account_id%20%3E%20(schema)>) ##### ReturnsExpand Collapse

errors: array of object {code, message, documentation\_url, source }

code: number minimum1000 Link to this property message: string Link to this property documentation\_url: optional string Link to this property

source: optional object {pointer }

pointer: optional string Link to this property

Link to this property

[Link to this property](<#(resource)%20iam.oauth_clients%20%3E%20(method)%20list%20%3E%20(network%20schema)%20%3E%20(property)%20errors>)

messages: array of object {code, message, documentation\_url, source }

code: number minimum1000 Link to this property message: string Link to this property documentation\_url: optional string Link to this property

source: optional object {pointer }

pointer: optional string Link to this property

Link to this property

[Link to this property](<#(resource)%20iam.oauth_clients%20%3E%20(method)%20list%20%3E%20(network%20schema)%20%3E%20(property)%20messages>) success: true Whether the API call was successful. [Link to this property](<#(resource)%20iam.oauth_clients%20%3E%20(method)%20list%20%3E%20(network%20schema)%20%3E%20(property)%20success>)

result: optional array of object {client\_id, visibility, allowed\_cors\_origins, 17 more }

client\_id: string The unique identifier for an OAuth client. Link to this property

visibility: "public"or "private" Visibility of the OAuth client.

One of the following: "public" Link to this property "private" Link to this property

Link to this property allowed\_cors\_origins: optional array of string Array of allowed CORS origins. Link to this property client\_name: optional string Human-readable name of the OAuth client. Link to this property client\_uri: optional string URL of the home page of the client. Link to this property

client\_uri\_verification: optional object {status, text } Client URI domain control verification state.

status: optional "pending"or "in\_progress"or "verified"or "failed" Current verification status for the client URI host.

One of the following: "pending" Link to this property "in\_progress" Link to this property "verified" Link to this property "failed" Link to this property

Link to this property text: optional string Exact TXT record value that must be added to DNS to prove ownership of the client URI host. Link to this property

Link to this property created\_at: optional string Timestamp when the OAuth client was created. formatdate-time Link to this property

grant\_types: optional array of "authorization\_code"or "refresh\_token" Array of OAuth grant types the client is allowed to use. authorization_code is required; refresh_token may be included optionally.

One of the following: "authorization\_code" Link to this property "refresh\_token" Link to this property

Link to this property has\_rotated\_secret: optional boolean Indicates whether the client has a rotated secret that has not yet been deleted. Link to this property logo\_uri: optional string URL of the client’s logo. Link to this property optional\_scopes: optional array of string Scopes that the authorizing user may decline during consent. Each value must also appear in scopes. The scopes openid, offline, and offline_access cannot be optional. Link to this property policy\_uri: optional string URL that points to a privacy policy document. Link to this property post\_logout\_redirect\_uris: optional array of string Array of allowed post-logout redirect URIs. Link to this property promoted\_at: optional string Timestamp when the OAuth client was promoted to public visibility. formatdate-time Link to this property redirect\_uris: optional array of string Array of allowed redirect URIs for the client. Link to this property

response\_types: optional array of "token"or "id\_token"or "code" Array of OAuth response types the client is allowed to use.

One of the following: "token" Link to this property "id\_token" Link to this property "code" Link to this property

Link to this property scopes: optional array of string Array of OAuth scopes the client is allowed to request. Colon-delimited scopes are not accepted. Dot-delimited scopes are validated against available OAuth API scopes; simple identity scopes are allowed. Protocol scopes offline_access and openid are added or removed automatically based on grant_types and response_types. Link to this property

token\_endpoint\_auth\_method: optional "none"or "client\_secret\_basic"or "client\_secret\_post" The authentication method the client uses at the token endpoint.

One of the following: "none" Link to this property "client\_secret\_basic" Link to this property "client\_secret\_post" Link to this property

Link to this property tos\_uri: optional string URL that points to a terms of service document. Link to this property updated\_at: optional string Timestamp when the OAuth client was last updated. formatdate-time Link to this property

[Link to this property](<#(resource)%20iam.oauth_clients%20%3E%20(method)%20list%20%3E%20(network%20schema)%20%3E%20(property)%20result>)

result\_info: optional object {count, page, per\_page, total\_count }

count: optional number Total number of results for the requested service Link to this property page: optional number Current page within paginated list of results Link to this property per\_page: optional number Number of results per page of results Link to this property total\_count: optional number Total results available without any search parameters Link to this property

[Link to this property](<#(resource)%20iam.oauth_clients%20%3E%20(method)%20list%20%3E%20(network%20schema)%20%3E%20(property)%20result_info>) ### List OAuth Clients HTTP HTTPTypeScriptPythonGoTerraform ``` curl https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/oauth_clients \ -H "Authorization: Bearer $CLOUDFLARE_API_TOKEN" ``` 200 example ``` { "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_id": "a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4", "visibility": "private", "allowed_cors_origins": [ "https://example.com" ], "client_name": "My OAuth App", "client_uri": "https://example.com", "client_uri_verification": { "status": "in_progress", "text": "cloudflare_oauth_client_publisher=example" }, "created_at": "2025-01-01T00:00:00Z", "grant_types": [ "authorization_code", "refresh_token" ], "has_rotated_secret": false, "logo_uri": "https://example.com/logo.png", "optional_scopes": [ "account.write" ], "policy_uri": "https://example.com/privacy", "post_logout_redirect_uris": [ "https://example.com/logout" ], "promoted_at": "2026-05-13T12:00:00Z", "redirect_uris": [ "https://example.com/callback" ], "response_types": [ "code" ], "scopes": [ "account.read" ], "token_endpoint_auth_method": "client_secret_post", "tos_uri": "https://example.com/tos", "updated_at": "2025-01-01T00:00:00Z" } ], "result_info": { "count": 1, "page": 1, "per_page": 20, "total_count": 2000 } } ``` ##### Returns Examples 200 example ``` { "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_id": "a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4", "visibility": "private", "allowed_cors_origins": [ "https://example.com" ], "client_name": "My OAuth App", "client_uri": "https://example.com", "client_uri_verification": { "status": "in_progress", "text": "cloudflare_oauth_client_publisher=example" }, "created_at": "2025-01-01T00:00:00Z", "grant_types": [ "authorization_code", "refresh_token" ], "has_rotated_secret": false, "logo_uri": "https://example.com/logo.png", "optional_scopes": [ "account.write" ], "policy_uri": "https://example.com/privacy", "post_logout_redirect_uris": [ "https://example.com/logout" ], "promoted_at": "2026-05-13T12:00:00Z", "redirect_uris": [ "https://example.com/callback" ], "response_types": [ "code" ], "scopes": [ "account.read" ], "token_endpoint_auth_method": "client_secret_post", "tos_uri": "https://example.com/tos", "updated_at": "2025-01-01T00:00:00Z" } ], "result_info": { "count": 1, "page": 1, "per_page": 20, "total_count": 2000 } } ```