Databricks SDK for JavaScript
    Preparing search index...

    Interface ListUsersRequest

    List users

    interface ListUsersRequest {
        attributes?: string;
        count?: bigint;
        excludedAttributes?: string;
        filter?: string;
        sortBy?: string;
        sortOrder?: ListSort_Order;
        startIndex?: bigint;
    }
    Index

    Properties

    attributes? count? excludedAttributes? filter? sortBy? sortOrder? startIndex?

    Properties

    attributes?: string

    Comma-separated list of attributes to return in response.

    count?: bigint

    Desired number of results per page.

    excludedAttributes?: string

    Comma-separated list of attributes to exclude in response.

    filter?: string

    Query by which the results have to be filtered. Supported operators are equals(eq), contains(co), starts with(sw) and not equals(ne). Additionally, simple expressions can be formed using logical operators - and and or. The SCIM RFC has more details but we currently only support simple expressions.

    sortBy?: string

    Attribute to sort the results. Multi-part paths are supported. For example, userName, name.givenName, and emails.

    sortOrder?: ListSort_Order

    The order to sort the results.

    startIndex?: bigint

    Specifies the index of the first result. First item is number 1.

    Settings

    Member Visibility

    On This Page

    Properties