API Reference

IAM

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Resource Groups

List Resource Groups

client.iam.resourceGroups.list(ResourceGroupListParams { account_id, id, name } params, RequestOptionsoptions?): SinglePage<ResourceGroupListResponse { id, scope, meta, name } >

GET/accounts/{account_id}/iam/resource_groups

Resource Group Details

client.iam.resourceGroups.get(stringresourceGroupId, ResourceGroupGetParams { account_id } params, RequestOptionsoptions?): ResourceGroupGetResponse { id, scope, meta, name }

GET/accounts/{account_id}/iam/resource_groups/{resource_group_id}

Create Resource Group

client.iam.resourceGroups.create(ResourceGroupCreateParams { account_id, name, scope } params, RequestOptionsoptions?): ResourceGroupCreateResponse { id, scope, meta, name }

POST/accounts/{account_id}/iam/resource_groups

Update Resource Group

client.iam.resourceGroups.update(stringresourceGroupId, ResourceGroupUpdateParams { account_id, name, scope } params, RequestOptionsoptions?): ResourceGroupUpdateResponse { id, scope, meta, name }

PUT/accounts/{account_id}/iam/resource_groups/{resource_group_id}

Remove Resource Group

client.iam.resourceGroups.delete(stringresourceGroupId, ResourceGroupDeleteParams { account_id } params, RequestOptionsoptions?): ResourceGroupDeleteResponse { id } | null

DELETE/accounts/{account_id}/iam/resource_groups/{resource_group_id}

ModelsExpand Collapse

ResourceGroupListResponse { id, scope, meta, name }

A group of scoped resources.

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.

ResourceGroupGetResponse { id, scope, meta, name }

A group of scoped resources.

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.

ResourceGroupCreateResponse { id, scope, meta, name }

A group of scoped resources.

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.

ResourceGroupUpdateResponse { id, scope, meta, name }

A group of scoped resources.

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.

ResourceGroupDeleteResponse { id }

id: string

Identifier

maxLength32

minLength32