Type alias CreateUserBody

CreateUserBody: {
    custom_attributes?: {
        [key: string]: string;
    };
    email: string;
    first_name?: string;
    is_active?: boolean;
    is_delete_protected?: boolean;
    last_name?: string;
    locale?: string;
    middle_name?: string;
    nickname?: string;
    org_permissions?: OrgAccessPermissions;
    password?: string;
    phone_number?: string;
    picture?: string;
    project_id?: string;
    project_permissions?: ProjectAccessPermissions;
    restricted_custom_attributes?: {
        [key: string]: string;
    };
    tags?: string[];
    temp_password?: string;
    username?: string;
    zoneinfo?: string;
}

Type declaration

  • Optional custom_attributes?: {
        [key: string]: string;
    }

    Custom attributes for this user

    • [key: string]: string
  • email: string

    Email of the user

  • Optional first_name?: string

    First (or given) name of the user

  • Optional is_active?: boolean

    (Admin only) Whether this account is active

  • Optional is_delete_protected?: boolean

    Whether this account is delete protected

  • Optional last_name?: string

    Last (or family) name of the user

  • Optional locale?: string

    Locale of the account

  • Optional middle_name?: string

    Middle name of the user

  • Optional nickname?: string

    Nickname of the user

  • Optional org_permissions?: OrgAccessPermissions

    Organization permissions

  • Optional password?: string

    Password of the user

  • Optional phone_number?: string

    Phone number of the user

  • Optional picture?: string

    URL of the account's picture

  • Optional project_id?: string

    ID of project to create them in (org admins only)

  • Optional project_permissions?: ProjectAccessPermissions

    Project permissions

  • Optional restricted_custom_attributes?: {
        [key: string]: string;
    }

    Custom attributes only admins can update

    • [key: string]: string
  • Optional tags?: string[]

    List of tags on this account

  • Optional temp_password?: string

    Temporary password

  • Optional username?: string

    Username of the user

  • Optional zoneinfo?: string

    Timezone of the account

Settings

Member Visibility

Theme