Function: createUserProvisioningClient()

function createUserProvisioningClient(config): object;

Defined in: src/userProvisioning/createUserProvisioningClient.ts:62

Parameters

Parameter	Type
`config`	`UserProvisioningClientConfig`

Returns

object

groups

groups: object;

groups.createGroup

createGroup: (parameters, options?) => Promise<{
[key: string]: unknown;
  displayName?: string;
  externalId?: string;
  id?: string;
  members?: object[];
  meta?: {
   [key: string]: unknown;
     created?: Date;
     lastModified?: Date;
     location?: string;
     resourceType?: string & object | "USER" | "GROUP" | "DIRECTORY";
  };
  schemas?: string[];
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `directoryId`: `string`; `displayName?`: `string`; `externalId?`: `string`; `id?`: `string`; `members?`: `object`[]; `meta?`: { `created?`: `unknown`; `lastModified?`: `unknown`; `location?`: `string`; `resourceType?`: `string` & `object` \| `"USER"` \| `"GROUP"` \| `"DIRECTORY"`; }; `schemas?`: `string`[]; }	-
`parameters.directoryId`	`string`	The SCIM base URL that is generated when conecting an identity provider with SCIM provisioning.
`parameters.displayName?`	`string`	Group display name. This is a immutable, required, and read-only field.
`parameters.externalId?`	`string`	Identifier defined by provisioning client. CaseExact. Uniqueness is controlled by client.
`parameters.id?`	`string`	Unique identifier defined by Atlassian SCIM Service. This is a read-only and case-sensitive field. It is ignored if specified in the payload during user creation or modification.
`parameters.members?`	`object`[]	Group members
`parameters.meta?`	{ `created?`: `unknown`; `lastModified?`: `unknown`; `location?`: `string`; `resourceType?`: `string` & `object` \| `"USER"` \| `"GROUP"` \| `"DIRECTORY"`; }	-
`parameters.meta.created?`	`unknown`	The DateTime that the resource was added to Atlassian SCIM service. This is a read-only field.
`parameters.meta.lastModified?`	`unknown`	The most recent DateTime that the details of this resource were updated. This is a read-only field.
`parameters.meta.location?`	`string`	The URI of the resource being returned. This is a read-only field.
`parameters.meta.resourceType?`	`string` & `object` \| `"USER"` \| `"GROUP"` \| `"DIRECTORY"`	The name of the resource type of the resource. This is a read-only and case-sensitive field.
`parameters.schemas?`	`string`[]	SCIM schemas that define the attributes present in the current JSON structure. This ia a required field during user creation or modification.
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; displayName?: string; externalId?: string; id?: string; members?: object[]; meta?: { [key: string]: unknown; created?: Date; lastModified?: Date; location?: string; resourceType?: string & object | "USER" | "GROUP" | "DIRECTORY"; }; schemas?: string[]; }>

groups.deleteGroup

deleteGroup: (parameters, options?) => Promise<void>;

Parameters

Parameter	Type	Description
`parameters`	{ `directoryId`: `string`; `id`: `string`; }	-
`parameters.directoryId`	`string`	The SCIM base URL that is generated when conecting an identity provider with SCIM provisioning.
`parameters.id?`	`string`	Unique SCIM id that serves as reference to the group. Use the Get groups API to get the SCIM id.
`options?`	`RequestOptions`	-

Returns

Promise<void>

groups.getGroup

getGroup: (parameters, options?) => Promise<{
[key: string]: unknown;
  displayName?: string;
  externalId?: string;
  id?: string;
  members?: object[];
  meta?: {
   [key: string]: unknown;
     created?: Date;
     lastModified?: Date;
     location?: string;
     resourceType?: string & object | "USER" | "GROUP" | "DIRECTORY";
  };
  schemas?: string[];
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `directoryId`: `string`; `id`: `string`; }	-
`parameters.directoryId`	`string`	The SCIM base URL that is generated when conecting an identity provider with SCIM provisioning.
`parameters.id?`	`string`	Unique SCIM id that serves as reference to the group. Use the Get groups API to get the SCIM id.
`options?`	`RequestOptions`	-

Returns

groups.getGroups

getGroups: (parameters, options?) => Promise<{
[key: string]: unknown;
  itemsPerPage?: number;
  Resources?: object[];
  schemas?: string[];
  startIndex?: number;
  totalResults?: number;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `count?`: `number`; `directoryId`: `string`; `filter?`: `string`; `startIndex?`: `number`; }	-
