Skip to main content

Class: Access

identity.v1.Access

Represents an Access.

Properties​

accountAccess​

• Optional accountAccess: null | $Properties

The account access


customRolesDeprecated​

• customRolesDeprecated: string[]

List of custom role IDs assigned to the user or service account. Deprecated: Not supported after v0.12.0 api version. Use account_access.custom_roles instead. temporal:versioning:max_version=v0.12.0


namespaceAccesses​

• namespaceAccesses: Object

The map of namespace accesses The key is the namespace name and the value is the access to the namespace

Index signature​

▪ [k: string]: $Properties

Methods​

toJSON​

▸ toJSON(): Object

Converts this Access to JSON.

Returns​

Object

JSON object


create​

▸ create(properties?): Access & $Properties

Creates a new Access instance using the specified properties.

Parameters​

NameTypeDescription
properties?$PropertiesProperties to set

Returns​

Access & $Properties

Access instance

▸ create(properties?): Access

Parameters​

NameType
properties?$Properties

Returns​

Access


decode​

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

Decodes an Access message from the specified reader or buffer.

Parameters​

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from
length?numberMessage length if known beforehand

Returns​

Access & $Properties

Access

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited​

▸ decodeDelimited(reader): Access & $Properties

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

Parameters​

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns​

Access & $Properties

Access

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 Access message. Does not implicitly temporal.api.cloud.identity.v1.Access.verify|verify messages.

Parameters​

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

Returns​

Writer

Writer


encodeDelimited​

▸ encodeDelimited(message, writer?): Writer

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

Parameters​

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

Returns​

Writer

Writer


fromObject​

▸ fromObject(object): Access

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

Parameters​

NameTypeDescription
objectObjectPlain object

Returns​

Access

Access


toObject​

▸ toObject(message, options?): Object

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

Parameters​

NameTypeDescription
messageAccessAccess
options?IConversionOptionsConversion options

Returns​

Object

Plain object