Skip to main content

AzureActiveDirectoryUserTemplate

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::User".

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

  • owner (string)

  • 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 User.

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"].

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

    • user_id (string): Unique identifier for the user. This value is imported by IAMbic, and doesn't need to be manually set. Default: "".

    • username (string, required)

    • display_name (string, required)

    • mail_nickname (string)

    • given_name (string)

    • employee_id (string)

    • domain (string)

    • fullname (string)

    • status: Refer to #/definitions/UserStatus.

    • business_phones (array): List of business phone numbers. Default: [].

      • Items (string)

    • id (string): Unique identifier for the user.

    • job_title (string): Job title of the user.

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

    • mobile_phone (string): Mobile phone number of the user.

    • office_location (string): Office location of the user.

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

    • surname (string): Surname of the user.

    • user_principal_name (string): User principal name of the user.