`parameters.count?`	`number`	Desired maximum number of query results in the list response page.
`parameters.directoryId?`	`string`	The SCIM base URL that is generated when conecting an identity provider with SCIM provisioning.
`parameters.filter?`	`string`	Filter for `displayName`. Example: `displayName eq "SCIM_GROUP"`
`parameters.startIndex?`	`number`	A 1-based index of the first query result.
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; itemsPerPage?: number; Resources?: object[]; schemas?: string[]; startIndex?: number; totalResults?: number; }>

groups.patchGroup

patchGroup: (parameters, options?) => Promise<{
[key: string]: unknown;
  displayName?: string;
  externalId?: string;
  id?: string;
  members?: object[];
  meta?: {
   [key: string]: unknown;
     created?: Date;
     lastModified?: Date;
     location?: string;
     resourceType?: string & object | "USER" | "GROUP" | "DIRECTORY";
  };
  schemas?: string[];
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `directoryId`: `string`; `id`: `string`; `operations?`: `object`[]; `schemas?`: `string`[]; }	-
`parameters.directoryId`	`string`	The SCIM base URL that is generated when conecting an identity provider with SCIM provisioning.
`parameters.id?`	`string`	Unique SCIM id that serves as reference to the group. Use the Get groups API to get the SCIM id.
`parameters.operations?`	`object`[]	SCIM patch operations.
`parameters.schemas?`	`string`[]	SCIM patch schemas.
`options?`	`RequestOptions`	-

Returns

groups.replaceGroup

replaceGroup: (parameters, options?) => Promise<{
[key: string]: unknown;
  displayName?: string;
  externalId?: string;
  id?: string;
  members?: object[];
  meta?: {
   [key: string]: unknown;
     created?: Date;
     lastModified?: Date;
     location?: string;
     resourceType?: string & object | "USER" | "GROUP" | "DIRECTORY";
  };
  schemas?: string[];
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `directoryId`: `string`; `displayName?`: `string`; `externalId?`: `string`; `id`: `string`; `members?`: `object`[]; `meta?`: { `created?`: `unknown`; `lastModified?`: `unknown`; `location?`: `string`; `resourceType?`: `string` & `object` \| `"USER"` \| `"GROUP"` \| `"DIRECTORY"`; }; `schemas?`: `string`[]; }	-
`parameters.directoryId`	`string`	The SCIM base URL that is generated when conecting an identity provider with SCIM provisioning.
`parameters.displayName?`	`string`	Group display name. This is a immutable, required, and read-only field.
`parameters.externalId?`	`string`	Identifier defined by provisioning client. CaseExact. Uniqueness is controlled by client.
`parameters.id?`	`string`	Unique SCIM id that serves as reference to the group. Use the [Get groups API] (https://developer.atlassian.com/cloud/admin/user-provisioning/rest/api-group-groups/#api-scim-directory-directoryid-groups-get) to get the SCIM id.
`parameters.members?`	`object`[]	Group members
`parameters.meta?`	{ `created?`: `unknown`; `lastModified?`: `unknown`; `location?`: `string`; `resourceType?`: `string` & `object` \| `"USER"` \| `"GROUP"` \| `"DIRECTORY"`; }	Group metadata information.
`parameters.meta.created?`	`unknown`	The DateTime that the resource was added to Atlassian SCIM service. This is a read-only field.
`parameters.meta.lastModified?`	`unknown`	The most recent DateTime that the details of this resource were updated. This is a read-only field.
`parameters.meta.location?`	`string`	The URI of the resource being returned. This is a read-only field.
`parameters.meta.resourceType?`	`string` & `object` \| `"USER"` \| `"GROUP"` \| `"DIRECTORY"`	The name of the resource type of the resource. This is a read-only and case-sensitive field.
`parameters.schemas?`	`string`[]	SCIM schemas that define the attributes present in the current JSON structure. This ia a required field during user creation or modification.
`options?`	`RequestOptions`	-

Returns

schemas

schemas: object;

schemas.getExtensionUserSchemas

getExtensionUserSchemas: (parameters, options?) => Promise<Record<string, unknown>>;

Parameters

Parameter	Type	Description
`parameters`	{ `directoryId`: `string`; }	-
`parameters.directoryId`	`string`	The SCIM base URL that is generated when conecting an identity provider with SCIM provisioning.
`options?`	`RequestOptions`	-

Returns

Promise<Record<string, unknown>>

schemas.getGroupSchemas

getGroupSchemas: (parameters, options?) => Promise<Record<string, unknown>>;

Parameters

Parameter	Type	Description
`parameters`	{ `directoryId`: `string`; }	-
`parameters.directoryId`	`string`	The SCIM base URL that is generated when conecting an identity provider with SCIM provisioning.
`options?`	`RequestOptions`	-

Returns

Promise<Record<string, unknown>>

schemas.getSchemas

getSchemas: (parameters, options?) => Promise<Record<string, unknown>>;

Parameters

Parameter	Type	Description
`parameters`	{ `directoryId`: `string`; }	-
`parameters.directoryId`	`string`	The SCIM base URL that is generated when conecting an identity provider with SCIM provisioning.
`options?`	`RequestOptions`	-

Returns

Promise<Record<string, unknown>>

schemas.getUserSchemas

getUserSchemas: (parameters, options?) => Promise<Record<string, unknown>>;

Parameters

Parameter	Type	Description
`parameters`	{ `directoryId`: `string`; }	-
`parameters.directoryId`	`string`	The SCIM base URL that is generated when conecting an identity provider with SCIM provisioning.
`options?`	`RequestOptions`	-

Returns

Promise<Record<string, unknown>>

scimLinks

scimLinks: object;

scimLinks.deleteProvisioningRecord

deleteProvisioningRecord: (parameters, options?) => Promise<void>;

Parameters

Parameter	Type	Description
`parameters`	{ `aaId`: `string`; `orgId`: `string`; }	-
`parameters.aaId`	`string`	Unique ID of the user's account. The AAID can either be found in the URL of a user's profile, when browsing in the "Users" tab or the "Managed Users" tab or use the Get Users API to get the AAID. The URL could look like: `https://admin.atlassian.com/o/{orgId}/users/{aaId}` `https://admin.atlassian.com/o/{orgId}/members/{aaId}` `https://admin.atlassian.com/s/{siteId}/users/{aaId}`
`parameters.orgId?`	`string`	Your organization is identified by a Unique ID. You get your organization ID and Organization API key simultaneously.
`options?`	`RequestOptions`	-

Returns

Promise<void>

scimLinks.getScimLinks

getScimLinks: (parameters, options?) => Promise<{
[key: string]: unknown;
  scimLinks?: object[];
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `aaId`: `string`; `orgId`: `string`; }	-
`parameters.aaId`	`string`	Unique ID of the user's account. The AAID can either be found in the URL of a user's profile, when browsing in the "Users" tab or the "Managed Users" tab or use the Get Users API to get the AAID. The URL could look like: `https://admin.atlassian.com/o/{orgId}/users/{aaId}` `https://admin.atlassian.com/o/{orgId}/members/{aaId}` `https://admin.atlassian.com/s/{siteId}/users/{aaId}`
`parameters.orgId?`	`string`	Your organization is identified by a Unique ID. You get your organization ID and Organization API key simultaneously.
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; scimLinks?: object[]; }>

