Skip to main content

OktaGroupTemplate

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::Okta::Group".

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

  • owner (string): Owner of the group.

  • notes (string)

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

  • properties: Properties for the Okta Group.

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

Definitions​

  • IambicManaged: An enumeration. Must be one of: ["undefined", "read_and_write", "import_only", "enforced", "disabled"].
  • UserStatus: An enumeration. Must be one of: ["active", "provisioned", "deprovisioned", "recovery", "suspended", "staged", "locked_out", "password_expired"].

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

    • username (string, required)

    • status: Status for the group.

    • background_check_status (boolean): Background check status for the group. Default: false.

    • created (string): Created date for the group.

    • domain (string): Domain for the group.

    • extra: Extra attributes to store.

    • fullname (string): Full name for the group.

    • groups (array): Groups for the group.

      • Items (string)

    • idp_name (string): IDP name for the group.

    • profile: Profile for the group.

    • updated (string): Updated date for the group.

    • user_id (string): User ID for the group.

  • GroupProperties (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.

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

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

    • extra: Extra attributes to store.

    • members (array): Users in the group. Default: [].

    • identifier (string): Identifier for the group. Usually it's the group name.