Skip to content

README.md

Latest commit

 

History

History
63 lines (43 loc) · 11.1 KB

README.md

File metadata and controls

63 lines (43 loc) · 11.1 KB
Raw

Users

Overview

Available Operations

list

List the users in the Glean directory, ordered by display_name and then by user_id. The list includes the same people as the Glean People directory. Inactive users, such as former employees, are left out unless an is_active filter includes the value "false". Use the returned user_id values with other Platform APIs, for example as usage limit targets.

Example Usage

package hello.world;

import com.glean.api_client.glean_api_client.Glean;
import com.glean.api_client.glean_api_client.models.errors.PlatformProblemDetailException;
import com.glean.api_client.glean_api_client.models.operations.PlatformUsersListResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws PlatformProblemDetailException, Exception {

        Glean sdk = Glean.builder()
                .apiToken(System.getenv().getOrDefault("GLEAN_API_TOKEN", ""))
            .build();

        PlatformUsersListResponse res = sdk.users().list()
                .pageSize(50L)
                .call();

        if (res.platformListUsersResponse().isPresent()) {
            System.out.println(res.platformListUsersResponse().get());
        }
    }
}

Parameters

Parameter Type Required Description
pageSize Optional<Long> ➖ Maximum number of users to return. Defaults to 50. Maximum is 100.
cursor Optional<String> ➖ Opaque pagination cursor from a previous response. Send the same filters that the previous request used.
filters List<PlatformUserFilter> ➖ JSON-encoded filters that choose which users are returned. The only supported field is is_active, with the values "true" and "false" and the operator EQUALS. Multiple values OR within a filter. Multiple filters AND together. Without an is_active filter, only active users are returned. To return active and inactive users, send [{"field":"is_active","values":["true","false"]}].
include List<PlatformUserInclude> ➖ Optional fields to add to each user. Each value only adds fields; it does not change which users are returned.

Response

PlatformUsersListResponse

Errors

Error Type Status Code Content Type
models/errors/PlatformProblemDetailException 400, 401, 403, 404, 408, 429 application/problem+json
models/errors/PlatformProblemDetailException 500, 503 application/problem+json
models/errors/APIException 4XX, 5XX */*