scimLinks.getScimLinksByEmail

getScimLinksByEmail: (parameters, options?) => Promise<{
[key: string]: unknown;
  scimLinks?: object[];
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `email`: `string`; `orgId`: `string`; }	-
`parameters.email`	`string`	The email address to look up SCIM links for
`parameters.orgId?`	`string`	Your organization is identified by a Unique ID. You get your organization ID and Organization API key simultaneously.
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; scimLinks?: object[]; }>

scimLinks.unlinkScimUser

unlinkScimUser: (parameters, options?) => Promise<void>;

Parameters

Parameter	Type	Description
`parameters`	{ `orgId`: `string`; `scimDirectoryId`: `string`; `scimUserId`: `string`; }	-
`parameters.orgId`	`string`	Your organization is identified by a Unique ID. You get your organization ID and Organization API key simultaneously.
`parameters.scimDirectoryId?`	`string`	The SCIM base URL that is generated when conecting an identity provider with SCIM provisioning.
`parameters.scimUserId?`	`string`	The SCIM user ID to unlink. Use the Get SCIM Links for an email API to get the SCIM User ID.
`options?`	`RequestOptions`	-

Returns

Promise<void>

serviceProviderConfiguration

serviceProviderConfiguration: object;

serviceProviderConfiguration.getGroupResourceType

getGroupResourceType: (parameters, options?) => Promise<Record<string, unknown>>;

Parameters

Parameter	Type	Description
`parameters`	{ `directoryId`: `string`; }	-
`parameters.directoryId`	`string`	The SCIM base URL that is generated when conecting an identity provider with SCIM provisioning.
`options?`	`RequestOptions`	-

Returns

Promise<Record<string, unknown>>

serviceProviderConfiguration.getResourceTypes

getResourceTypes: (parameters, options?) => Promise<Record<string, unknown>>;

Parameters

Parameter	Type	Description
`parameters`	{ `directoryId`: `string`; }	-
`parameters.directoryId`	`string`	The SCIM base URL that is generated when conecting an identity provider with SCIM provisioning.
`options?`	`RequestOptions`	-

Returns

Promise<Record<string, unknown>>

serviceProviderConfiguration.getServiceProviderConfig

getServiceProviderConfig: (parameters, options?) => Promise<Record<string, unknown>>;

Parameters

