GoogleWorkspaceGroupTemplate

See Template Schema Validation to learn how to validate templates automatically in your IDE.

Description

A base model class that provides additional helper methods and configurations for other models used in IAMbic.

Properties

expires_at: The date and time the resource will be/was set to deleted.
- Any of
  - string
  - string (date-time)
  - string (date)
Examples:
```
in 3 days
...
```
```
'2023-09-01'
```
```
'2023-08-31T12:00:00'
```
deleted (boolean): Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is ran. Default: false.
expires_at_default: A value that is set by IAMbic at run time and should not be set by the user.
- Any of
  - string
  - string (date-time)
  - string (date)
Examples:
```
in 3 days
...
```
```
'2023-09-01'
```
```
'2023-08-31T12:00:00'
```
template_type (string): Default: "NOQ::GoogleWorkspace::Group".
template_schema_url (string): Default: "https://docs.iambic.org/reference/schemas/google_workspace_group_template".
owner (string): Owner of the group.
notes (string)
iambic_managed: Controls the directionality of Iambic changes. Default: "undefined".
- All of
  - : Refer to #/definitions/IambicManaged.
properties: Refer to #/definitions/GroupProperties.

Definitions

IambicManaged: An enumeration. Must be one of: ["undefined", "read_and_write", "import_only", "enforced", "disabled"].

GroupMemberRole: An enumeration. Must be one of: ["OWNER", "MANAGER", "MEMBER"].

GroupMemberType: An enumeration. Must be one of: ["USER", "GROUP", "EXTERNAL", "CUSTOMER"].

GroupMemberStatus: An enumeration. Must be one of: ["ACTIVE", "INACTIVE", "PENDING", "UNDEFINED", "SUSPENDED"].

GroupMemberSubscription: An enumeration. Must be one of: ["EACH_EMAIL", "DIGEST", "ABRIDGED", "NO_EMAIL"].

GroupMember (object): A base model class that provides additional helper methods and configurations for other models used in IAMbic.
- expires_at: The date and time the resource will be/was set to deleted.
  - Any of
    - string
    - string (date-time)
    - string (date)
  Examples:
```
in 3 days
...
```
```
'2023-09-01'
```
```
'2023-08-31T12:00:00'
```
- deleted (boolean): Denotes whether the resource has been removed from AWS.Upon being set to true, the resource will be deleted the next time iambic is ran. Default: false.
- expires_at_default: A value that is set by IAMbic at run time and should not be set by the user.
  - Any of
    - string
    - string (date-time)
    - string (date)
  Examples:
```
in 3 days
...
```
```
'2023-09-01'
```
```
'2023-08-31T12:00:00'
```
- email (string): Email address. However, when the type is CUSTOMER, it represents all users in a domain.
- customer_id (string): When the type is CUSTOMER, it represents customer id of a domain.
- expand (boolean): Expand the group into the members of the group. This is useful for nested groups. Default: false.
- role: Default: "MEMBER".
  - All of
    - : Refer to #/definitions/GroupMemberRole.
- type: Default: "USER".
  - All of
    - : Refer to #/definitions/GroupMemberType.
- status: Default: "ACTIVE".
  - All of
    - : Refer to #/definitions/GroupMemberStatus.
- subscription: Default: "EACH_EMAIL".
  - All of
    - : Refer to #/definitions/GroupMemberSubscription.

WhoCanInvite: An enumeration. Must be one of: ["ALL_MANAGERS_CAN_INVITE", "ALL_MEMBERS_CAN_INVITE"].

WhoCanJoin: An enumeration. Must be one of: ["ALL_IN_DOMAIN_CAN_JOIN", "ANYONE_CAN_JOIN", "CAN_REQUEST_TO_JOIN"].

WhoCanPostMessage: An enumeration. Must be one of: ["ALL_IN_DOMAIN_CAN_POST", "ALL_MANAGERS_CAN_POST", "ALL_MEMBERS_CAN_POST", "ANYONE_CAN_POST", "NONE_CAN_POST"].

WhoCanViewGroup: An enumeration. Must be one of: ["ALL_IN_DOMAIN_CAN_VIEW", "ALL_MANAGERS_CAN_VIEW", "ALL_MEMBERS_CAN_VIEW", "ANYONE_CAN_VIEW"].

WhoCanViewMembership: An enumeration. Must be one of: ["ALL_IN_DOMAIN_CAN_VIEW", "ALL_MANAGERS_CAN_VIEW", "ALL_MEMBERS_CAN_VIEW", "ANYONE_CAN_VIEW"].

GroupProperties (object): A base model class that provides additional helper methods and configurations for other models used in IAMbic.
- name (string, required)
- domain (string, required)
- email (string, required)
- description (string, required)
- welcome_message (string)
- members (array, required)
  - Items: Refer to #/definitions/GroupMember.
- who_can_invite: Default: "ALL_MANAGERS_CAN_INVITE".
  - All of
    - : Refer to #/definitions/WhoCanInvite.
- who_can_join: Default: "CAN_REQUEST_TO_JOIN".
  - All of
    - : Refer to #/definitions/WhoCanJoin.
- who_can_post_message: Default: "NONE_CAN_POST".
  - All of
    - : Refer to #/definitions/WhoCanPostMessage.
- who_can_view_group: Default: "ALL_MANAGERS_CAN_VIEW".
  - All of
    - : Refer to #/definitions/WhoCanViewGroup.
- who_can_view_membership: Default: "ALL_MANAGERS_CAN_VIEW".
  - All of
    - : Refer to #/definitions/WhoCanViewMembership.
- iambic_managed: Default: "undefined".
  - All of
    - : Refer to #/definitions/IambicManaged.
- extra: Extra attributes to store.

GoogleWorkspaceGroupTemplate

Description​

Properties​

Definitions​

Description

Properties

Definitions