Skip to main content

profile

Creates, updates, deletes, gets or lists a profile resource.

Overview

Nameprofile
TypeResource
Idcloudflare.iam.profile

Fields

The following fields are returned by SELECT queries:

The request has succeeded.

NameDatatypeDescription
business_namestring
business_addressstring
business_emailstring
business_phonestring
external_metadatastring

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
listselectaccount_idRetrieves the profile information for a specific Cloudflare account, including organization details, settings, and metadata. This endpoint is commonly used to verify account access and retrieve account-level configuration.
accounts_modify_account_profilereplaceaccount_id, business_name, business_email, business_phone, business_address, external_metadataUpdates the profile information for a Cloudflare account. Allows modification of account-level settings and organizational details. Requires Account Settings Write permission.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
account_idstringThe Cloudflare account ID.

SELECT examples

Retrieves the profile information for a specific Cloudflare account, including organization details, settings, and metadata. This endpoint is commonly used to verify account access and retrieve account-level configuration.

SELECT
business_name,
business_address,
business_email,
business_phone,
external_metadata
FROM cloudflare.iam.profile
WHERE account_id = '{{ account_id }}' -- required
;

REPLACE examples

Updates the profile information for a Cloudflare account. Allows modification of account-level settings and organizational details. Requires Account Settings Write permission.

REPLACE cloudflare.iam.profile
SET
business_address = '{{ business_address }}',
business_email = '{{ business_email }}',
business_name = '{{ business_name }}',
business_phone = '{{ business_phone }}',
external_metadata = '{{ external_metadata }}'
WHERE
account_id = '{{ account_id }}' --required
AND business_name = '{{ business_name }}' --required
AND business_email = '{{ business_email }}' --required
AND business_phone = '{{ business_phone }}' --required
AND business_address = '{{ business_address }}' --required
AND external_metadata = '{{ external_metadata }}' --required;