Parameter	Type	Description
`parameters`	{ `directoryId`: `string`; }	-
`parameters.directoryId`	`string`	The SCIM base URL that is generated when conecting an identity provider with SCIM provisioning.
`options?`	`RequestOptions`	-

Returns

Promise<Record<string, unknown>>

serviceProviderConfiguration.getUserResourceType

getUserResourceType: (parameters, options?) => Promise<Record<string, unknown>>;

Parameters

Parameter	Type	Description
`parameters`	{ `directoryId`: `string`; }	-
`parameters.directoryId`	`string`	The SCIM base URL that is generated when conecting an identity provider with SCIM provisioning.
`options?`	`RequestOptions`	-

Returns

Promise<Record<string, unknown>>

users

users: object;

users.createUser

createUser: (parameters, options?) => Promise<{
[key: string]: unknown;
  active?: boolean;
  department?: string;
  displayName?: string;
  emails?: object[];
  externalId?: string;
  groups?: object[];
  id?: string;
  meta?: {
   [key: string]: unknown;
     created?: Date;
     lastModified?: Date;
     location?: string;
     resourceType?: string & object | "USER" | "GROUP" | "DIRECTORY";
  };
  name?: {
   [key: string]: unknown;
     familyName?: string;
     formatted?: string;
     givenName?: string;
     honorificPrefix?: string;
     honorificSuffix?: string;
     middleName?: string;
  };
  nickName?: string;
  organization?: string;
  phoneNumbers?: object[];
  preferredLanguage?: string;
  schemas?: string[];
  timezone?: string;
  title?: string;
  urn:ietf:params:scim:schemas:extension:enterprise:2.0:User?: {
   [key: string]: unknown;
     department?: string;
     organization?: string;
  };
  urn:scim:schemas:extension:atlassian-external:1.0?: {
   [key: string]: unknown;
     atlassianAccountId?: string;
  };
  userName?: string;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `active?`: `boolean`; `attributes?`: `string`; `department?`: `string`; `directoryId`: `string`; `displayName?`: `string`; `emails?`: `object`[]; `excludedAttributes?`: `string`; `externalId?`: `string`; `groups?`: `object`[]; `id?`: `string`; `meta?`: { `created?`: `unknown`; `lastModified?`: `unknown`; `location?`: `string`; `resourceType?`: `string` & `object` \| `"USER"` \| `"GROUP"` \| `"DIRECTORY"`; }; `name?`: { `familyName?`: `string`; `formatted?`: `string`; `givenName?`: `string`; `honorificPrefix?`: `string`; `honorificSuffix?`: `string`; `middleName?`: `string`; }; `nickName?`: `string`; `organization?`: `string`; `phoneNumbers?`: `object`[]; `preferredLanguage?`: `string`; `schemas?`: `string`[]; `timezone?`: `string`; `title?`: `string`; `urn:ietf:params:scim:schemas:extension:enterprise:2.0:User?`: { `department?`: `string`; `organization?`: `string`; }; `urn:scim:schemas:extension:atlassian-external:1.0?`: { `atlassianAccountId?`: `string`; }; `userName?`: `string`; }	-
