Function: createUserManagementClient()

function createUserManagementClient(config): object;

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

Parameters

Parameter	Type
config	UserManagementClientConfig

Returns

object

apiTokens

apiTokens: object;

apiTokens.deleteApiToken

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

Parameters

Parameter	Type	Description
parameters	{ accountId: string; tokenId: string; }	-
parameters.accountId	string	The ID of the user
parameters.tokenId?	string	The ID of the API token
options?	RequestOptions	-

Returns

Promise<void>

apiTokens.getApiTokens

getApiTokens: (parameters, options?) => Promise<object[]>;

Parameters

Parameter	Type	Description
parameters	{ accountId: string; }	-
parameters.accountId	string	The ID of the user
options?	RequestOptions	-

Returns

Promise<object[]>

email

email: object;

email.setEmail

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

Parameters

Parameter	Type	Description
parameters	{ accountId: string; email: string; }	-
parameters.accountId	string	The ID of the user
parameters.email?	string	-
options?	RequestOptions	-

Returns

Promise<void>

lifecycle

lifecycle: object;

lifecycle.activateUser

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

Parameters

Parameter	Type	Description
parameters	{ accountId: string; }	-
parameters.accountId	string	The unique identifier of the user to activate.
options?	RequestOptions	-

Returns

Promise<void>

lifecycle.cancelAccountDeletion

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

Parameters

Parameter	Type	Description
parameters	{ accountId: string; }	-
parameters.accountId	string	Unique ID of the user's account that you are deleting. Use the Get users in an organization API to get the accountId.
options?	RequestOptions	-

Returns

Promise<void>

lifecycle.deactivateUser

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

Parameters

Parameter	Type	Description
parameters	{ accountId: string; message?: string; }	-
parameters.accountId	string	The ID of the user
parameters.message?	string	-
options?	RequestOptions	-

Returns

Promise<void>

lifecycle.deleteAccount

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

Parameters

Parameter	Type	Description
parameters	{ accountId: string; }	-
parameters.accountId	string	Unique ID of the user's account that you are deleting. Use the Get users in an organization API to get the accountId.
options?	RequestOptions	-

Returns

Promise<void>

manage

manage: object;

manage.getManagementPermissions

getManagementPermissions: (parameters, options?) => Promise<{
[key: string]: unknown;
  apiToken.delete?:   | {
   [key: string]: unknown;
     allowed: true;
   }
     | {
   [key: string]: unknown;
     allowed: false;
     reason: {
      [key: string]: unknown;
        key:   | string & object
           | "administrative"
           | "administrative.notMyself"
           | "authPolicy.saml"
           | "blocked.exportControl"
           | "externalDirectory.scim"
           | "externalDirectory.google"
           | "myselfOnly"
           | "managedAccount";
     };
   };
  apiToken.read?:   | {
   [key: string]: unknown;
     allowed: true;
   }
     | {
   [key: string]: unknown;
     allowed: false;
     reason: {
      [key: string]: unknown;
        key:   | string & object
           | "administrative"
           | "administrative.notMyself"
           | "authPolicy.saml"
           | "blocked.exportControl"
           | "externalDirectory.scim"
           | "externalDirectory.google"
           | "myselfOnly"
           | "managedAccount";
     };
   };
  email.set?:   | {
   [key: string]: unknown;
     allowed: true;
   }
     | {
   [key: string]: unknown;
     allowed: false;
     reason: {
      [key: string]: unknown;
        key:   | string & object
           | "administrative"
           | "administrative.notMyself"
           | "authPolicy.saml"
           | "blocked.exportControl"
           | "externalDirectory.scim"
           | "externalDirectory.google"
           | "myselfOnly"
           | "managedAccount";
     };
   };
  lifecycle.delete?:   | {
   [key: string]: unknown;
     allowed: true;
   }
     | {
   [key: string]: unknown;
     allowed: false;
     reason: {
      [key: string]: unknown;
        key:   | string & object
           | "administrative"
           | "administrative.notMyself"
           | "authPolicy.saml"
           | "blocked.exportControl"
           | "externalDirectory.scim"
           | "externalDirectory.google"
           | "myselfOnly"
           | "managedAccount";
     };
   };
  lifecycle.enablement?:   | {
   [key: string]: unknown;
     allowed: true;
   }
     | {
   [key: string]: unknown;
     allowed: false;
     reason: {
      [key: string]: unknown;
        key:   | string & object
           | "administrative"
           | "administrative.notMyself"
           | "authPolicy.saml"
           | "blocked.exportControl"
           | "externalDirectory.scim"
           | "externalDirectory.google"
           | "myselfOnly"
           | "managedAccount";
     };
   };
  profile?: Record<string, 
     | {
   [key: string]: unknown;
     allowed: true;
   }
     | {
   [key: string]: unknown;
     allowed: false;
     reason: {
      [key: string]: unknown;
        key: ... | ... | ... | ... | ... | ... | ... | ... | ...;
     };
  }>;
  profile.read?:   | {
   [key: string]: unknown;
     allowed: true;
   }
     | {
   [key: string]: unknown;
     allowed: false;
     reason: {
      [key: string]: unknown;
        key:   | string & object
           | "administrative"
           | "administrative.notMyself"
           | "authPolicy.saml"
           | "blocked.exportControl"
           | "externalDirectory.scim"
           | "externalDirectory.google"
           | "myselfOnly"
           | "managedAccount";
     };
   };
  profile.write?: Record<string, 
     | {
   [key: string]: unknown;
     allowed: true;
   }
     | {
   [key: string]: unknown;
     allowed: false;
     reason: {
      [key: string]: unknown;
        key: ... | ... | ... | ... | ... | ... | ... | ... | ...;
     };
  }>;
}>;

