Skip to main content

OktaUserTemplate

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

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

  • owner (string)

  • notes (string)

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

  • properties: Refer to #/definitions/UserProperties.

  • force_delete (boolean): If self.deleted is true, the user will be force deleted from Okta. . Default: false.

  • idp_name (string): Name of the identity provider that's associated with the 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", "recovery", "suspended", "staged", "locked_out", "password_expired"].
  • UserProperties (object): A base model class that provides additional helper methods and configurations for other models used in IAMbic.
    • username (string, required): Username of the user.
    • user_id (string): Unique User ID for the user. This value is imported by IAMbic, and doesn't need to be manually set. Default: "".
    • status: Status of the user. Default: "active".
    • profile (object, required)
    • extra (object): Extra attributes to store for the user.