Iam

User Groups

User Groups endpoint reference.

List

List all the user groups for an account.

Param	Type	Required	Default	Description
`accountId`	`string`	Yes		Account identifier.
`params`	`array`	No	`[]`	Array containing the necessary params, e.g. id, name, fuzzyName.

php

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

View this operation on the Cloudflare API Reference

Create

Create a new user group under the specified account.

Param	Type	Required	Default	Description
`accountId`	`string`	Yes		Account identifier.
`values`	`array`	Yes		User Group values, requires name.

php

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

View this operation on the Cloudflare API Reference

Get

Get information about a specific user group in an account.

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

php

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

View this operation on the Cloudflare API Reference

Update

Modify an existing user group.

Param	Type	Required	Default	Description
`accountId`	`string`	Yes		Account identifier.
`userGroupId`	`string`	Yes		User Group identifier.
`values`	`array`	No	`[]`	User Group values, e.g. name, policies.

php

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

View this operation on the Cloudflare API Reference

Delete

Remove a user group from an account.

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

php

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

View this operation on the Cloudflare API Reference

Members

Edit this pageorReport an issue

Oauth Scopes

Oauth Scopes endpoint reference.

Members

Members endpoint reference.