Parameters

Parameter	Type	Description
parameters	{ accountId: string; privileges?: ( | string & object | "profile" | "profile.write" | "profile.read" | "email.set" | "lifecycle.enablement" | "lifecycle.delete" | "apiToken.read" | "apiToken.delete")[]; }	-
parameters.accountId	string	The user account to manage
parameters.privileges?	( | string & object | "profile" | "profile.write" | "profile.read" | "email.set" | "lifecycle.enablement" | "lifecycle.delete" | "apiToken.read" | "apiToken.delete")[]	-
options?	RequestOptions	-

Returns

Promise<{ [key: string]: unknown; apiToken.delete?: | { [key: string]: unknown; allowed: true; } | { [key: string]: unknown; allowed: false; reason: { [key: string]: unknown; key: | string & object | "administrative" | "administrative.notMyself" | "authPolicy.saml" | "blocked.exportControl" | "externalDirectory.scim" | "externalDirectory.google" | "myselfOnly" | "managedAccount"; }; }; apiToken.read?: | { [key: string]: unknown; allowed: true; } | { [key: string]: unknown; allowed: false; reason: { [key: string]: unknown; key: | string & object | "administrative" | "administrative.notMyself" | "authPolicy.saml" | "blocked.exportControl" | "externalDirectory.scim" | "externalDirectory.google" | "myselfOnly" | "managedAccount"; }; }; email.set?: | { [key: string]: unknown; allowed: true; } | { [key: string]: unknown; allowed: false; reason: { [key: string]: unknown; key: | string & object | "administrative" | "administrative.notMyself" | "authPolicy.saml" | "blocked.exportControl" | "externalDirectory.scim" | "externalDirectory.google" | "myselfOnly" | "managedAccount"; }; }; lifecycle.delete?: | { [key: string]: unknown; allowed: true; } | { [key: string]: unknown; allowed: false; reason: { [key: string]: unknown; key: | string & object | "administrative" | "administrative.notMyself" | "authPolicy.saml" | "blocked.exportControl" | "externalDirectory.scim" | "externalDirectory.google" | "myselfOnly" | "managedAccount"; }; }; lifecycle.enablement?: | { [key: string]: unknown; allowed: true; } | { [key: string]: unknown; allowed: false; reason: { [key: string]: unknown; key: | string & object | "administrative" | "administrative.notMyself" | "authPolicy.saml" | "blocked.exportControl" | "externalDirectory.scim" | "externalDirectory.google" | "myselfOnly" | "managedAccount"; }; }; profile?: Record<string, | { [key: string]: unknown; allowed: true; } | { [key: string]: unknown; allowed: false; reason: { [key: string]: unknown; key: ... | ... | ... | ... | ... | ... | ... | ... | ...; }; }>; profile.read?: | { [key: string]: unknown; allowed: true; } | { [key: string]: unknown; allowed: false; reason: { [key: string]: unknown; key: | string & object | "administrative" | "administrative.notMyself" | "authPolicy.saml" | "blocked.exportControl" | "externalDirectory.scim" | "externalDirectory.google" | "myselfOnly" | "managedAccount"; }; }; profile.write?: Record<string, | { [key: string]: unknown; allowed: true; } | { [key: string]: unknown; allowed: false; reason: { [key: string]: unknown; key: ... | ... | ... | ... | ... | ... | ... | ... | ...; }; }>; }>

