Skip to content
Start here

Permission Groups

List Account Permission Groups
client.iam.permissionGroups.list(PermissionGroupListParams { account_id, id, label, 3 more } params, RequestOptionsoptions?): V4PagePaginationArray<PermissionGroupListResponse { id, meta, name } >
GET/accounts/{account_id}/iam/permission_groups
Permission Group Details
client.iam.permissionGroups.get(stringpermissionGroupID, PermissionGroupGetParams { account_id } params, RequestOptionsoptions?): PermissionGroupGetResponse { id, meta, name }
GET/accounts/{account_id}/iam/permission_groups/{permission_group_id}
ModelsExpand Collapse
PermissionGroupListResponse { id, meta, name }

A named group of permissions that map to a group of operations against resources.

id: string

Identifier of the permission group.

meta?: Meta { category, deprecated, description, 5 more }

Attributes associated to the permission group.

category?: string

A category used to group permission groups.

deprecated?: string

Indicates whether the permission group is deprecated.

description?: string

Additional information about the permission group.

editable?: string

Indicates whether the permission group can be edited.

eol_at?: string

The planned end-of-life date and time, when provided.

formatdate-time
label?: string

A label identifying the permission group.

scopes?: string

The scope associated with the permission group.

visibility?: string

Indicates the permission group’s availability or visibility.

name?: string

Name of the permission group.

PermissionGroupGetResponse { id, meta, name }

A named group of permissions that map to a group of operations against resources.

id: string

Identifier of the permission group.

meta?: Meta { category, deprecated, description, 5 more }

Attributes associated to the permission group.

category?: string

A category used to group permission groups.

deprecated?: string

Indicates whether the permission group is deprecated.

description?: string

Additional information about the permission group.

editable?: string

Indicates whether the permission group can be edited.

eol_at?: string

The planned end-of-life date and time, when provided.

formatdate-time
label?: string

A label identifying the permission group.

scopes?: string

The scope associated with the permission group.

visibility?: string

Indicates the permission group’s availability or visibility.

name?: string

Name of the permission group.