Skip to main content

Class: AccountAccess

identity.v1.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​

▸ create(properties?): AccountAccess & $Properties

Creates a new AccountAccess instance using the specified properties.

Parameters​

NameTypeDescription
properties?$PropertiesProperties to set

Returns​

AccountAccess & $Properties

AccountAccess instance

▸ create(properties?): AccountAccess

Parameters​

NameType
properties?$Properties

Returns​

AccountAccess


decode​

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

Decodes an AccountAccess message from the specified reader or buffer.

Parameters​

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from
length?numberMessage 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​

▸ decodeDelimited(reader): AccountAccess & $Properties

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

Parameters​

NameTypeDescription
readerUint8Array | ReaderReader 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​

▸ encode(message, writer?): Writer

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

Parameters​

NameTypeDescription
message$PropertiesAccountAccess message or plain object to encode
writer?WriterWriter to encode to

Returns​

Writer

Writer


encodeDelimited​

▸ encodeDelimited(message, writer?): Writer

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

Parameters​

NameTypeDescription
message$PropertiesAccountAccess message or plain object to encode
writer?WriterWriter to encode to

Returns​

Writer

Writer


fromObject​

▸ fromObject(object): AccountAccess

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

Parameters​

NameTypeDescription
objectObjectPlain object

Returns​

AccountAccess

AccountAccess


toObject​

▸ toObject(message, options?): Object

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

Parameters​

NameTypeDescription
messageAccountAccessAccountAccess
options?IConversionOptionsConversion options

Returns​

Object

Plain object