--- title: Add Member --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api) [Accounts](https://developers.cloudflare.com/api/resources/accounts) [Members](https://developers.cloudflare.com/api/resources/accounts/subresources/members) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Add Member POST/accounts/{account\_id}/members Add a user to the list of members for this account. ##### Security 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) `SCIM Provisioning``Account Settings Write` ##### P ath ParametersExpand Collapse account\_id: string Account identifier tag. maxLength32 minLength32 [Link to this property](<#(resource)%20accounts.members%20%3E%20(method)%20create%20%3E%20(params)%200%20%3E%20(param)%20account_id%20%3E%20(schema)>) ##### Body ParametersJSONExpand Collapse

body: object {email, roles, status } or object {email, policies, status }

One of the following:

IAMCreateMemberWithRoles object {email, roles, status }

email: string The contact email address of the user. maxLength90 Link to this property roles: array of string Array of roles associated with this member. Link to this property

status: optional "accepted"or "pending" Status of the member invitation. If not provided during creation, defaults to ‘pending’. Changing from ‘accepted’ back to ‘pending’ will trigger a replacement of the member resource in Terraform.

One of the following: "accepted" Link to this property "pending" Link to this property

Link to this property

IAMCreateMemberWithPolicies object {email, policies, status }

email: string The contact email address of the user. maxLength90 Link to this property

policies: array of object {id, access, permission\_groups, resource\_groups } Array of policies associated with this member.

id: string Policy identifier. Link to this property

access: "allow"or "deny" Allow or deny operations against the resources.

One of the following: "allow" Link to this property "deny" Link to this property

Link to this property

permission\_groups: array of object {id } A set of permission groups that are specified to the policy.

id: string Identifier of the group. Link to this property

Link to this property

resource\_groups: array of object {id } A list of resource groups that the policy applies to.

id: string Identifier of the group. Link to this property

Link to this property

One of the following: "accepted" Link to this property "pending" Link to this property

Link to this property

[Link to this property](<#(resource)%20accounts.members%20%3E%20(method)%20create%20%3E%20(params)%200%20%3E%20(param)%20body%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)%20accounts.members%20%3E%20(method)%20create%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)%20accounts.members%20%3E%20(method)%20create%20%3E%20(network%20schema)%20%3E%20(property)%20messages>) success: true Whether the API call was successful. [Link to this property](<#(resource)%20accounts.members%20%3E%20(method)%20create%20%3E%20(network%20schema)%20%3E%20(property)%20success>)

result: optional Member { id, email, policies, 3 more }

id: optional string Membership identifier tag. maxLength32 Link to this property email: optional string The contact email address of the user. maxLength90 Link to this property

policies: optional array of object {id, access, permission\_groups, resource\_groups } Access policy for the membership

id: optional string Policy identifier. Link to this property

access: optional "allow"or "deny" Allow or deny operations against the resources.

One of the following: "allow" Link to this property "deny" Link to this property

Link to this property

permission\_groups: optional array of object {id, meta, name } A set of permission groups that are specified to the policy.

id: string Identifier of the permission group. Link to this property

meta: optional object {category, deprecated, description, 5 more } Attributes associated to the permission group.

category: optional string A category used to group permission groups. Link to this property deprecated: optional string Indicates whether the permission group is deprecated. Link to this property description: optional string Additional information about the permission group. Link to this property editable: optional string Indicates whether the permission group can be edited. Link to this property eol\_at: optional string The planned end-of-life date and time, when provided. formatdate-time Link to this property label: optional string A label identifying the permission group. Link to this property scopes: optional string The scope associated with the permission group. Link to this property visibility: optional string Indicates the permission group’s availability or visibility. Link to this property

Link to this property name: optional string Name of the permission group. Link to this property

Link to this property

resource\_groups: optional array of object {id, scope, meta, name } A list of resource groups that the policy applies to.

id: string Identifier of the resource group. Link to this property

scope: object {key, objects } A scope is a combination of scope objects which provides additional context.

key: string This is a combination of pre-defined resource name and identifier (like Account ID etc.) Link to this property

objects: array of object {key } A list of scope objects for additional context.

key: string This is a combination of pre-defined resource name and identifier (like Zone ID etc.) Link to this property

Link to this property

meta: optional object {key, value } Attributes associated to the resource group.

key: optional string Link to this property value: optional string Link to this property

Link to this property name: optional string Name of the resource group. Link to this property

Link to this property

roles: optional array of Role { id, description, name, permissions } Roles assigned to this Member.

id: string Role identifier tag. maxLength32 Link to this property description: string Description of role’s permissions. Link to this property name: string Role name. maxLength120 Link to this property

permissions: object {analytics, billing, cache\_purge, 9 more }

analytics: optional PermissionGrant { read, write }

read: optional boolean Link to this property write: optional boolean Link to this property

Link to this property

billing: optional PermissionGrant { read, write }

read: optional boolean Link to this property write: optional boolean Link to this property

Link to this property

cache\_purge: optional PermissionGrant { read, write }

read: optional boolean Link to this property write: optional boolean Link to this property

Link to this property

dns: optional PermissionGrant { read, write }

read: optional boolean Link to this property write: optional boolean Link to this property

Link to this property

dns\_records: optional PermissionGrant { read, write }

read: optional boolean Link to this property write: optional boolean Link to this property

Link to this property

lb: optional PermissionGrant { read, write }

read: optional boolean Link to this property write: optional boolean Link to this property

Link to this property

logs: optional PermissionGrant { read, write }

read: optional boolean Link to this property write: optional boolean Link to this property

Link to this property

organization: optional PermissionGrant { read, write }

read: optional boolean Link to this property write: optional boolean Link to this property

Link to this property

ssl: optional PermissionGrant { read, write }

read: optional boolean Link to this property write: optional boolean Link to this property

Link to this property

waf: optional PermissionGrant { read, write }

read: optional boolean Link to this property write: optional boolean Link to this property

Link to this property

zone\_settings: optional PermissionGrant { read, write }

read: optional boolean Link to this property write: optional boolean Link to this property

Link to this property

zones: optional PermissionGrant { read, write }

read: optional boolean Link to this property write: optional boolean Link to this property

Link to this property

status: optional "accepted"or "pending" A member’s status in the account.

One of the following: "accepted" Link to this property "pending" Link to this property

Link to this property

user: optional object {email, id, first\_name, 2 more } Details of the user associated to the membership.

email: string The contact email address of the user. maxLength90 Link to this property id: optional string Identifier maxLength32 minLength32 Link to this property first\_name: optional string User’s first name maxLength60 Link to this property last\_name: optional string User’s last name maxLength60 Link to this property two\_factor\_authentication\_enabled: optional boolean Indicates whether two-factor authentication is enabled for the user account. Does not apply to API authentication. Link to this property

Link to this property

[Link to this property](<#(resource)%20accounts.members%20%3E%20(method)%20create%20%3E%20(network%20schema)%20%3E%20(property)%20result>) ### Add Member HTTP HTTPTypeScriptPythonGoTerraform ``` curl https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/members \ -H 'Content-Type: application/json' \ -H "X-Auth-Email: $CLOUDFLARE_EMAIL" \ -H "X-Auth-Key: $CLOUDFLARE_API_KEY" \ -d '{ "email": "user@example.com", "roles": [ "3536bcfad5faccb999b47003c79917fb" ] }' ``` 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": { "id": "4536bcfad5faccb111b47003c79917fa", "email": "user@example.com", "policies": [ { "id": "f267e341f3dd4697bd3b9f71dd96247f", "access": "allow", "permission_groups": [ { "id": "c8fed203ed3043cba015a93ad1616f1f", "meta": { "category": "category", "deprecated": "deprecated", "description": "description", "editable": "editable", "eol_at": "2019-12-27T18:11:19.117Z", "label": "load_balancer_admin", "scopes": "com.cloudflare.api.account", "visibility": "visibility" }, "name": "Zone Read" }, { "id": "82e64a83756745bbbb1c9c2701bf816b", "meta": { "category": "category", "deprecated": "deprecated", "description": "description", "editable": "editable", "eol_at": "2019-12-27T18:11:19.117Z", "label": "fbm_user", "scopes": "com.cloudflare.api.account", "visibility": "visibility" }, "name": "Magic Network Monitoring" } ], "resource_groups": [ { "id": "6d7f2f5f5b1d4a0e9081fdc98d432fd1", "scope": { "key": "com.cloudflare.api.account.eb78d65290b24279ba6f44721b3ea3c4", "objects": [ { "key": "com.cloudflare.api.account.zone.23f8d65290b24279ba6f44721b3eaad5" } ] }, "meta": { "key": "key", "value": "value" }, "name": "com.cloudflare.api.account.eb78d65290b24279ba6f44721b3ea3c4" } ] } ], "roles": [ { "id": "3536bcfad5faccb999b47003c79917fb", "description": "Administrative access to the entire Account", "name": "Account Administrator", "permissions": { "analytics": { "read": true, "write": false }, "billing": { "read": true, "write": false }, "cache_purge": { "read": true, "write": false }, "dns": { "read": true, "write": false }, "dns_records": { "read": true, "write": false }, "lb": { "read": true, "write": false }, "logs": { "read": true, "write": false }, "organization": { "read": true, "write": false }, "ssl": { "read": true, "write": false }, "waf": { "read": true, "write": false }, "zone_settings": { "read": true, "write": false }, "zones": { "read": true, "write": true } } } ], "status": "accepted", "user": { "email": "user@example.com", "id": "023e105f4ecef8ad9ca31a8372d0c353", "first_name": "John", "last_name": "Appleseed", "two_factor_authentication_enabled": true } } } ``` ##### 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": { "id": "4536bcfad5faccb111b47003c79917fa", "email": "user@example.com", "policies": [ { "id": "f267e341f3dd4697bd3b9f71dd96247f", "access": "allow", "permission_groups": [ { "id": "c8fed203ed3043cba015a93ad1616f1f", "meta": { "category": "category", "deprecated": "deprecated", "description": "description", "editable": "editable", "eol_at": "2019-12-27T18:11:19.117Z", "label": "load_balancer_admin", "scopes": "com.cloudflare.api.account", "visibility": "visibility" }, "name": "Zone Read" }, { "id": "82e64a83756745bbbb1c9c2701bf816b", "meta": { "category": "category", "deprecated": "deprecated", "description": "description", "editable": "editable", "eol_at": "2019-12-27T18:11:19.117Z", "label": "fbm_user", "scopes": "com.cloudflare.api.account", "visibility": "visibility" }, "name": "Magic Network Monitoring" } ], "resource_groups": [ { "id": "6d7f2f5f5b1d4a0e9081fdc98d432fd1", "scope": { "key": "com.cloudflare.api.account.eb78d65290b24279ba6f44721b3ea3c4", "objects": [ { "key": "com.cloudflare.api.account.zone.23f8d65290b24279ba6f44721b3eaad5" } ] }, "meta": { "key": "key", "value": "value" }, "name": "com.cloudflare.api.account.eb78d65290b24279ba6f44721b3ea3c4" } ] } ], "roles": [ { "id": "3536bcfad5faccb999b47003c79917fb", "description": "Administrative access to the entire Account", "name": "Account Administrator", "permissions": { "analytics": { "read": true, "write": false }, "billing": { "read": true, "write": false }, "cache_purge": { "read": true, "write": false }, "dns": { "read": true, "write": false }, "dns_records": { "read": true, "write": false }, "lb": { "read": true, "write": false }, "logs": { "read": true, "write": false }, "organization": { "read": true, "write": false }, "ssl": { "read": true, "write": false }, "waf": { "read": true, "write": false }, "zone_settings": { "read": true, "write": false }, "zones": { "read": true, "write": true } } } ], "status": "accepted", "user": { "email": "user@example.com", "id": "023e105f4ecef8ad9ca31a8372d0c353", "first_name": "John", "last_name": "Appleseed", "two_factor_authentication_enabled": true } } } ```