profile

profile: object;

profile.getProfile

getProfile: (parameters, options?) => Promise<{
[key: string]: unknown;
  account: {
   [key: string]: unknown;
     account_id: string;
     account_status: "active" | "inactive" | "closed" | string & object;
     account_type: string & object | "atlassian" | "app" | "customer";
     characteristics?: {
      [key: string]: unknown;
        not_mentionable?: boolean;
     };
     email: string;
     extended_profile?: {
      [key: string]: unknown;
        department?: string;
        job_title?: string;
        location?: string;
        organization?: string;
     };
     locale?: string;
     name: string;
     nickname: string;
     picture: string;
     zoneinfo?: string;
  };
}>;

Parameters

Parameter	Type	Description
parameters	{ accountId: string; }	-
parameters.accountId	string	The ID of the user
options?	RequestOptions	-

Returns

Promise<{ [key: string]: unknown; account: { [key: string]: unknown; account_id: string; account_status: "active" | "inactive" | "closed" | string & object; account_type: string & object | "atlassian" | "app" | "customer"; characteristics?: { [key: string]: unknown; not_mentionable?: boolean; }; email: string; extended_profile?: { [key: string]: unknown; department?: string; job_title?: string; location?: string; organization?: string; }; locale?: string; name: string; nickname: string; picture: string; zoneinfo?: string; }; }>

profile.updateProfile

updateProfile: (parameters, options?) => Promise<{
[key: string]: unknown;
  account: {
   [key: string]: unknown;
     account_id: string;
     account_status: "active" | "inactive" | "closed" | string & object;
     account_type: string & object | "atlassian" | "app" | "customer";
     characteristics?: {
      [key: string]: unknown;
        not_mentionable?: boolean;
     };
     email: string;
     extended_profile?: {
      [key: string]: unknown;
        department?: string;
        job_title?: string;
        location?: string;
        organization?: string;
     };
     locale?: string;
     name: string;
     nickname: string;
     picture: string;
     zoneinfo?: string;
  };
}>;

Parameters

Parameter	Type	Description
parameters	{ accountId: string; extended_profile?: { department?: string; job_title?: string; location?: string; organization?: string; }; locale?: string; name?: string; nickname?: string; zoneinfo?: string; }	-
parameters.accountId	string	The ID of the user to update
parameters.extended_profile?	{ department?: string; job_title?: string; location?: string; organization?: string; }	-
parameters.extended_profile.department?	string	-
parameters.extended_profile.job_title?	string	-
parameters.extended_profile.location?	string	-
parameters.extended_profile.organization?	string	-
parameters.locale?	string	-
parameters.name?	string	-
parameters.nickname?	string	-
parameters.zoneinfo?	string	-
options?	RequestOptions	-

Returns

Promise<{ [key: string]: unknown; account: { [key: string]: unknown; account_id: string; account_status: "active" | "inactive" | "closed" | string & object; account_type: string & object | "atlassian" | "app" | "customer"; characteristics?: { [key: string]: unknown; not_mentionable?: boolean; }; email: string; extended_profile?: { [key: string]: unknown; department?: string; job_title?: string; location?: string; organization?: string; }; locale?: string; name: string; nickname: string; picture: string; zoneinfo?: string; }; }>