`parameters.active?`	`boolean`	A boolean value indicating the user's administrative status. This value will default to true if not provided.
`parameters.attributes?`	`string`	Resource attributes to be included in response. Mutually exclusive from `excludedAttributes`. Example: `userName,emails.value`
`parameters.department?`	`string`	User's department.
`parameters.directoryId?`	`string`	The SCIM base URL that is generated when conecting an identity provider with SCIM provisioning.
`parameters.displayName?`	`string`	User's display name.
`parameters.emails?`	`object`[]	Email addresses of the User. This is a required field during user creation or modification. One value must be marked as primary.
`parameters.excludedAttributes?`	`string`	Resource attributes to be excluded from response. Mutually exclusive from `attributes`. Example: `timezone,emails.type,department`
`parameters.externalId?`	`string`	Identifier defined by provisioning client. This is a case-sensitive field. Uniqueness is controlled by client.
`parameters.groups?`	`object`[]	Groups to which the user is associated in SCIM.
`parameters.id?`	`string`	Unique identifier defined by Atlassian SCIM Service. CaseExact. This is a read-only field and will be disregarded if included in the payload during user creation or modification..
`parameters.meta?`	{ `created?`: `unknown`; `lastModified?`: `unknown`; `location?`: `string`; `resourceType?`: `string` & `object` \| `"USER"` \| `"GROUP"` \| `"DIRECTORY"`; }	-
`parameters.meta.created?`	`unknown`	The DateTime that the resource was added to Atlassian SCIM service. This is a read-only field.
`parameters.meta.lastModified?`	`unknown`	The most recent DateTime that the details of this resource were updated. This is a read-only field.
`parameters.meta.location?`	`string`	The URI of the resource being returned. This is a read-only field.
`parameters.meta.resourceType?`	`string` & `object` \| `"USER"` \| `"GROUP"` \| `"DIRECTORY"`	The name of the resource type of the resource. This is a read-only and case-sensitive field.
`parameters.name?`	{ `familyName?`: `string`; `formatted?`: `string`; `givenName?`: `string`; `honorificPrefix?`: `string`; `honorificSuffix?`: `string`; `middleName?`: `string`; }	-
`parameters.name.familyName?`	`string`	The family name of the User.
`parameters.name.formatted?`	`string`	The full name, including all middle names, titles, and suffixes as appropriate, formatted for display.
`parameters.name.givenName?`	`string`	The given name of the User.
`parameters.name.honorificPrefix?`	`string`	The honorific prefix(es) of the User, or title in most Western languages.
`parameters.name.honorificSuffix?`	`string`	The honorific suffix(es) of the User, or suffix in most Western languages.
`parameters.name.middleName?`	`string`	The middle name(s) of the User.
`parameters.nickName?`	`string`	User's nickname.
`parameters.organization?`	`string`	User's organization.
`parameters.phoneNumbers?`	`object`[]	Phone numbers of the user.
`parameters.preferredLanguage?`	`string`	User's preferred language.
`parameters.schemas?`	`string`[]	SCIM schemas that define the attributes present in the current JSON structure This is a required field during user creation or modification.
`parameters.timezone?`	`string`	User's timezone. e.g. America/Los_Angeles .
`parameters.title?`	`string`	User's title.
`parameters.urn:ietf:params:scim:schemas:extension:enterprise:2.0:User?`	{ `department?`: `string`; `organization?`: `string`; }	-
`parameters.urn:ietf:params:scim:schemas:extension:enterprise:2.0:User.department?`	`string`	Department the user belongs to.
`parameters.urn:ietf:params:scim:schemas:extension:enterprise:2.0:User.organization?`	`string`	Organization the user belongs to.
`parameters.urn:scim:schemas:extension:atlassian-external:1.0?`	{ `atlassianAccountId?`: `string`; }	-
`parameters.urn:scim:schemas:extension:atlassian-external:1.0.atlassianAccountId?`	`string`	-
`parameters.userName?`	`string`	Unique identifier defined by the provisioning client. Atlassian SCIM service will verify the value and guarantee its uniqueness. This is a required field during user creation or modification.
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; active?: boolean; department?: string; displayName?: string; emails?: object[]; externalId?: string; groups?: object[]; id?: string; meta?: { [key: string]: unknown; created?: Date; lastModified?: Date; location?: string; resourceType?: string & object | "USER" | "GROUP" | "DIRECTORY"; }; name?: { [key: string]: unknown; familyName?: string; formatted?: string; givenName?: string; honorificPrefix?: string; honorificSuffix?: string; middleName?: string; }; nickName?: string; organization?: string; phoneNumbers?: object[]; preferredLanguage?: string; schemas?: string[]; timezone?: string; title?: string; urn:ietf:params:scim:schemas:extension:enterprise:2.0:User?: { [key: string]: unknown; department?: string; organization?: string; }; urn:scim:schemas:extension:atlassian-external:1.0?: { [key: string]: unknown; atlassianAccountId?: string; }; userName?: string; }>

users.deleteUser

deleteUser: (parameters, options?) => Promise<void>;

Parameters

Parameter	Type	Description
`parameters`	{ `directoryId`: `string`; `userId`: `string`; }	-
`parameters.directoryId`	`string`	The ID assigned to your identity provider when linked to your Atlassian organization.
`parameters.userId?`	`string`	Unique ID to identiy the SCIM users. Use the Get users API to get the userId.
`options?`	`RequestOptions`	-

Returns

Promise<void>

users.getUser

getUser: (parameters, options?) => Promise<{
[key: string]: unknown;
  active?: boolean;
  department?: string;
  displayName?: string;
  emails?: object[];
  externalId?: string;
  groups?: object[];
  id?: string;
  meta?: {
   [key: string]: unknown;
     created?: Date;
     lastModified?: Date;
     location?: string;
     resourceType?: string & object | "USER" | "GROUP" | "DIRECTORY";
  };
  name?: {
   [key: string]: unknown;
     familyName?: string;
     formatted?: string;
     givenName?: string;
     honorificPrefix?: string;
     honorificSuffix?: string;
     middleName?: string;
  };
  nickName?: string;
  organization?: string;
  phoneNumbers?: object[];
  preferredLanguage?: string;
  schemas?: string[];
  timezone?: string;
  title?: string;
  urn:ietf:params:scim:schemas:extension:enterprise:2.0:User?: {
   [key: string]: unknown;
     department?: string;
     organization?: string;
  };
  urn:scim:schemas:extension:atlassian-external:1.0?: {
   [key: string]: unknown;
     atlassianAccountId?: string;
  };
  userName?: string;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `attributes?`: `string`; `directoryId`: `string`; `excludedAttributes?`: `string`; `userId`: `string`; }	-
