Type Alias: UserManagementClientConfig

type UserManagementClientConfig = Omit<ClientConfig, "auth" | "host"> & object;

Defined in: src/userManagement/createUserManagementClient.ts:27

Type Declaration

auth

auth: AuthBearer;

An organization API key created without scopes, under Settings in the organization's own administration.

A key created with scopes is refused — measured: every operation answers 403 naming a manage:org scope the key creation flow does not offer. Nothing else reaches this API either: a site API token answers 401, and so does OAuth 2.0 (3LO), whose scopes are granted by a user for a site rather than by an organization for itself.

host?

optional host?: string;

The Atlassian gateway, which is where this API answers rather than on any site's host.

Defaults to https://api.atlassian.com. There is nowhere else to point it; the field exists for a proxy.