Databricks SDK for JavaScript
    Preparing search index...

    Interface UpdateUserRequest

    interface UpdateUserRequest {
        active?: boolean;
        displayName?: string;
        emails?: ComplexValue[];
        entitlements?: ComplexValue[];
        externalId?: string;
        groups?: ComplexValue[];
        id?: string;
        name?: Name;
        roles?: ComplexValue[];
        schemas?: UserSchema[];
        userName?: string;
    }
    Index

    Properties

    active? displayName? emails? entitlements? externalId? groups? id? name? roles? schemas? userName?

    Properties

    active?: boolean

    If this user is active

    displayName?: string

    String that represents a concatenation of given and family names. For example John Smith. This field cannot be updated through the Workspace SCIM APIs when identity federation is enabled. Use Account SCIM APIs to update displayName.

    emails?: ComplexValue[]

    All the emails associated with the user.

    entitlements?: ComplexValue[]

    Entitlements assigned to the user. See assigning entitlements for a full list of supported values.

    externalId?: string

    External ID is not currently supported. It is reserved for future use.

    groups?: ComplexValue[]
    id?: string

    user ID.

    name?: Name
    roles?: ComplexValue[]

    Corresponds to AWS instance profile/arn role.

    schemas?: UserSchema[]

    The schema of the user.

    userName?: string

    Email address of the user.

    Settings

    Member Visibility

    On This Page

    Properties