API Reference

IAM

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

User Groups

List User Groups

client.iam.userGroups.list(UserGroupListParams { account_id, id, direction, 4 more } params, RequestOptionsoptions?): V4PagePaginationArray<UserGroupListResponse { id, created_on, modified_on, 2 more } >

GET/accounts/{account_id}/iam/user_groups

User Group Details

client.iam.userGroups.get(stringuserGroupId, UserGroupGetParams { account_id } params, RequestOptionsoptions?): UserGroupGetResponse { id, created_on, modified_on, 2 more }

GET/accounts/{account_id}/iam/user_groups/{user_group_id}

Create User Group

client.iam.userGroups.create(UserGroupCreateParams { account_id, name, policies } params, RequestOptionsoptions?): UserGroupCreateResponse { id, created_on, modified_on, 2 more }

POST/accounts/{account_id}/iam/user_groups

Update User Group

client.iam.userGroups.update(stringuserGroupId, UserGroupUpdateParams { account_id, name, policies } params, RequestOptionsoptions?): UserGroupUpdateResponse { id, created_on, modified_on, 2 more }

PUT/accounts/{account_id}/iam/user_groups/{user_group_id}

Remove User Group

client.iam.userGroups.delete(stringuserGroupId, UserGroupDeleteParams { account_id } params, RequestOptionsoptions?): UserGroupDeleteResponse { id } | null

DELETE/accounts/{account_id}/iam/user_groups/{user_group_id}

ModelsExpand Collapse

UserGroupListResponse { id, created_on, modified_on, 2 more }

A group of policies resources.

id: string

User Group identifier tag.

maxLength32

minLength32

created_on: string

Timestamp for the creation of the user group

formatdate-time

modified_on: string

Last time the user group was modified.

formatdate-time

name: string

Name of the user group.

policies?: Array<Policy>

Policies attached to the User group

id?: string

Policy identifier.

access?: "allow" | "deny"

Allow or deny operations against the resources.

One of the following:

"allow"

"deny"

permission_groups?: Array<PermissionGroup>

A set of permission groups that are specified to the policy.

id: string

Identifier of the permission group.

meta?: Meta { key, value }

Attributes associated to the permission group.

key?: string

value?: string

name?: string

Name of the permission group.

resource_groups?: Array<ResourceGroup>

A list of resource groups that the policy applies to.

id: string

Identifier of the resource group.

scope: Array<Scope>

The scope associated to the resource group

key: string

This is a combination of pre-defined resource name and identifier (like Account ID etc.)

objects: Array<Object>

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.)

meta?: Meta { key, value }

Attributes associated to the resource group.

key?: string

value?: string

name?: string

Name of the resource group.

UserGroupGetResponse { id, created_on, modified_on, 2 more }

A group of policies resources.

id: string

User Group identifier tag.

maxLength32

minLength32

created_on: string

Timestamp for the creation of the user group

formatdate-time

modified_on: string

Last time the user group was modified.

formatdate-time

name: string

Name of the user group.

policies?: Array<Policy>

Policies attached to the User group

id?: string

Policy identifier.

access?: "allow" | "deny"

Allow or deny operations against the resources.

One of the following:

"allow"

"deny"

permission_groups?: Array<PermissionGroup>

A set of permission groups that are specified to the policy.

id: string

Identifier of the permission group.

meta?: Meta { key, value }

Attributes associated to the permission group.

key?: string

value?: string

name?: string

Name of the permission group.

resource_groups?: Array<ResourceGroup>

A list of resource groups that the policy applies to.

id: string

Identifier of the resource group.

scope: Array<Scope>

The scope associated to the resource group

key: string

This is a combination of pre-defined resource name and identifier (like Account ID etc.)

objects: Array<Object>

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.)

meta?: Meta { key, value }

Attributes associated to the resource group.

key?: string

value?: string

name?: string

Name of the resource group.

UserGroupCreateResponse { id, created_on, modified_on, 2 more }

A group of policies resources.

id: string

User Group identifier tag.

maxLength32

minLength32

created_on: string

Timestamp for the creation of the user group

formatdate-time

modified_on: string

Last time the user group was modified.

formatdate-time

name: string

Name of the user group.

policies?: Array<Policy>

Policies attached to the User group

id?: string

Policy identifier.

access?: "allow" | "deny"

