Class: UserGroupSpec
Represents a UserGroupSpec.
Properties
access
• Optional access: null | $Properties
The access assigned to the group.
cloudGroup
• Optional cloudGroup: null | $Properties
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: null | $Properties
The specification of the google group that this group is associated with.
groupType
• Optional groupType: "googleGroup" | "scimGroup" | "cloudGroup"
UserGroupSpec groupType.
scimGroup
• Optional scimGroup: null | $Properties
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
▸ create(properties?): UserGroupSpec & $Shape
Creates a new UserGroupSpec instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Shape | Properties to set |
Returns
UserGroupSpec instance
▸ create(properties?): UserGroupSpec
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
decode
▸ decode(reader, length?): UserGroupSpec & $Shape
Decodes a UserGroupSpec message from the specified reader or buffer.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
length? | number | Message length if known beforehand |
Returns
UserGroupSpec
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): UserGroupSpec & $Shape
Decodes a UserGroupSpec message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
UserGroupSpec
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 UserGroupSpec message. Does not implicitly temporal.api.cloud.identity.v1.UserGroupSpec.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | UserGroupSpec message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified UserGroupSpec message, length delimited. Does not implicitly temporal.api.cloud.identity.v1.UserGroupSpec.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | UserGroupSpec message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): UserGroupSpec
Creates a UserGroupSpec message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
UserGroupSpec
toObject
▸ toObject(message, options?): Object
Creates a plain object from a UserGroupSpec message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | UserGroupSpec | UserGroupSpec |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object