Skip to main content

AzureActiveDirectoryGroupTemplate

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​

  • template_type (string): Default: "NOQ::AzureAD::Group".

  • template_schema_url (string): Default: "https://docs.iambic.org/reference/schemas/azure_active_directory_group_template".

  • owner (string): Owner of the group.

  • notes (string)

  • iambic_managed: Controls the directionality of Iambic changes. Default: "undefined".

  • idp_name (string): Name of the identity provider that's associated with the resource.

  • 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'

  • properties: Properties for the Azure AD Group.

Definitions​

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

  • Member (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'

    • id (string): Unique ID for the member. This value is imported by IAMbic, and doesn't need to be manually set.

    • name (string, required)

    • data_type: Refer to #/definitions/MemberDataType.

  • GroupTemplateProperties (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'

    • name (string, required): Name of the group.

    • mail_nickname (string): Mail nickname of the group.

    • group_id (string): Unique Group ID for the group. This value is imported by IAMbic, and doesn't need to be manually set.

    • description (string): Description of the group. Default: "".

    • group_types (array): Specifies the group type and its membership. Default: [].

      • Items (string)

    • mail (string): Email address of the group.

    • mail_enabled (boolean): Default: false.

    • security_enabled (boolean): Default: true.

    • extra: Extra attributes to store.

    • is_assignable_to_role (boolean): Indicates whether this group can be assigned to an Azure Active Directory role or not.

    • membership_rule (string): The rule that determines members for this group if the group is a dynamic group.

    • members (array): A list of users in the group. Default: [].

    • classification (string): Classification of the group.

    • created_date_time (string): Date and time when the group was created.

    • creation_options (array): Specifies the group type and its membership.

      • Items (string)

    • deleted_date_time (string): Date and time when the group was deleted.

    • expiration_date_time (string): Date and time when the group expires.

    • membership_rule_processing_state (string): Indicates whether the group is a dynamic group or not.

    • preferred_data_location (string): Preferred data location of the group.

    • preferred_language (string): Preferred language of the group.

    • proxy_addresses (array): Proxy addresses of the group.

      • Items (string)

    • renewed_date_time (string): Date and time when the group was renewed.

    • resource_behavior_options (array): Resource behavior options of the group.

      • Items (string)

    • resource_provisioning_options (array): Resource provisioning options of the group.

      • Items (string)

    • security_identifier (string): Security identifier of the group.

    • theme (string): Theme of the group.

    • visibility (string): Visibility of the group.