`parameters.attributes?`	`string`	Resource attributes to be included in response. Mutually exclusive with `excludedAttributes`. Example: `userName,emails.value`
`parameters.directoryId?`	`string`	The SCIM base URL that is generated when conecting an identity provider with SCIM provisioning.
`parameters.excludedAttributes?`	`string`	Resource attributes to be excluded from response. Mutually exclusive with `attributes`. Example: `timezone,emails.type,department`
`parameters.userId?`	`string`	Unique ID to identiy the users. Use the Get users API to get the userId.
`options?`	`RequestOptions`	-

Returns

users.getUsers

getUsers: (parameters, options?) => Promise<{
[key: string]: unknown;
  itemsPerPage?: number;
  Resources?: object[];
  schemas?: string[];
  startIndex?: number;
  totalResults?: number;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `attributes?`: `string`; `count?`: `number`; `directoryId`: `string`; `excludedAttributes?`: `string`; `filter?`: `string`; `startIndex?`: `number`; }	-
`parameters.attributes?`	`string`	Resource attributes to be included in response. Mutually exclusive from `excludedAttributes`. Example: `userName,emails.value`
`parameters.count?`	`number`	Desired maximum number of query results in the list response page.
`parameters.directoryId?`	`string`	The SCIM base URL that is generated when conecting an identity provider with SCIM provisioning.
`parameters.excludedAttributes?`	`string`	Resource attributes to be excluded from response. Mutually exclusive from `attributes`. Example: `timezone,emails.type,department`
`parameters.filter?`	`string`	Filter for `userName` or `externalId`. Example: `userName eq "Atlassian"`
`parameters.startIndex?`	`number`	A 1-based index of the first query result.
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; itemsPerPage?: number; Resources?: object[]; schemas?: string[]; startIndex?: number; totalResults?: number; }>

users.patchUser

patchUser: (parameters, options?) => Promise<{
[key: string]: unknown;
  active?: boolean;
  department?: string;
  displayName?: string;
  emails?: object[];
  externalId?: string;
  groups?: object[];
  id?: string;
  meta?: {
   [key: string]: unknown;
     created?: Date;
     lastModified?: Date;
     location?: string;
     resourceType?: string & object | "USER" | "GROUP" | "DIRECTORY";
  };
  name?: {
   [key: string]: unknown;
     familyName?: string;
     formatted?: string;
     givenName?: string;
     honorificPrefix?: string;
     honorificSuffix?: string;
     middleName?: string;
  };
  nickName?: string;
  organization?: string;
  phoneNumbers?: object[];
  preferredLanguage?: string;
  schemas?: string[];
  timezone?: string;
  title?: string;
  urn:ietf:params:scim:schemas:extension:enterprise:2.0:User?: {
   [key: string]: unknown;
     department?: string;
     organization?: string;
  };
  urn:scim:schemas:extension:atlassian-external:1.0?: {
   [key: string]: unknown;
     atlassianAccountId?: string;
  };
  userName?: string;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `attributes?`: `string`; `directoryId`: `string`; `excludedAttributes?`: `string`; `operations?`: `object`[]; `schemas?`: `string`[]; `userId`: `string`; }	-
`parameters.attributes?`	`string`	Resource attributes to be included in the response. Mutually exclusive from `excludedAttributes`. Example: `userName,emails.value`
`parameters.directoryId?`	`string`	The SCIM base URL that is generated when conecting an identity provider with SCIM provisioning.
`parameters.excludedAttributes?`	`string`	Resource attributes to be included in the response. Mutually exclusive from `attributes`. Example: `timezone,emails.type,department`
`parameters.operations?`	`object`[]	SCIM patch operations.
`parameters.schemas?`	`string`[]	SCIM patch schemas.
`parameters.userId?`	`string`	Unique ID to identiy the users. Use the Get users API to get the userId.
`options?`	`RequestOptions`	-

Returns

users.replaceUser