Allow or deny operations against the resources.

One of the following:

"allow"

"deny"

permission_groups?: Array<PermissionGroup>

A set of permission groups that are specified to the policy.

id: string

Identifier of the permission group.

meta?: Meta { key, value }

Attributes associated to the permission group.

key?: string

value?: string

name?: string

Name of the permission group.

resource_groups?: Array<ResourceGroup>

A list of resource groups that the policy applies to.

id: string

Identifier of the resource group.

scope: Array<Scope>

The scope associated to the resource group

key: string

This is a combination of pre-defined resource name and identifier (like Account ID etc.)

objects: Array<Object>

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.)

meta?: Meta { key, value }

Attributes associated to the resource group.

key?: string

value?: string

name?: string

Name of the resource group.

UserGroupUpdateResponse { id, created_on, modified_on, 2 more }

A group of policies resources.

id: string

User Group identifier tag.

maxLength32

minLength32

created_on: string

Timestamp for the creation of the user group

formatdate-time

modified_on: string

Last time the user group was modified.

formatdate-time

name: string

Name of the user group.

policies?: Array<Policy>

Policies attached to the User group

id?: string

Policy identifier.

access?: "allow" | "deny"

Allow or deny operations against the resources.

One of the following:

"allow"

"deny"

permission_groups?: Array<PermissionGroup>

A set of permission groups that are specified to the policy.

id: string

Identifier of the permission group.

meta?: Meta { key, value }

Attributes associated to the permission group.

key?: string

value?: string

name?: string

Name of the permission group.

resource_groups?: Array<ResourceGroup>

A list of resource groups that the policy applies to.

id: string

Identifier of the resource group.

scope: Array<Scope>

The scope associated to the resource group

key: string

This is a combination of pre-defined resource name and identifier (like Account ID etc.)

objects: Array<Object>

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.)

meta?: Meta { key, value }

Attributes associated to the resource group.

key?: string

value?: string

name?: string

Name of the resource group.

UserGroupDeleteResponse { id }

id: string

Identifier

maxLength32

minLength32

User GroupsMembers

List User Group Members

client.iam.userGroups.members.list(stringuserGroupId, MemberListParams { account_id, page, per_page } params, RequestOptionsoptions?): V4PagePaginationArray<MemberListResponse { id, email, status } >

GET/accounts/{account_id}/iam/user_groups/{user_group_id}/members

Add User Group Members

client.iam.userGroups.members.create(stringuserGroupId, MemberCreateParams { account_id, body } params, RequestOptionsoptions?): MemberCreateResponse { id, email, status }

POST/accounts/{account_id}/iam/user_groups/{user_group_id}/members

Update User Group Members

client.iam.userGroups.members.update(stringuserGroupId, MemberUpdateParams { account_id, body } params, RequestOptionsoptions?): SinglePage<MemberUpdateResponse { id, email, status } >

PUT/accounts/{account_id}/iam/user_groups/{user_group_id}/members

Remove User Group Member

client.iam.userGroups.members.delete(stringuserGroupId, stringmemberId, MemberDeleteParams { account_id } params, RequestOptionsoptions?): MemberDeleteResponse { id, email, status }

DELETE/accounts/{account_id}/iam/user_groups/{user_group_id}/members/{member_id}

ModelsExpand Collapse

MemberListResponse { id, email, status }

Member attached to a User Group.

id: string

Account member identifier.

email?: string

The contact email address of the user.

maxLength90

status?: "accepted" | "pending"

The member’s status in the account.

One of the following:

"accepted"

"pending"

MemberCreateResponse { id, email, status }

Member attached to a User Group.

id: string

Account member identifier.

email?: string

The contact email address of the user.

maxLength90

status?: "accepted" | "pending"

The member’s status in the account.

One of the following:

"accepted"

"pending"

MemberUpdateResponse { id, email, status }

Member attached to a User Group.

id: string

Account member identifier.

email?: string

The contact email address of the user.

maxLength90

status?: "accepted" | "pending"

The member’s status in the account.

One of the following:

"accepted"

"pending"

MemberDeleteResponse { id, email, status }

Member attached to a User Group.

id: string

Account member identifier.

email?: string

The contact email address of the user.

maxLength90

status?: "accepted" | "pending"

The member’s status in the account.

One of the following:

"accepted"

"pending"