Skip to main content

Class: UserGroupSpec

Represents a UserGroupSpec.

Properties​

access?​

optional access?: $Properties | null

The access assigned to the group.

cloudGroup?​

optional cloudGroup?: $Properties | null

The specification for a Cloud group. Cloud groups can manage members using the add and remove member APIs.

displayName​

displayName: string

The display name of the group.

googleGroup?​

optional googleGroup?: $Properties | null

The specification of the google group that this group is associated with.

groupType?​

optional groupType?: "googleGroup" | "scimGroup" | "cloudGroup"

UserGroupSpec groupType.

scimGroup?​

optional scimGroup?: $Properties | null

The specification of the SCIM group that this group is associated with. SCIM groups cannot be created or deleted directly, but their access can be managed.

Methods​

toJSON()​

toJSON(): object

Converts this UserGroupSpec to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): UserGroupSpec & $Shape

Creates a new UserGroupSpec instance using the specified properties.

Parameters​
properties?​

$Shape

Properties to set

Returns​

UserGroupSpec & $Shape

UserGroupSpec instance

Call Signature​

static create(properties?): UserGroupSpec

Creates a new UserGroupSpec instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

UserGroupSpec

UserGroupSpec instance

decode()​

static decode(reader, length?): UserGroupSpec & $Shape

Decodes a UserGroupSpec 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​

UserGroupSpec & $Shape

UserGroupSpec

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): UserGroupSpec & $Shape

Decodes a UserGroupSpec message from the specified reader or buffer, length delimited.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

UserGroupSpec & $Shape

UserGroupSpec

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

Parameters​

message​

$Properties

UserGroupSpec message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

UserGroupSpec message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): UserGroupSpec

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

Parameters​

object​

{[k: string]: any; }

Plain object

Returns​

UserGroupSpec

UserGroupSpec

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

UserGroupSpec

UserGroupSpec

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object