replaceUser: (parameters, options?) => Promise<{
[key: string]: unknown;
  active?: boolean;
  department?: string;
  displayName?: string;
  emails?: object[];
  externalId?: string;
  groups?: object[];
  id?: string;
  meta?: {
   [key: string]: unknown;
     created?: Date;
     lastModified?: Date;
     location?: string;
     resourceType?: string & object | "USER" | "GROUP" | "DIRECTORY";
  };
  name?: {
   [key: string]: unknown;
     familyName?: string;
     formatted?: string;
     givenName?: string;
     honorificPrefix?: string;
     honorificSuffix?: string;
     middleName?: string;
  };
  nickName?: string;
  organization?: string;
  phoneNumbers?: object[];
  preferredLanguage?: string;
  schemas?: string[];
  timezone?: string;
  title?: string;
  urn:ietf:params:scim:schemas:extension:enterprise:2.0:User?: {
   [key: string]: unknown;
     department?: string;
     organization?: string;
  };
  urn:scim:schemas:extension:atlassian-external:1.0?: {
   [key: string]: unknown;
     atlassianAccountId?: string;
  };
  userName?: string;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `active?`: `boolean`; `attributes?`: `string`; `department?`: `string`; `directoryId`: `string`; `displayName?`: `string`; `emails?`: `object`[]; `excludedAttributes?`: `string`; `externalId?`: `string`; `groups?`: `object`[]; `id?`: `string`; `meta?`: { `created?`: `unknown`; `lastModified?`: `unknown`; `location?`: `string`; `resourceType?`: `string` & `object` \| `"USER"` \| `"GROUP"` \| `"DIRECTORY"`; }; `name?`: { `familyName?`: `string`; `formatted?`: `string`; `givenName?`: `string`; `honorificPrefix?`: `string`; `honorificSuffix?`: `string`; `middleName?`: `string`; }; `nickName?`: `string`; `organization?`: `string`; `phoneNumbers?`: `object`[]; `preferredLanguage?`: `string`; `schemas?`: `string`[]; `timezone?`: `string`; `title?`: `string`; `urn:ietf:params:scim:schemas:extension:enterprise:2.0:User?`: { `department?`: `string`; `organization?`: `string`; }; `urn:scim:schemas:extension:atlassian-external:1.0?`: { `atlassianAccountId?`: `string`; }; `userId`: `string`; `userName?`: `string`; }	-
`parameters.active?`	`boolean`	A boolean value indicating the user's administrative status. This value will default to true if not provided.
`parameters.attributes?`	`string`	Resource attributes to be included in the response. Mutually exclusive from `excludedAttributes`. Example: `userName,emails.value`
`parameters.department?`	`string`	User's department.
`parameters.directoryId?`	`string`	The SCIM base URL that is generated when conecting an identity provider with SCIM provisioning.
`parameters.displayName?`	`string`	User's display name.
`parameters.emails?`	`object`[]	Email addresses of the User. This is a required field during user creation or modification. One value must be marked as primary.
`parameters.excludedAttributes?`	`string`	Resource attributes to be excluded in the response. Mutually exclusive from `attributes`. Example: `timezone,emails.type,department`
`parameters.externalId?`	`string`	Identifier defined by provisioning client. This is a case-sensitive field. Uniqueness is controlled by client.
`parameters.groups?`	`object`[]	Groups to which the user is associated in SCIM.
`parameters.id?`	`string`	Unique identifier defined by Atlassian SCIM Service. CaseExact. This is a read-only field and will be disregarded if included in the payload during user creation or modification..
`parameters.meta?`	{ `created?`: `unknown`; `lastModified?`: `unknown`; `location?`: `string`; `resourceType?`: `string` & `object` \| `"USER"` \| `"GROUP"` \| `"DIRECTORY"`; }	-
`parameters.meta.created?`	`unknown`	The DateTime that the resource was added to Atlassian SCIM service. This is a read-only field.
`parameters.meta.lastModified?`	`unknown`	The most recent DateTime that the details of this resource were updated. This is a read-only field.
`parameters.meta.location?`	`string`	The URI of the resource being returned. This is a read-only field.
`parameters.meta.resourceType?`	`string` & `object` \| `"USER"` \| `"GROUP"` \| `"DIRECTORY"`	The name of the resource type of the resource. This is a read-only and case-sensitive field.
`parameters.name?`	{ `familyName?`: `string`; `formatted?`: `string`; `givenName?`: `string`; `honorificPrefix?`: `string`; `honorificSuffix?`: `string`; `middleName?`: `string`; }	-
`parameters.name.familyName?`	`string`	The family name of the User.
`parameters.name.formatted?`	`string`	The full name, including all middle names, titles, and suffixes as appropriate, formatted for display.
`parameters.name.givenName?`	`string`	The given name of the User.
`parameters.name.honorificPrefix?`	`string`	The honorific prefix(es) of the User, or title in most Western languages.
`parameters.name.honorificSuffix?`	`string`	The honorific suffix(es) of the User, or suffix in most Western languages.
`parameters.name.middleName?`	`string`	The middle name(s) of the User.
`parameters.nickName?`	`string`	User's nickname.
`parameters.organization?`	`string`	User's organization.
`parameters.phoneNumbers?`	`object`[]	Phone numbers of the user.
`parameters.preferredLanguage?`	`string`	User's preferred language.
`parameters.schemas?`	`string`[]	SCIM schemas that define the attributes present in the current JSON structure This is a required field during user creation or modification.
`parameters.timezone?`	`string`	User's timezone. e.g. America/Los_Angeles .
`parameters.title?`	`string`	User's title.
`parameters.urn:ietf:params:scim:schemas:extension:enterprise:2.0:User?`	{ `department?`: `string`; `organization?`: `string`; }	-
`parameters.urn:ietf:params:scim:schemas:extension:enterprise:2.0:User.department?`	`string`	Department the user belongs to.
`parameters.urn:ietf:params:scim:schemas:extension:enterprise:2.0:User.organization?`	`string`	Organization the user belongs to.
`parameters.urn:scim:schemas:extension:atlassian-external:1.0?`	{ `atlassianAccountId?`: `string`; }	-
`parameters.urn:scim:schemas:extension:atlassian-external:1.0.atlassianAccountId?`	`string`	-
`parameters.userId?`	`string`	Unique ID to identiy the users. Use the Get users API to get the userId.
`parameters.userName?`	`string`	Unique identifier defined by the provisioning client. Atlassian SCIM service will verify the value and guarantee its uniqueness. This is a required field during user creation or modification.
`options?`	`RequestOptions`	-

