/** * ThoughtSpot Public REST API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * * OpenAPI spec version: 2.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import { FavoriteMetadataInput } from '../models/FavoriteMetadataInput'; import { HttpFile } from '../http/http'; export class CreateUserRequest { /** * Name of the user. The username string must be unique. */ 'name': string; /** * A unique display name string for the user account, usually their first and last name */ 'display_name': string; /** * Password for the user account. For IAMv2 users, you must set this password if you do not want to trigger an activation email. */ 'password'?: string; /** * Email of the user account */ 'email': string; /** * Type of the account. */ 'account_type'?: CreateUserRequestAccountTypeEnum; /** * Current status of the user account. The `SUSPENDED` user state indicates a transitional state applicable to IAMv2 users only. */ 'account_status'?: CreateUserRequestAccountStatusEnum; /** * List of Org IDs to which the user belongs. */ 'org_identifiers'?: Array; /** * GUIDs or names of the groups to which the newly created user belongs. */ 'group_identifiers'?: Array; /** * Visibility of the users. When set to SHARABLE, the user is visible to other users and groups when they try to share an object. */ 'visibility'?: CreateUserRequestVisibilityEnum; /** * User preference for receiving email notifications when another ThoughtSpot user shares a metadata object such as Answer, Liveboard, or Worksheet. */ 'notify_on_share'?: boolean | null; /** * The user preference for revisiting the onboarding experience. */ 'show_onboarding_experience'?: boolean | null; /** * flag to get the on-boarding experience is completed or not. */ 'onboarding_experience_completed'?: boolean | null; /** * GUID of the Liveboard to set a default Liveboard for the user. ThoughtSpot displays this Liveboard on the Home page when the user logs in. */ 'home_liveboard_identifier'?: string; /** * Metadata objects to add to the user\'s favorites list. */ 'favorite_metadata'?: Array; /** * Locale for the user. When setting this value, do not set use_browser_language to true, otherwise the browser\'s language setting will take precedence and the preferred_locale value will be ignored. */ 'preferred_locale'?: CreateUserRequestPreferredLocaleEnum; /** * Flag to indicate whether to use the browser locale for the user in the UI. When set to true, the preferred_locale value is unset and the browser\'s language setting takes precedence. Version: 26.3.0.cl or later */ 'use_browser_language'?: boolean | null; /** * Properties for the user */ 'extended_properties'?: any | null; /** * Preferences for the user */ 'extended_preferences'?: any | null; /** * Flag to indicate whether a welcome email should be sent to the user. This parameter applies only on clusters where IAMv2 is not enabled. If the flag details are not specified, then it defaults to true. However, a welcome email is sent only when welcome email notifications are enabled on the cluster and the user has a valid email address. */ 'trigger_welcome_email'?: boolean | null; /** * Flag to indicate whether activation email should be sent to the user. Default value for IAMv2 users is set to true. Users must either set this to false, or enter a valid password if they do not want to trigger an activation email. */ 'trigger_activation_email'?: boolean | null; static readonly discriminator: string | undefined = undefined; static readonly mapping: {[index: string]: string} | undefined = undefined; static readonly attributeTypeMap: Array<{name: string, baseName: string, type: string, format: string}> = [ { "name": "name", "baseName": "name", "type": "string", "format": "" }, { "name": "display_name", "baseName": "display_name", "type": "string", "format": "" }, { "name": "password", "baseName": "password", "type": "string", "format": "" }, { "name": "email", "baseName": "email", "type": "string", "format": "" }, { "name": "account_type", "baseName": "account_type", "type": "CreateUserRequestAccountTypeEnum", "format": "" }, { "name": "account_status", "baseName": "account_status", "type": "CreateUserRequestAccountStatusEnum", "format": "" }, { "name": "org_identifiers", "baseName": "org_identifiers", "type": "Array", "format": "" }, { "name": "group_identifiers", "baseName": "group_identifiers", "type": "Array", "format": "" }, { "name": "visibility", "baseName": "visibility", "type": "CreateUserRequestVisibilityEnum", "format": "" }, { "name": "notify_on_share", "baseName": "notify_on_share", "type": "boolean", "format": "" }, { "name": "show_onboarding_experience", "baseName": "show_onboarding_experience", "type": "boolean", "format": "" }, { "name": "onboarding_experience_completed", "baseName": "onboarding_experience_completed", "type": "boolean", "format": "" }, { "name": "home_liveboard_identifier", "baseName": "home_liveboard_identifier", "type": "string", "format": "" }, { "name": "favorite_metadata", "baseName": "favorite_metadata", "type": "Array", "format": "" }, { "name": "preferred_locale", "baseName": "preferred_locale", "type": "CreateUserRequestPreferredLocaleEnum", "format": "" }, { "name": "use_browser_language", "baseName": "use_browser_language", "type": "boolean", "format": "" }, { "name": "extended_properties", "baseName": "extended_properties", "type": "any", "format": "" }, { "name": "extended_preferences", "baseName": "extended_preferences", "type": "any", "format": "" }, { "name": "trigger_welcome_email", "baseName": "trigger_welcome_email", "type": "boolean", "format": "" }, { "name": "trigger_activation_email", "baseName": "trigger_activation_email", "type": "boolean", "format": "" } ]; static getAttributeTypeMap() { return CreateUserRequest.attributeTypeMap; } public constructor() { } } export type CreateUserRequestAccountTypeEnum = "LOCAL_USER" | "LDAP_USER" | "SAML_USER" | "OIDC_USER" | "REMOTE_USER" ; export type CreateUserRequestAccountStatusEnum = "ACTIVE" | "INACTIVE" | "EXPIRED" | "LOCKED" | "PENDING" | "SUSPENDED" ; export type CreateUserRequestVisibilityEnum = "SHARABLE" | "NON_SHARABLE" ; export type CreateUserRequestPreferredLocaleEnum = "en-CA" | "en-GB" | "en-US" | "de-DE" | "ja-JP" | "zh-CN" | "pt-BR" | "fr-FR" | "fr-CA" | "es-US" | "da-DK" | "es-ES" | "fi-FI" | "sv-SE" | "nb-NO" | "pt-PT" | "nl-NL" | "it-IT" | "ru-RU" | "en-IN" | "de-CH" | "en-NZ" | "es-MX" | "en-AU" | "zh-Hant" | "ko-KR" | "en-DE" ;