User Groups

Members

Members endpoint reference.

List

List all the members attached to a user group.

Param	Type	Required	Default	Description
`accountId`	`string`	Yes		Account identifier.
`userGroupId`	`string`	Yes		User Group identifier.
`params`	`array`	No	`[]`	Array containing the necessary params, e.g. fuzzyEmail.

php

$response = $client->iam()->userGroups()->members()->list('ACCOUNT_ID', 'USER_GROUP_ID', []);

View this operation on the Cloudflare API Reference

Create

Add members to a User Group.

Param	Type	Required	Default	Description
`accountId`	`string`	Yes		Account identifier.
`userGroupId`	`string`	Yes		User Group identifier.
`members`	`array`	Yes		Array of member identifiers to add, e.g. [['id' => 'member_id']].

php

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

View this operation on the Cloudflare API Reference

Update

Replace the set of members attached to a User Group.

Param	Type	Required	Default	Description
`accountId`	`string`	Yes		Account identifier.
`userGroupId`	`string`	Yes		User Group identifier.
`members`	`array`	Yes		Array of member identifiers, e.g. [['id' => 'member_id']].

php

$response = $client->iam()->userGroups()->members()->update('ACCOUNT_ID', 'USER_GROUP_ID', []);

View this operation on the Cloudflare API Reference

Delete

Remove a member from a User Group.

Param	Type	Required	Default	Description
`accountId`	`string`	Yes		Account identifier.
`userGroupId`	`string`	Yes		User Group identifier.
`memberId`	`string`	Yes		Member identifier.

php

$response = $client->iam()->userGroups()->members()->delete('ACCOUNT_ID', 'USER_GROUP_ID', 'MEMBER_ID');

View this operation on the Cloudflare API Reference

Get

Get information about a specific member of a User Group.

Param	Type	Required	Default	Description
`accountId`	`string`	Yes		Account identifier.
`userGroupId`	`string`	Yes		User Group identifier.
`memberId`	`string`	Yes		Member identifier.

php

$response = $client->iam()->userGroups()->members()->get('ACCOUNT_ID', 'USER_GROUP_ID', 'MEMBER_ID');

View this operation on the Cloudflare API Reference

Edit this pageorReport an issue

User Groups

User Groups endpoint reference.

User

User endpoint reference.