Function: createUserProvisioningClient() ​

Parameters ​

Returns ​

groups ​

groups.createGroup ​

Parameters ​

Returns ​

groups.deleteGroup ​

Parameters ​

Returns ​

groups.getGroup ​

Parameters ​

Returns ​

groups.getGroups ​

Parameters ​

Returns ​

groups.patchGroup ​

Parameters ​

Returns ​

groups.replaceGroup ​

Parameters ​

Returns ​

schemas ​

schemas.getExtensionUserSchemas ​

Parameters ​

Returns ​

schemas.getGroupSchemas ​

Parameters ​

Returns ​

schemas.getSchemas ​

Parameters ​

Returns ​

schemas.getUserSchemas ​

Parameters ​

Returns ​

scimLinks ​

scimLinks.deleteProvisioningRecord ​

Parameters ​

Returns ​

scimLinks.getScimLinks ​

Parameters ​

Returns ​

scimLinks.getScimLinksByEmail ​

Parameters ​

Returns ​

scimLinks.unlinkScimUser ​

Parameters ​

Returns ​

serviceProviderConfiguration ​

serviceProviderConfiguration.getGroupResourceType ​

Parameters ​

Returns ​

serviceProviderConfiguration.getResourceTypes ​

Parameters ​

Returns ​

serviceProviderConfiguration.getServiceProviderConfig ​

Parameters ​

Returns ​

serviceProviderConfiguration.getUserResourceType ​

Parameters ​

Returns ​

users ​

users.createUser ​

Parameters ​

Returns ​

users.deleteUser ​

Parameters ​

Returns ​

users.getUser ​

Parameters ​

Returns ​

users.getUsers ​

Parameters ​

Returns ​

users.patchUser ​

Parameters ​

Returns ​

users.replaceUser ​

Parameters ​

Returns ​

Function: createUserProvisioningClient()

Parameters

Returns

groups

groups.createGroup

Parameters

Returns

groups.deleteGroup

Parameters

Returns

groups.getGroup

Parameters

Returns

groups.getGroups

Parameters

Returns

groups.patchGroup

Parameters

Returns

groups.replaceGroup

Parameters

Returns

schemas

schemas.getExtensionUserSchemas

Parameters

Returns

schemas.getGroupSchemas

Parameters

Returns

schemas.getSchemas

Parameters

Returns

schemas.getUserSchemas

Parameters

Returns

scimLinks

scimLinks.deleteProvisioningRecord

Parameters

Returns

scimLinks.getScimLinks

Parameters

Returns

scimLinks.getScimLinksByEmail

Parameters

Returns

scimLinks.unlinkScimUser

Parameters

Returns

serviceProviderConfiguration

serviceProviderConfiguration.getGroupResourceType

Parameters

Returns

serviceProviderConfiguration.getResourceTypes

Parameters

Returns

serviceProviderConfiguration.getServiceProviderConfig

Parameters

Returns

serviceProviderConfiguration.getUserResourceType

Parameters

Returns

users

users.createUser

Parameters

Returns

users.deleteUser

Parameters

Returns

users.getUser

Parameters

Returns

users.getUsers

Parameters

Returns

users.patchUser

Parameters

Returns

users.replaceUser

Parameters

Returns