Skip to main content

Class: AccountAccess

Represents an AccountAccess.

Properties​

customRoles​

customRoles: string[]

List of custom role IDs assigned to the user or service account. temporal:versioning:min_version=v0.13.0

role​

role: Role

The role on the account. temporal:versioning:min_version=v0.3.0 temporal:enums:replaces=role_deprecated

roleDeprecated​

roleDeprecated: string

The role on the account, should be one of [owner, admin, developer, financeadmin, read, metricsread] owner - gives full access to the account, including users, namespaces, and billing admin - gives full access the account, including users and namespaces developer - gives access to create namespaces on the account financeadmin - gives read only access and write access for billing read - gives read only access to the account metricsread - gives read only access to all namespace metrics Deprecated: Not supported after v0.3.0 api version. Use role instead. temporal:versioning:max_version=v0.3.0

Methods​

toJSON()​

toJSON(): object

Converts this AccountAccess to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): AccountAccess & $Properties

Creates a new AccountAccess instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

AccountAccess & $Properties

AccountAccess instance

Call Signature​

static create(properties?): AccountAccess

Creates a new AccountAccess instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

AccountAccess

AccountAccess instance

decode()​

static decode(reader, length?): AccountAccess & $Properties

Decodes an AccountAccess message from the specified reader or buffer.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

length?​

number

Message length if known beforehand

Returns​

AccountAccess & $Properties

AccountAccess

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): AccountAccess & $Properties

Decodes an AccountAccess message from the specified reader or buffer, length delimited.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

AccountAccess & $Properties

AccountAccess

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

encode()​

static encode(message, writer?): Writer

Encodes the specified AccountAccess message. Does not implicitly temporal.api.cloud.identity.v1.AccountAccess.verify|verify messages.

Parameters​

message​

$Properties

AccountAccess message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

Encodes the specified AccountAccess message, length delimited. Does not implicitly temporal.api.cloud.identity.v1.AccountAccess.verify|verify messages.

Parameters​

message​

$Properties

AccountAccess message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): AccountAccess

Creates an AccountAccess message from a plain object. Also converts values to their respective internal types.

Parameters​

object​

{[k: string]: any; }

Plain object

Returns​

AccountAccess

AccountAccess

toObject()​

static toObject(message, options?): object

Creates a plain object from an AccountAccess message. Also converts values to other types if specified.

Parameters​

message​

AccountAccess

AccountAccess

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object