jira.js

English

Русский

English

Русский

Appearance

Function: createAdminClient() ​

ts
function createAdminClient(config): object;

Defined in: src/admin/createAdminClient.ts:107

Parameters ​

ParameterType
configAdminClientConfig

Returns ​

object

directory ​

ts
directory: object;

directory.getDirectoriesForOrg ​

ts
getDirectoriesForOrg: (parameters, options?) => Promise<{
[key: string]: unknown;
  data?: object[];
  links?: {
   [key: string]: unknown;
     next?: string | null;
     prev?: string | null;
     self?: string | null;
  };
}>;
Parameters ​
ParameterTypeDescription
parameters{ accountId?: string; cursor?: string; directoryIds?: string[]; limit?: number; orgId: string; searchTerm?: string; }-
parameters.accountId?stringFilters the results to only the directories where the specified user is a member.
parameters.cursor?stringSets the cursor position to retrieve the next set of results. If present, all other parameters are discarded when searching.
parameters.directoryIds?string[]A list of directory IDs. The requestor must have permissions to administer resources linked to these directories.
parameters.limit?numberThe desired number of results for the search request.
parameters.orgId?stringYour organization has a unique ID. Find this ID in your Atlassian Administration URL or when you create your API key.
parameters.searchTerm?stringA search term to search the name field.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; data?: object[]; links?: { [key: string]: unknown; next?: string | null; prev?: string | null; self?: string | null; }; }>

domains ​

ts
domains: object;

domains.getDomainById ​

ts
getDomainById: (parameters, options?) => Promise<{
[key: string]: unknown;
  data?: {
   [key: string]: unknown;
     attributes: {
      [key: string]: unknown;
        claim?: {
         [key: string]: unknown;
           status?: ... | ... | ... | ... | ... | ... | ...;
           type?: ... | ... | ... | ...;
        };
        name?: string;
     };
     id: string;
     links: {
      [key: string]: unknown;
        self: string | null;
     };
     type: string & object | "domains";
  };
}>;
Parameters ​
ParameterTypeDescription
parameters{ domainId: string; orgId: string; }-
parameters.domainIdstringID of the domain to return
parameters.orgId?stringYour organization has a unique ID. Find this ID in your Atlassian Administration URL or when you create your API key.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; data?: { [key: string]: unknown; attributes: { [key: string]: unknown; claim?: { [key: string]: unknown; status?: ... | ... | ... | ... | ... | ... | ...; type?: ... | ... | ... | ...; }; name?: string; }; id: string; links: { [key: string]: unknown; self: string | null; }; type: string & object | "domains"; }; }>

domains.getDomains ​

ts
getDomains: (parameters, options?) => Promise<{
[key: string]: unknown;
  data?: object[];
  links?: {
   [key: string]: unknown;
     next?: string | null;
     prev?: string | null;
     self?: string | null;
  };
}>;
Parameters ​
ParameterTypeDescription
parameters{ cursor?: string; orgId: string; }-
parameters.cursor?stringSets the starting point for the page of results to return.
parameters.orgId?stringYour organization has a unique ID. Find this ID in your Atlassian Administration URL or when you create your API key.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; data?: object[]; links?: { [key: string]: unknown; next?: string | null; prev?: string | null; self?: string | null; }; }>

events ​

ts
events: object;

events.getEventActions ​

ts
getEventActions: (parameters, options?) => Promise<{
[key: string]: unknown;
  data?: object[];
  links?: Record<string, any>;
  meta?: unknown;
}>;
Parameters ​
ParameterTypeDescription
parameters{ orgId: string; }-
parameters.orgIdstringYour organization has a unique ID. Find this ID in your Atlassian Administration URL or when you create your API key.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; data?: object[]; links?: Record<string, any>; meta?: unknown; }>

events.getEventById ​

ts
getEventById: (parameters, options?) => Promise<{
[key: string]: unknown;
  data?: {
   [key: string]: unknown;
     attributes: {
      [key: string]: unknown;
        action: string;
        actor: {
         [key: string]: unknown;
           app?: {
            [key: ...]: ...;
              attributes?: ...;
              id: ...;
              type?: ...;
           };
           auth?: {
            [key: ...]: ...;
              authType: ...;
              tokenId?: ...;
              tokenLabel?: ...;
           };
           email?: string;
           id: string;
           links?: {
            [key: ...]: ...;
              self: ...;
           };
           name?: string;
           onBehalfOf?: {
            [key: ...]: ...;
              email?: ...;
              id: ...;
              name?: ...;
           };
        };
        container?: object[];
        context: object[];
        location?: {
         [key: string]: unknown;
           city?: ... | ...;
           countryName?: ... | ...;
           geo?: ... | ...;
           ip?: ... | ...;
           regionName?: ... | ...;
        };
        time: Date;
     };
     id: string;
     links: {
      [key: string]: unknown;
        self: string | null;
     };
     message?: {
      [key: string]: unknown;
        content?: string;
        format?: string;
     };
     type: string & object | "events";
  };
}>;
Parameters ​
ParameterTypeDescription
parameters{ eventId: string; orgId: string; }-
parameters.eventIdstringID of the event to return
parameters.orgId?stringYour organization has a unique ID. Find this ID in your Atlassian Administration URL or when you create your API key.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; data?: { [key: string]: unknown; attributes: { [key: string]: unknown; action: string; actor: { [key: string]: unknown; app?: { [key: ...]: ...; attributes?: ...; id: ...; type?: ...; }; auth?: { [key: ...]: ...; authType: ...; tokenId?: ...; tokenLabel?: ...; }; email?: string; id: string; links?: { [key: ...]: ...; self: ...; }; name?: string; onBehalfOf?: { [key: ...]: ...; email?: ...; id: ...; name?: ...; }; }; container?: object[]; context: object[]; location?: { [key: string]: unknown; city?: ... | ...; countryName?: ... | ...; geo?: ... | ...; ip?: ... | ...; regionName?: ... | ...; }; time: Date; }; id: string; links: { [key: string]: unknown; self: string | null; }; message?: { [key: string]: unknown; content?: string; format?: string; }; type: string & object | "events"; }; }>

events.getEvents ​

ts
getEvents: (parameters, options?) => Promise<{
[key: string]: unknown;
  data?: object[];
  links?: {
   [key: string]: unknown;
     next?: string | null;
     prev?: string | null;
     self?: string | null;
  };
  meta?: {
   [key: string]: unknown;
     attributes?: unknown;
     count?: number;
     current?: number;
     end_index?: number;
     next?: string | null;
     page_size?: number;
     prev?: string;
     start_index?: number;
     total?: number;
  };
}>;
Parameters ​
ParameterTypeDescription
parameters{ action?: string; actor?: string[]; cursor?: string; from?: string; ip?: string[]; limit?: number; location?: string; orgId: string; product?: ( | "jira" | string & object | "confluence" | "bitbucket" | "guard_detect" | "loom")[]; q?: string; to?: string; }-
parameters.action?stringA query filter that returns events of a specific action type.
parameters.actor?string[]A query filter that returns events by one or more specific actors.
parameters.cursor?stringSets the starting point for the page of results to return
parameters.from?stringThe earliest date and time of the event represented as a UNIX epoch time in milliseconds.
parameters.ip?string[]A query filter that returns events by one or more specific ip addresses.
parameters.limit?numberThe maximum number of events to return per page.
parameters.location?stringA query filter that returns events by one or more specific locations. Of format: [ { "city": "<CityName>", "countryName": "<CountryName>" }, ... ]
parameters.orgId?stringYour organization has a unique ID. Find this ID in your Atlassian Administration URL or when you create your API key.
parameters.product?( | "jira" | string & object | "confluence" | "bitbucket" | "guard_detect" | "loom")[]A query filter that returns events by one or more specific products.
parameters.q?stringSingle query term for searching events.
parameters.to?stringThe latest date and time of the event represented as a UNIX epoch time in milliseconds.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; data?: object[]; links?: { [key: string]: unknown; next?: string | null; prev?: string | null; self?: string | null; }; meta?: { [key: string]: unknown; attributes?: unknown; count?: number; current?: number; end_index?: number; next?: string | null; page_size?: number; prev?: string; start_index?: number; total?: number; }; }>

events.pollEvents ​

ts
pollEvents: (parameters, options?) => Promise<{
[key: string]: unknown;
  data?: object[];
  links?: {
   [key: string]: unknown;
     next?: string | null;
     prev?: string | null;
     self?: string | null;
  };
  meta?: {
   [key: string]: unknown;
     next?: string;
     page_size?: number;
  };
}>;
Parameters ​
ParameterTypeDescription
parameters{ cursor?: string; from?: string; limit?: number; orgId: string; sortOrder?: "desc" | string & object | "asc"; to?: string; }-
parameters.cursor?stringSets the starting point for the page of results to return. Can be used when last page is reached to poll for new events. The sort order is maintained in the cursor across requests.
parameters.from?stringThe earliest date and time of the event represented as a UNIX epoch time in milliseconds.
parameters.limit?numberThe maximum number of events to return per page.
parameters.orgId?stringYour organization has a unique ID. Find this ID in your Atlassian Administration URL or when you create your API key.
parameters.sortOrder?"desc" | string & object | "asc"The order used to sort events by processing time. Defaults to ascending.
parameters.to?stringThe latest date and time of the event represented as a UNIX epoch time in milliseconds.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; data?: object[]; links?: { [key: string]: unknown; next?: string | null; prev?: string | null; self?: string | null; }; meta?: { [key: string]: unknown; next?: string; page_size?: number; }; }>

groups ​

ts
groups: object;

groups.addUserToGroup ​

ts
addUserToGroup: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ accountId: string; directoryId: string; groupId: string; orgId: string; }-
parameters.accountIdstringEvery user has a unique ID. Find a user’s account ID by using the Get users endpoint.
parameters.directoryId?stringA directory has a unique ID. Use the Get directories endpoint to find the directory ID.
parameters.groupId?stringA group has a unique ID. Use the Get groups endpoint to find the group ID.
parameters.orgId?stringYour organization has a unique ID. Find this ID in your Atlassian Administration URL or when you create your API key.
options?RequestOptions-
Returns ​

Promise<void>

groups.createGroup ​

ts
createGroup: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ description?: string; directoryId: string; name: string; orgId: string; }-
parameters.description?stringDescribe what the group is or what it might be used for.
parameters.directoryId?stringA directory has a unique ID. Use the Get directories endpoint to find the directory ID.
parameters.name?stringName the group.
parameters.orgId?stringYour organization has a unique ID. Find this ID in your Atlassian Administration URL or when you create your API key.
options?RequestOptions-
Returns ​

Promise<void>

groups.deleteGroup ​

ts
deleteGroup: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ directoryId: string; groupId: string; orgId: string; }-
parameters.directoryIdstringA directory has a unique ID. Use the Get directories endpoint to find the directory ID.
parameters.groupId?stringA group has a unique ID. Use the Get groups endpoint to find the group ID.
parameters.orgId?stringYour organization has a unique ID. Find this ID in your Atlassian Administration URL or when you create your API key.
options?RequestOptions-
Returns ​

Promise<void>

groups.getGroup ​

ts
getGroup: (parameters, options?) => Promise<{
[key: string]: unknown;
  data?: {
   [key: string]: unknown;
     counts?: {
      [key: string]: unknown;
        resources?: number;
        users?: number;
     };
     description?: string;
     directoryId?: string;
     externalSynced?: boolean;
     id?: string;
     links?: {
      [key: string]: unknown;
        self?: string | null;
     };
     managedBy?: string;
     managementAccess?: {
      [key: string]: unknown;
        deletable?: boolean;
        modifiable?: boolean;
        readable?: boolean;
     };
     name?: string;
  };
}>;
Parameters ​
ParameterTypeDescription
parameters{ directoryId: string; groupId: string; orgId: string; }-
parameters.directoryIdstringUnique ID associated with a directory. The - character can be used to increase the operation scope to all directories the requestor has permission to manage.
parameters.groupId?stringUnique ID associated with a group.
parameters.orgId?stringYour organization has a unique ID. Find this ID in your Atlassian Administration URL or when you create your API key.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; data?: { [key: string]: unknown; counts?: { [key: string]: unknown; resources?: number; users?: number; }; description?: string; directoryId?: string; externalSynced?: boolean; id?: string; links?: { [key: string]: unknown; self?: string | null; }; managedBy?: string; managementAccess?: { [key: string]: unknown; deletable?: boolean; modifiable?: boolean; readable?: boolean; }; name?: string; }; }>

groups.getGroupRoleAssignments ​

ts
getGroupRoleAssignments: (parameters, options?) => Promise<{
[key: string]: unknown;
  data?: object[];
  links?: {
   [key: string]: unknown;
     next?: string | null;
     prev?: string | null;
     self?: string | null;
  };
}>;
Parameters ​
ParameterTypeDescription
parameters{ cursor?: string; directoryId: string; directoryIds?: string[]; groupId: string; limit?: number; orgId: string; resourceIds?: string[]; resourceOwners?: string[]; roleIds?: ( | string & object | "atlassian/org-admin" | "atlassian/site-admin" | "atlassian/user-access-admin" | "atlassian/ai-access" | "atlassian/user" | "atlassian/admin" | "atlassian/guest" | "atlassian/customer" | "atlassian/contributor" | "atlassian/basic" | "atlassian/stakeholder")[]; }-
parameters.cursor?stringSets the cursor position to retrieve the next set of results. If present, all other parameters are discarded when searching.
parameters.directoryId?stringUnique ID associated with a directory. The - character can be used to increase the operation scope to all directories the requestor has permission to manage.
parameters.directoryIds?string[]A list of directory IDs. The requestor must have permissions to administer resources linked to these directories.
parameters.groupId?stringUnique ID associated with a group.
parameters.limit?numberThe desired number of results for the search request.
parameters.orgId?stringYour organization has a unique ID. Find this ID in your Atlassian Administration URL or when you create your API key.
parameters.resourceIds?string[]A list of resource IDs. The resource IDs should be specified using the Atlassian Resource Identifier (ARI) format. Example ARI: ari:cloud:jira-core::site/1
parameters.resourceOwners?string[]The list of resource owners to filter the results by. Used to identify resources using their owner to which the user has at least one role assigned to.
parameters.roleIds?( | string & object | "atlassian/org-admin" | "atlassian/site-admin" | "atlassian/user-access-admin" | "atlassian/ai-access" | "atlassian/user" | "atlassian/admin" | "atlassian/guest" | "atlassian/customer" | "atlassian/contributor" | "atlassian/basic" | "atlassian/stakeholder")[]A list of role IDs. The Atlassian canonical roles are used to determine the permissions of the user against resources within the organization. The allowed roles are: - atlassian/user - Can access the product, with no product admin permissions - atlassian/admin - Can access the product, with product admin permissions - atlassian/guest - Can only access one space you or space admins specify - atlassian/customer - (Jira Service Management) Can visit help center, submit help requests, and view articles (non-billable) - atlassian/user-access-admin - No product access. Can administer users and groups for this product in Atlassian Administration - atlassian/contributor - Can access the product to view, comment, and vote only (non-billable) - atlassian/basic - Can access basic product features, with no product admin permissions (non-billable) - atlassian/stakeholder - Can receive incident updates and has the same product access as Customer. Non-billable but available only on Premium and Enterprise plans - atlassian/org-admin - An organization admin is the highest level of admin and can complete any administrative task in Atlassian Administration - atlassian/site-admin - Site admins can access Atlassian Administration and complete tasks related to the specific site they are administering. - atlassian/ai-access - Can use AI features in AI-enabled apps they have access to.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; data?: object[]; links?: { [key: string]: unknown; next?: string | null; prev?: string | null; self?: string | null; }; }>

groups.getGroups ​

ts
getGroups: (parameters, options?) => Promise<{
[key: string]: unknown;
  data?: object[];
  links?: {
   [key: string]: unknown;
     next?: string | null;
     prev?: string | null;
     self?: string | null;
  };
}>;
Parameters ​
ParameterTypeDescription
parameters{ accountIds?: string[]; counts?: { includeResources?: boolean; includeUsers?: boolean; }; cursor?: string; directoryId: string; directoryIds?: string[]; groupIds?: string[]; limit?: number; orgId: string; resourceIds?: string[]; resourceOwners?: string[]; roleIds?: ( | string & object | "atlassian/org-admin" | "atlassian/site-admin" | "atlassian/user-access-admin" | "atlassian/ai-access" | "atlassian/user" | "atlassian/admin" | "atlassian/guest" | "atlassian/customer" | "atlassian/contributor" | "atlassian/basic" | "atlassian/stakeholder")[]; searchTerm?: string; sortBy?: object[]; }-
parameters.accountIds?string[]A list of user account IDs.
parameters.counts?{ includeResources?: boolean; includeUsers?: boolean; }Whether to include counts of different objects associated with the group.
parameters.counts.includeResources?booleanWhether to include the number of resources associated with the group.
parameters.counts.includeUsers?booleanWhether to include the number of users associated with the group.
parameters.cursor?stringSets the cursor position to retrieve the next set of results. If present, all other parameters are discarded when searching.
parameters.directoryId?stringUnique ID associated with a directory. The - character can be used to increase the operation scope to all directories the requestor has permission to manage.
parameters.directoryIds?string[]A list of directory IDs. The requestor must have permissions to administer resources linked to these directories.
parameters.groupIds?string[]A list of group IDs.
parameters.limit?numberThe desired number of results for the search request.
parameters.orgId?stringYour organization has a unique ID. Find this ID in your Atlassian Administration URL or when you create your API key.
parameters.resourceIds?string[]A list of resource IDs. The resource IDs should be specified using the Atlassian Resource Identifier (ARI) format. Example ARI: ari:cloud:jira-core::site/1
parameters.resourceOwners?string[]The list of resource owners to filter the results by. Used to identify resources using their owner to which the user has at least one role assigned to.
parameters.roleIds?( | string & object | "atlassian/org-admin" | "atlassian/site-admin" | "atlassian/user-access-admin" | "atlassian/ai-access" | "atlassian/user" | "atlassian/admin" | "atlassian/guest" | "atlassian/customer" | "atlassian/contributor" | "atlassian/basic" | "atlassian/stakeholder")[]A list of role IDs. The Atlassian canonical roles are used to determine the permissions of the user against resources within the organization. The allowed roles are: - atlassian/user - Can access the product, with no product admin permissions - atlassian/admin - Can access the product, with product admin permissions - atlassian/guest - Can only access one space you or space admins specify - atlassian/customer - (Jira Service Management) Can visit help center, submit help requests, and view articles (non-billable) - atlassian/user-access-admin - No product access. Can administer users and groups for this product in Atlassian Administration - atlassian/contributor - Can access the product to view, comment, and vote only (non-billable) - atlassian/basic - Can access basic product features, with no product admin permissions (non-billable) - atlassian/stakeholder - Can receive incident updates and has the same product access as Customer. Non-billable but available only on Premium and Enterprise plans - atlassian/org-admin - An organization admin is the highest level of admin and can complete any administrative task in Atlassian Administration - atlassian/site-admin - Site admins can access Atlassian Administration and complete tasks related to the specific site they are administering. - atlassian/ai-access - Can use AI features in AI-enabled apps they have access to.
parameters.searchTerm?stringA search term to search the name field.
parameters.sortBy?object[]The field and direction to sort the results by. Currently, only a single field can be sorted by. If null, the default sorting will be used.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; data?: object[]; links?: { [key: string]: unknown; next?: string | null; prev?: string | null; self?: string | null; }; }>

Deprecated ​

This API is deprecated and will no longer work after June 30, 2027. Use the Search for groups in an organization endpoint instead.

groups.getGroupsCount ​

ts
getGroupsCount: (parameters, options?) => Promise<{
[key: string]: unknown;
  count?: number;
}>;
Parameters ​
ParameterTypeDescription
parameters{ accountIds?: string[]; directoryId: string; directoryIds?: string[]; groupIds?: string[]; orgId: string; resourceIds?: string[]; resourceOwners?: string[]; roleIds?: ( | string & object | "atlassian/org-admin" | "atlassian/site-admin" | "atlassian/user-access-admin" | "atlassian/ai-access" | "atlassian/user" | "atlassian/admin" | "atlassian/guest" | "atlassian/customer" | "atlassian/contributor" | "atlassian/basic" | "atlassian/stakeholder")[]; searchTerm?: string; }-
parameters.accountIds?string[]A list of user account IDs.
parameters.directoryId?stringUnique ID associated with a directory. The - character can be used to increase the operation scope to all directories the requestor has permission to manage.
parameters.directoryIds?string[]A list of directory IDs. The requestor must have permissions to administer resources linked to these directories.
parameters.groupIds?string[]A list of group IDs.
parameters.orgId?stringYour organization has a unique ID. Find this ID in your Atlassian Administration URL or when you create your API key.
parameters.resourceIds?string[]A list of resource IDs. The resource IDs should be specified using the Atlassian Resource Identifier (ARI) format. Example ARI: ari:cloud:jira-core::site/1
parameters.resourceOwners?string[]The list of resource owners to filter the results by. Used to identify resources using their owner to which the user has at least one role assigned to.
parameters.roleIds?( | string & object | "atlassian/org-admin" | "atlassian/site-admin" | "atlassian/user-access-admin" | "atlassian/ai-access" | "atlassian/user" | "atlassian/admin" | "atlassian/guest" | "atlassian/customer" | "atlassian/contributor" | "atlassian/basic" | "atlassian/stakeholder")[]A list of role IDs. The Atlassian canonical roles are used to determine the permissions of the user against resources within the organization. The allowed roles are: - atlassian/user - Can access the product, with no product admin permissions - atlassian/admin - Can access the product, with product admin permissions - atlassian/guest - Can only access one space you or space admins specify - atlassian/customer - (Jira Service Management) Can visit help center, submit help requests, and view articles (non-billable) - atlassian/user-access-admin - No product access. Can administer users and groups for this product in Atlassian Administration - atlassian/contributor - Can access the product to view, comment, and vote only (non-billable) - atlassian/basic - Can access basic product features, with no product admin permissions (non-billable) - atlassian/stakeholder - Can receive incident updates and has the same product access as Customer. Non-billable but available only on Premium and Enterprise plans - atlassian/org-admin - An organization admin is the highest level of admin and can complete any administrative task in Atlassian Administration - atlassian/site-admin - Site admins can access Atlassian Administration and complete tasks related to the specific site they are administering. - atlassian/ai-access - Can use AI features in AI-enabled apps they have access to.
parameters.searchTerm?stringA search term to search the name field.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; count?: number; }>

groups.getGroupsStats ​

ts
getGroupsStats: (parameters, options?) => Promise<{
[key: string]: unknown;
  totals?: {
   [key: string]: unknown;
     all?: number;
     managed?: number;
     synced?: number;
  };
  types?: object[];
}>;
Parameters ​
ParameterTypeDescription
parameters{ directoryId: string; orgId: string; }-
parameters.directoryIdstringUnique ID associated with a directory. The - character can be used to increase the operation scope to all directories the requestor has permission to manage.
parameters.orgId?stringYour organization has a unique ID. Find this ID in your Atlassian Administration URL or when you create your API key.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; totals?: { [key: string]: unknown; all?: number; managed?: number; synced?: number; }; types?: object[]; }>

groups.grantGroupAccess ​

ts
grantGroupAccess: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ directoryId: string; groupId: string; orgId: string; resourceId: string; roleId: string; }-
parameters.directoryIdstringA directory has a unique ID. Use the Get directories endpoint to find the directory ID.
parameters.groupId?stringA group has a unique ID. Use the Get groups endpoint to find the group ID.
parameters.orgId?stringYour organization has a unique ID. Find this ID in your Atlassian Administration URL or when you create your API key.
parameters.resourceId?stringA resource or workspace refers to a specific instance of an Atlassian app, which has a unique ID. Use the Get workspaces endpoint to find the resource ID.
parameters.roleId?stringValid values: atlassian/user, atlassian/user-access-admin, atlassian/admin, atlassian/guest, atlassian/contributor, atlassian/customer, atlassian/basic, atlassian/stakeholder, atlassian/viewer
options?RequestOptions-
Returns ​

Promise<void>

groups.removeUserFromGroup ​

ts
removeUserFromGroup: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ accountId: string; directoryId: string; groupId: string; orgId: string; }-
parameters.accountIdstringEvery user has a unique ID. Find a user’s account ID by using the Get users endpoint.
parameters.directoryId?stringA directory has a unique ID. Use the Get directories endpoint to find the directory ID.
parameters.groupId?stringA group has a unique ID. Use the Get groups endpoint to find the group ID.
parameters.orgId?stringYour organization has a unique ID. Find this ID in your Atlassian Administration URL or when you create your API key.
options?RequestOptions-
Returns ​

Promise<void>

groups.revokeGroupAccess ​

ts
revokeGroupAccess: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ directoryId: string; groupId: string; orgId: string; resourceId: string; roleId: string; }-
parameters.directoryIdstringA directory has a unique ID. Use the Get directories endpoint to find the directory ID.
parameters.groupId?stringA group has a unique ID. Use the Get groups endpoint to find the group ID.
parameters.orgId?stringYour organization has a unique ID. Find this ID in your Atlassian Administration URL or when you create your API key.
parameters.resourceId?stringA resource or workspace refers to a specific instance of an Atlassian app, which has a unique ID. Use the Get workspaces endpoint to find the resource ID.
parameters.roleId?stringValid values: atlassian/user, atlassian/user-access-admin, atlassian/admin, atlassian/guest, atlassian/contributor, atlassian/customer, atlassian/basic, atlassian/stakeholder, atlassian/viewer
options?RequestOptions-
Returns ​

Promise<void>

groups.searchDirectoryGroups ​

ts
searchDirectoryGroups: (parameters, options?) => Promise<{
[key: string]: unknown;
  data: object[];
  links?: {
   [key: string]: unknown;
     next?: string | null;
     prev?: string | null;
     self?: string | null;
  };
}>;
Parameters ​
ParameterTypeDescription
parameters{ accountIds?: string[]; cursor?: string; directoryId: string; directoryIds?: string[]; expand?: (string & object | "counts.resources" | "counts.users")[]; groupIds?: string[]; groupNames?: string[]; limit?: number; orgId: string; resourceIds?: string[]; resourceOwners?: string[]; roleIds?: string[]; searchTerm?: string; sortBy?: object[]; }-
parameters.accountIds?string[]Filter by account IDs of group members.
parameters.cursor?stringSets the starting point for the page of results to return.
parameters.directoryId?stringUnique ID associated with a directory. The - character can be used to increase the operation scope to all directories the requestor has permission to manage.
parameters.directoryIds?string[]Filter by directory IDs.
parameters.expand?(string & object | "counts.resources" | "counts.users")[]List of additional fields to include in the response. Available values: - counts.resources — the number of resources the group has access to. - counts.users — the number of users in the group.
parameters.groupIds?string[]Filter by group IDs. Mutually exclusive with groupNames — providing both returns a 400 Bad Request error.
parameters.groupNames?string[]List of full group names to filter by (case-insensitive). Only exact matches are returned. Mutually exclusive with searchTerm and groupIds — providing either combination returns a 400 Bad Request error.
parameters.limit?numberThe number of results to return per page. Defaults to 20.
parameters.orgId?stringYour organization has a unique ID. Find this ID in your Atlassian Administration URL or when you create your API key.
parameters.resourceIds?string[]Filter by resource IDs.
parameters.resourceOwners?string[]Filter by resource type keys.
parameters.roleIds?string[]Filter by canonical Atlassian role IDs.
parameters.searchTerm?stringFree-text search term. Matched against the group name. Mutually exclusive with groupNames — providing both returns a 400 Bad Request error.
parameters.sortBy?object[]List of sort fields. Currently only a single sort field is supported.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; data: object[]; links?: { [key: string]: unknown; next?: string | null; prev?: string | null; self?: string | null; }; }>

orgs ​

ts
orgs: object;

orgs.getOrgById ​

ts
getOrgById: (parameters, options?) => Promise<{
[key: string]: unknown;
  data?: {
   [key: string]: unknown;
     attributes: {
      [key: string]: unknown;
        name?: string;
     };
     id: string;
     links: {
      [key: string]: unknown;
        self: string | null;
     };
     relationships: {
      [key: string]: unknown;
        domains?: {
         [key: string]: unknown;
           links?: ... | ...;
           related?: ... | ...;
        };
        users?: {
         [key: string]: unknown;
           links?: ... | ...;
           related?: ... | ...;
        };
     };
     type: string & object | "orgs";
  };
}>;
Parameters ​
ParameterTypeDescription
parameters{ orgId: string; }-
parameters.orgIdstringYour organization has a unique ID. Find this ID in your Atlassian Administration URL or when you create your API key.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; data?: { [key: string]: unknown; attributes: { [key: string]: unknown; name?: string; }; id: string; links: { [key: string]: unknown; self: string | null; }; relationships: { [key: string]: unknown; domains?: { [key: string]: unknown; links?: ... | ...; related?: ... | ...; }; users?: { [key: string]: unknown; links?: ... | ...; related?: ... | ...; }; }; type: string & object | "orgs"; }; }>

orgs.getOrgs ​

ts
getOrgs: (parameters?, options?) => Promise<{
[key: string]: unknown;
  data?: object[];
  links?: {
   [key: string]: unknown;
     next?: string | null;
     prev?: string | null;
     self?: string | null;
  };
  meta?: unknown;
}>;
Parameters ​
ParameterTypeDescription
parameters?{ cursor?: string; }-
parameters.cursor?stringSets the starting point for the page of results to return.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; data?: object[]; links?: { [key: string]: unknown; next?: string | null; prev?: string | null; self?: string | null; }; meta?: unknown; }>

policies ​

ts
policies: object;

policies.addResourceToPolicy ​

ts
addResourceToPolicy: (parameters, options?) => Promise<{
[key: string]: unknown;
  data?: {
   [key: string]: unknown;
     attributes: {
      [key: string]: unknown;
        createdAt?: string;
        id?: string;
        metadata?: unknown;
        name?: string;
        ownerId?: string;
        queryData?: unknown;
        resources?: object[];
        rule?:   | unknown[]
           | {
         [key: string]: unknown;
           in?: ... | ...;
         };
        status?: "disabled" | string & object | "enabled";
        type:   | string & object
           | "ip-allowlist"
           | "data-residency"
           | "data-security"
           | "admin-notification-settings"
           | "generative-ai"
           | "hipaa"
           | "ugc-data-use-preferences"
           | "user-join-settings-default";
        updatedAt?: string;
     };
     id: string;
     links?: Record<string, any>;
     message?: unknown;
     type: string & object | "policy";
  };
}>;
Parameters ​
ParameterTypeDescription
parameters{ id: string; links?: { ticket?: string; }; meta?: { atlassianAccountId?: string; migrationEndDataTime?: string; migrationStartDateTime?: string; scheduledDate?: string; }; orgId: string; policyId: string; }-
parameters.idstring-
parameters.links?{ ticket?: string; }-
parameters.links.ticket?string-
parameters.meta?{ atlassianAccountId?: string; migrationEndDataTime?: string; migrationStartDateTime?: string; scheduledDate?: string; }-
parameters.meta.atlassianAccountId?string-
parameters.meta.migrationEndDataTime?string-
parameters.meta.migrationStartDateTime?string-
parameters.meta.scheduledDate?string-
parameters.orgId?stringYour organization has a unique ID. Find this ID in your Atlassian Administration URL or when you create your API key.
parameters.policyId?stringID of the policy to query
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; data?: { [key: string]: unknown; attributes: { [key: string]: unknown; createdAt?: string; id?: string; metadata?: unknown; name?: string; ownerId?: string; queryData?: unknown; resources?: object[]; rule?: | unknown[] | { [key: string]: unknown; in?: ... | ...; }; status?: "disabled" | string & object | "enabled"; type: | string & object | "ip-allowlist" | "data-residency" | "data-security" | "admin-notification-settings" | "generative-ai" | "hipaa" | "ugc-data-use-preferences" | "user-join-settings-default"; updatedAt?: string; }; id: string; links?: Record<string, any>; message?: unknown; type: string & object | "policy"; }; }>

policies.createPolicy ​

ts
createPolicy: (parameters, options?) => Promise<{
[key: string]: unknown;
  data?: {
   [key: string]: unknown;
     attributes: {
      [key: string]: unknown;
        createdAt?: string;
        id?: string;
        metadata?: unknown;
        name?: string;
        ownerId?: string;
        queryData?: unknown;
        resources?: object[];
        rule?:   | unknown[]
           | {
         [key: string]: unknown;
           in?: ... | ...;
         };
        status?: "disabled" | string & object | "enabled";
        type:   | string & object
           | "ip-allowlist"
           | "data-residency"
           | "data-security"
           | "admin-notification-settings"
           | "generative-ai"
           | "hipaa"
           | "ugc-data-use-preferences"
           | "user-join-settings-default";
        updatedAt?: string;
     };
     id: string;
     links?: Record<string, any>;
     message?: unknown;
     type: string & object | "policy";
  };
}>;
Parameters ​
ParameterTypeDescription
parameters{ data?: { attributes: { name?: string; resources?: object[]; rule?: { in?: ...[]; }; status?: "disabled" | string & object | "enabled"; type: string & object | "ip-allowlist" | "data-residency"; }; type: string & object | "policy"; }; orgId: string; }-
parameters.data?{ attributes: { name?: string; resources?: object[]; rule?: { in?: ...[]; }; status?: "disabled" | string & object | "enabled"; type: string & object | "ip-allowlist" | "data-residency"; }; type: string & object | "policy"; }-
parameters.data.attributes?{ name?: string; resources?: object[]; rule?: { in?: ...[]; }; status?: "disabled" | string & object | "enabled"; type: string & object | "ip-allowlist" | "data-residency"; }Attributes of this object
parameters.data.attributes.name?stringName of this Policy
parameters.data.attributes.resources?object[]List of resources Policy is associated with
parameters.data.attributes.rule?{ in?: ...[]; }Rule of the Policy
parameters.data.attributes.rule.in?...[]-
parameters.data.attributes.status?"disabled" | string & object | "enabled"Status of this Policy
parameters.data.attributes.type?string & object | "ip-allowlist" | "data-residency"Type of this Policy
parameters.data.type?string & object | "policy"Type of this object
parameters.orgId?stringYour organization has a unique ID. Find this ID in your Atlassian Administration URL or when you create your API key.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; data?: { [key: string]: unknown; attributes: { [key: string]: unknown; createdAt?: string; id?: string; metadata?: unknown; name?: string; ownerId?: string; queryData?: unknown; resources?: object[]; rule?: | unknown[] | { [key: string]: unknown; in?: ... | ...; }; status?: "disabled" | string & object | "enabled"; type: | string & object | "ip-allowlist" | "data-residency" | "data-security" | "admin-notification-settings" | "generative-ai" | "hipaa" | "ugc-data-use-preferences" | "user-join-settings-default"; updatedAt?: string; }; id: string; links?: Record<string, any>; message?: unknown; type: string & object | "policy"; }; }>

policies.deletePolicy ​

ts
deletePolicy: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ orgId: string; policyId: string; }-
parameters.orgIdstringYour organization has a unique ID. Find this ID in your Atlassian Administration URL or when you create your API key.
parameters.policyId?stringID of the policy to delete
options?RequestOptions-
Returns ​

Promise<void>

policies.deletePolicyResource ​

ts
deletePolicyResource: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ orgId: string; policyId: string; resourceId: string; }-
parameters.orgIdstringYour organization has a unique ID. Find this ID in your Atlassian Administration URL or when you create your API key.
parameters.policyId?stringID of the policy to query
parameters.resourceId?stringResource ID
options?RequestOptions-
Returns ​

Promise<void>

policies.getPolicies ​

ts
getPolicies: (parameters, options?) => Promise<{
[key: string]: unknown;
  data?: object[];
  links?: {
   [key: string]: unknown;
     next?: string | null;
     prev?: string | null;
     self?: string | null;
  };
  meta?: {
   [key: string]: unknown;
     attributes?: unknown;
     current?: number;
     end_index?: number;
     next?: string | null;
     page_size?: number;
     prev?: string;
     start_index?: number;
     total?: number;
  };
}>;
Parameters ​
ParameterTypeDescription
parameters{ cursor?: string; orgId: string; type?: string; }-
parameters.cursor?stringSets the starting point for the page of results to return.
parameters.orgId?stringYour organization has a unique ID. Find this ID in your Atlassian Administration URL or when you create your API key.
parameters.type?stringSets the type for the page of policies to return.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; data?: object[]; links?: { [key: string]: unknown; next?: string | null; prev?: string | null; self?: string | null; }; meta?: { [key: string]: unknown; attributes?: unknown; current?: number; end_index?: number; next?: string | null; page_size?: number; prev?: string; start_index?: number; total?: number; }; }>

policies.getPolicyById ​

ts
getPolicyById: (parameters, options?) => Promise<{
[key: string]: unknown;
  data?: {
   [key: string]: unknown;
     attributes: {
      [key: string]: unknown;
        createdAt?: string;
        id?: string;
        metadata?: unknown;
        name?: string;
        ownerId?: string;
        queryData?: unknown;
        resources?: object[];
        rule?:   | unknown[]
           | {
         [key: string]: unknown;
           in?: ... | ...;
         };
        status?: "disabled" | string & object | "enabled";
        type:   | string & object
           | "ip-allowlist"
           | "data-residency"
           | "data-security"
           | "admin-notification-settings"
           | "generative-ai"
           | "hipaa"
           | "ugc-data-use-preferences"
           | "user-join-settings-default";
        updatedAt?: string;
     };
     id: string;
     links?: Record<string, any>;
     message?: unknown;
     type: string & object | "policy";
  };
}>;
Parameters ​
ParameterTypeDescription
parameters{ orgId: string; policyId: string; }-
parameters.orgIdstringYour organization has a unique ID. Find this ID in your Atlassian Administration URL or when you create your API key.
parameters.policyId?stringID of the policy to query
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; data?: { [key: string]: unknown; attributes: { [key: string]: unknown; createdAt?: string; id?: string; metadata?: unknown; name?: string; ownerId?: string; queryData?: unknown; resources?: object[]; rule?: | unknown[] | { [key: string]: unknown; in?: ... | ...; }; status?: "disabled" | string & object | "enabled"; type: | string & object | "ip-allowlist" | "data-residency" | "data-security" | "admin-notification-settings" | "generative-ai" | "hipaa" | "ugc-data-use-preferences" | "user-join-settings-default"; updatedAt?: string; }; id: string; links?: Record<string, any>; message?: unknown; type: string & object | "policy"; }; }>

policies.updatePolicy ​

ts
updatePolicy: (parameters, options?) => Promise<{
[key: string]: unknown;
  data?: {
   [key: string]: unknown;
     attributes: {
      [key: string]: unknown;
        createdAt?: string;
        id?: string;
        metadata?: unknown;
        name?: string;
        ownerId?: string;
        queryData?: unknown;
        resources?: object[];
        rule?:   | unknown[]
           | {
         [key: string]: unknown;
           in?: ... | ...;
         };
        status?: "disabled" | string & object | "enabled";
        type:   | string & object
           | "ip-allowlist"
           | "data-residency"
           | "data-security"
           | "admin-notification-settings"
           | "generative-ai"
           | "hipaa"
           | "ugc-data-use-preferences"
           | "user-join-settings-default";
        updatedAt?: string;
     };
     id: string;
     links?: Record<string, any>;
     message?: unknown;
     type: string & object | "policy";
  };
}>;
Parameters ​
ParameterTypeDescription
parameters{ data?: { attributes: { name?: string; resources?: object[]; rule?: { in?: ...[]; }; status?: "disabled" | string & object | "enabled"; type: string & object | "ip-allowlist" | "data-residency"; }; id?: string; type: string & object | "policy"; }; orgId: string; policyId: string; }-
parameters.data?{ attributes: { name?: string; resources?: object[]; rule?: { in?: ...[]; }; status?: "disabled" | string & object | "enabled"; type: string & object | "ip-allowlist" | "data-residency"; }; id?: string; type: string & object | "policy"; }-
parameters.data.attributes?{ name?: string; resources?: object[]; rule?: { in?: ...[]; }; status?: "disabled" | string & object | "enabled"; type: string & object | "ip-allowlist" | "data-residency"; }Attributes of this object
parameters.data.attributes.name?stringName of this Policy
parameters.data.attributes.resources?object[]List of resources Policy is associated with
parameters.data.attributes.rule?{ in?: ...[]; }Rule of the Policy
parameters.data.attributes.rule.in?...[]-
parameters.data.attributes.status?"disabled" | string & object | "enabled"Status of this Policy
parameters.data.attributes.type?string & object | "ip-allowlist" | "data-residency"Type of this Policy
parameters.data.id?stringUnique identifier of the Policy
parameters.data.type?string & object | "policy"Type of this object
parameters.orgId?stringYour organization has a unique ID. Find this ID in your Atlassian Administration URL or when you create your API key.
parameters.policyId?stringID of the policy to update
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; data?: { [key: string]: unknown; attributes: { [key: string]: unknown; createdAt?: string; id?: string; metadata?: unknown; name?: string; ownerId?: string; queryData?: unknown; resources?: object[]; rule?: | unknown[] | { [key: string]: unknown; in?: ... | ...; }; status?: "disabled" | string & object | "enabled"; type: | string & object | "ip-allowlist" | "data-residency" | "data-security" | "admin-notification-settings" | "generative-ai" | "hipaa" | "ugc-data-use-preferences" | "user-join-settings-default"; updatedAt?: string; }; id: string; links?: Record<string, any>; message?: unknown; type: string & object | "policy"; }; }>

policies.updatePolicyResource ​

ts
updatePolicyResource: (parameters, options?) => Promise<{
[key: string]: unknown;
  data?: {
   [key: string]: unknown;
     attributes: {
      [key: string]: unknown;
        createdAt?: string;
        id?: string;
        metadata?: unknown;
        name?: string;
        ownerId?: string;
        queryData?: unknown;
        resources?: object[];
        rule?:   | unknown[]
           | {
         [key: string]: unknown;
           in?: ... | ...;
         };
        status?: "disabled" | string & object | "enabled";
        type:   | string & object
           | "ip-allowlist"
           | "data-residency"
           | "data-security"
           | "admin-notification-settings"
           | "generative-ai"
           | "hipaa"
           | "ugc-data-use-preferences"
           | "user-join-settings-default";
        updatedAt?: string;
     };
     id: string;
     links?: Record<string, any>;
     message?: unknown;
     type: string & object | "policy";
  };
}>;
Parameters ​
ParameterTypeDescription
parameters{ links?: { ticket?: string; }; meta?: { atlassianAccountId?: string; migrationEndDataTime?: string; migrationStartDateTime?: string; scheduledDate?: string; }; orgId: string; policyId: string; resourceId: string; }-
parameters.links?{ ticket?: string; }-
parameters.links.ticket?string-
parameters.meta?{ atlassianAccountId?: string; migrationEndDataTime?: string; migrationStartDateTime?: string; scheduledDate?: string; }-
parameters.meta.atlassianAccountId?string-
parameters.meta.migrationEndDataTime?string-
parameters.meta.migrationStartDateTime?string-
parameters.meta.scheduledDate?string-
parameters.orgId?stringYour organization has a unique ID. Find this ID in your Atlassian Administration URL or when you create your API key.
parameters.policyId?stringID of the policy to query
parameters.resourceId?stringResource ID
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; data?: { [key: string]: unknown; attributes: { [key: string]: unknown; createdAt?: string; id?: string; metadata?: unknown; name?: string; ownerId?: string; queryData?: unknown; resources?: object[]; rule?: | unknown[] | { [key: string]: unknown; in?: ... | ...; }; status?: "disabled" | string & object | "enabled"; type: | string & object | "ip-allowlist" | "data-residency" | "data-security" | "admin-notification-settings" | "generative-ai" | "hipaa" | "ugc-data-use-preferences" | "user-join-settings-default"; updatedAt?: string; }; id: string; links?: Record<string, any>; message?: unknown; type: string & object | "policy"; }; }>

policies.validatePolicy ​

ts
validatePolicy: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ orgId: string; policyId: string; }-
parameters.orgIdstringYour organization has a unique ID. Find this ID in your Atlassian Administration URL or when you create your API key.
parameters.policyId?stringPolicy ID
options?RequestOptions-
Returns ​

Promise<void>

users ​

ts
users: object;

users.assignOrganizationRole ​

ts
assignOrganizationRole: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ orgId: string; role: string & object | "atlassian/org-admin"; userId: string; }-
parameters.orgIdstringYour organization has a unique ID. Find this ID in your Atlassian Administration URL or when you create your API key.
parameters.role?string & object | "atlassian/org-admin"-
parameters.userId?stringEvery user has a unique ID. Find a user’s account ID by using the Get users endpoint.
options?RequestOptions-
Returns ​

Promise<void>

users.getDirectoryUserDetails ​

ts
getDirectoryUserDetails: (parameters, options?) => Promise<{
[key: string]: unknown;
  data?: {
   [key: string]: unknown;
     accountId?: string;
     accountStatus?: "active" | "inactive" | "closed" | string & object;
     accountType?: string & object | "atlassian";
     addedToOrg?: string;
     avatar?: string;
     claimStatus?: string & object | "managed" | "unmanaged";
     counts?: {
      [key: string]: unknown;
        resources?: number;
     };
     deactivatedOn?: string | null;
     department?: string | null;
     email?: string;
     emailVerified?: boolean;
     forDeletion?: boolean;
     jobTitle?: string;
     links?: Record<string, any>;
     location?: string | null;
     managementSource?: string & object | "synced" | "invited" | null;
     membershipStatus?: "active" | "suspended" | string & object | "no_membership";
     mfaEnabled?: boolean;
     name?: string;
     nickname?: string;
     organization?: string | null;
     picture?: string;
     platformRoles?: (
        | ... & ...
        | "atlassian/org-admin"
        | "atlassian/site-admin"
        | "atlassian/user-access-admin"
       | "atlassian/ai-access")[];
     status?:   | "active"
        | "suspended"
        | string & object
        | "not_invited"
        | "deactivated"
        | "for_deletion";
     timeZone?: string | null;
  };
}>;
Parameters ​
ParameterTypeDescription
parameters{ accountId: string; directoryId: string; orgId: string; }-
parameters.accountIdstringUnique ID associated with a user account.
parameters.directoryId?stringUnique ID associated with a directory. The - character can be used to increase the operation scope to all directories the requestor has permission to manage.
parameters.orgId?stringYour organization has a unique ID. Find this ID in your Atlassian Administration URL or when you create your API key.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; data?: { [key: string]: unknown; accountId?: string; accountStatus?: "active" | "inactive" | "closed" | string & object; accountType?: string & object | "atlassian"; addedToOrg?: string; avatar?: string; claimStatus?: string & object | "managed" | "unmanaged"; counts?: { [key: string]: unknown; resources?: number; }; deactivatedOn?: string | null; department?: string | null; email?: string; emailVerified?: boolean; forDeletion?: boolean; jobTitle?: string; links?: Record<string, any>; location?: string | null; managementSource?: string & object | "synced" | "invited" | null; membershipStatus?: "active" | "suspended" | string & object | "no_membership"; mfaEnabled?: boolean; name?: string; nickname?: string; organization?: string | null; picture?: string; platformRoles?: ( | ... & ... | "atlassian/org-admin" | "atlassian/site-admin" | "atlassian/user-access-admin" | "atlassian/ai-access")[]; status?: | "active" | "suspended" | string & object | "not_invited" | "deactivated" | "for_deletion"; timeZone?: string | null; }; }>

users.getDirectoryUsers ​

ts
getDirectoryUsers: (parameters, options?) => Promise<{
[key: string]: unknown;
  data?: object[];
  links?: {
   [key: string]: unknown;
     next?: string | null;
     prev?: string | null;
     self?: string | null;
  };
}>;
Parameters ​
ParameterTypeDescription
parameters{ accountIds?: string[]; accountStatus?: ("active" | "inactive" | "closed" | string & object)[]; claimStatus?: string & object | "managed" | "unmanaged"; cursor?: string; directoryId: string; directoryIds?: string[]; emailDomains?: string[]; groupIds?: string[]; limit?: number; membershipStatus?: ("active" | "suspended" | string & object | "no_membership")[]; mfaEnabled?: boolean; orgId: string; resourceIds?: string[]; roleIds?: ( | string & object | "atlassian/org-admin" | "atlassian/site-admin" | "atlassian/user-access-admin" | "atlassian/ai-access" | "atlassian/user" | "atlassian/admin" | "atlassian/guest" | "atlassian/customer" | "atlassian/contributor" | "atlassian/basic" | "atlassian/stakeholder")[]; searchTerm?: string; sortBy?: object[]; status?: ( | "active" | "suspended" | string & object | "not_invited" | "deactivated" | "for_deletion")[]; }-
parameters.accountIds?string[]A list of user account IDs.
parameters.accountStatus?("active" | "inactive" | "closed" | string & object)[]The lifecycle status of the account. - active - The account is active and can be used. - inactive - The account is inactive and doesn't have access to any resources. - closed - The account is closed and can't be used.
parameters.claimStatus?string & object | "managed" | "unmanaged"The claim status for the user account. By default, both managed and unmanaged accounts are returned. - managed - Returns only managed accounts. For more on managed accounts: https://support.atlassian.com/user-management/docs/what-are-managed-accounts/ - unmanaged - Returns only unmanaged accounts.
parameters.cursor?stringSets the cursor position to retrieve the next set of results. If present, all other parameters are discarded when searching.
parameters.directoryId?stringUnique ID associated with a directory. The - character can be used to increase the operation scope to all directories the requestor has permission to manage.
parameters.directoryIds?string[]A list of directory IDs. The requestor must have permissions to administer resources linked to these directories.
parameters.emailDomains?string[]The email domain to filter the results. The email domain will be used to search against the account email domain. For example, get all users with the @atlassian.com or @example.com email domain.
parameters.groupIds?string[]A list of group IDs.
parameters.limit?numberThe desired number of results for the search request.
parameters.membershipStatus?("active" | "suspended" | string & object | "no_membership")[]A list of membership statuses. The membership status is the status of the user account in the organization. - active - the account has an active membership for one or more directories within the organization. - suspended - the account is suspended in ALL directories within the organization, to which the requestor has permission to access. - no_membership - the account is in NONE of the organization’s directories.
parameters.mfaEnabled?booleanWhether or not a managed account has two-step verification enabled on their account. If true, they have two-step verification enabled. By default, all accounts are returned, regardless of two-step verification status.
parameters.orgId?stringYour organization has a unique ID. Find this ID in your Atlassian Administration URL or when you create your API key.
parameters.resourceIds?string[]A list of resource IDs. The resource IDs should be specified using the Atlassian Resource Identifier (ARI) format. Example ARI: ari:cloud:jira-core::site/1
parameters.roleIds?( | string & object | "atlassian/org-admin" | "atlassian/site-admin" | "atlassian/user-access-admin" | "atlassian/ai-access" | "atlassian/user" | "atlassian/admin" | "atlassian/guest" | "atlassian/customer" | "atlassian/contributor" | "atlassian/basic" | "atlassian/stakeholder")[]A list of role IDs. The Atlassian canonical roles are used to determine the permissions of the user against resources within the organization. The allowed roles are: - atlassian/user - Can access the product, with no product admin permissions - atlassian/admin - Can access the product, with product admin permissions - atlassian/guest - Can only access one space you or space admins specify - atlassian/customer - (Jira Service Management) Can visit help center, submit help requests, and view articles (non-billable) - atlassian/user-access-admin - No product access. Can administer users and groups for this product in Atlassian Administration - atlassian/contributor - Can access the product to view, comment, and vote only (non-billable) - atlassian/basic - Can access basic product features, with no product admin permissions (non-billable) - atlassian/stakeholder - Can receive incident updates and has the same product access as Customer. Non-billable but available only on Premium and Enterprise plans - atlassian/org-admin - An organization admin is the highest level of admin and can complete any administrative task in Atlassian Administration - atlassian/site-admin - Site admins can access Atlassian Administration and complete tasks related to the specific site they are administering. - atlassian/ai-access - Can use AI features in AI-enabled apps they have access to.
parameters.searchTerm?stringA search term to search the nickname and email fields.
parameters.sortBy?object[]The field and direction to sort the results by. Currently, only a single field can be sorted by. If null, the default sorting will be used.
parameters.status?( | "active" | "suspended" | string & object | "not_invited" | "deactivated" | "for_deletion")[]The status for the user account. This status is a composite of accountStatus and membershipStatus. - active - accountStatus is active and membershipStatus is active. - suspended - accountStatus is active and membershipStatus is suspended. - not_invited - accountStatus is active and membershipStatus is no_membership. - deactivated - accountStatus is inactive. - for_deletion - Indicates whether or not a managed account is scheduled for deletion.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; data?: object[]; links?: { [key: string]: unknown; next?: string | null; prev?: string | null; self?: string | null; }; }>

Deprecated ​

This API is deprecated and will no longer work after June 30, 2027. Use the Search for users in an organization endpoint instead.

users.getDirectoryUsersCount ​

ts
getDirectoryUsersCount: (parameters, options?) => Promise<{
[key: string]: unknown;
  count?: number;
}>;
Parameters ​
ParameterTypeDescription
parameters{ accountIds?: string[]; accountStatus?: ("active" | "inactive" | "closed" | string & object)[]; claimStatus?: string & object | "managed" | "unmanaged"; directoryId: string; directoryIds?: string[]; emailDomains?: string[]; groupIds?: string[]; membershipStatus?: ("active" | "suspended" | string & object | "no_membership")[]; mfaEnabled?: boolean; orgId: string; resourceIds?: string[]; roleIds?: ( | string & object | "atlassian/org-admin" | "atlassian/site-admin" | "atlassian/user-access-admin" | "atlassian/ai-access" | "atlassian/user" | "atlassian/admin" | "atlassian/guest" | "atlassian/customer" | "atlassian/contributor" | "atlassian/basic" | "atlassian/stakeholder")[]; searchTerm?: string; status?: ( | "active" | "suspended" | string & object | "not_invited" | "deactivated" | "for_deletion")[]; }-
parameters.accountIds?string[]A list of user account IDs.
parameters.accountStatus?("active" | "inactive" | "closed" | string & object)[]The lifecycle status of the account. - active - The account is active and can be used. - inactive - The account is inactive and doesn't have access to any resources. - closed - The account is closed and can't be used.
parameters.claimStatus?string & object | "managed" | "unmanaged"The claim status for the user account. By default, both managed and unmanaged accounts are returned. - managed - Returns only managed accounts. For more on managed accounts: https://support.atlassian.com/user-management/docs/what-are-managed-accounts/ - unmanaged - Returns only unmanaged accounts.
parameters.directoryId?stringUnique ID associated with a directory. The - character can be used to increase the operation scope to all directories the requestor has permission to manage.
parameters.directoryIds?string[]A list of directory IDs. The requestor must have permissions to administer resources linked to these directories.
parameters.emailDomains?string[]The email domain to filter the results. The email domain will be used to search against the account email domain. For example, get all users with the @atlassian.com or @example.com email domain.
parameters.groupIds?string[]A list of group IDs.
parameters.membershipStatus?("active" | "suspended" | string & object | "no_membership")[]A list of membership statuses. The membership status is the status of the user account in the organization. - active - the account has an active membership for one or more directories within the organization. - suspended - the account is suspended in ALL directories within the organization, to which the requestor has permission to access. - no_membership - the account is in NONE of the organization’s directories.
parameters.mfaEnabled?booleanWhether or not a managed account has two-step verification enabled on their account. If true, they have two-step verification enabled. By default, all accounts are returned, regardless of two-step verification status.
parameters.orgId?stringYour organization has a unique ID. Find this ID in your Atlassian Administration URL or when you create your API key.
parameters.resourceIds?string[]A list of resource IDs. The resource IDs should be specified using the Atlassian Resource Identifier (ARI) format. Example ARI: ari:cloud:jira-core::site/1
parameters.roleIds?( | string & object | "atlassian/org-admin" | "atlassian/site-admin" | "atlassian/user-access-admin" | "atlassian/ai-access" | "atlassian/user" | "atlassian/admin" | "atlassian/guest" | "atlassian/customer" | "atlassian/contributor" | "atlassian/basic" | "atlassian/stakeholder")[]A list of role IDs. The Atlassian canonical roles are used to determine the permissions of the user against resources within the organization. The allowed roles are: - atlassian/user - Can access the product, with no product admin permissions - atlassian/admin - Can access the product, with product admin permissions - atlassian/guest - Can only access one space you or space admins specify - atlassian/customer - (Jira Service Management) Can visit help center, submit help requests, and view articles (non-billable) - atlassian/user-access-admin - No product access. Can administer users and groups for this product in Atlassian Administration - atlassian/contributor - Can access the product to view, comment, and vote only (non-billable) - atlassian/basic - Can access basic product features, with no product admin permissions (non-billable) - atlassian/stakeholder - Can receive incident updates and has the same product access as Customer. Non-billable but available only on Premium and Enterprise plans - atlassian/org-admin - An organization admin is the highest level of admin and can complete any administrative task in Atlassian Administration - atlassian/site-admin - Site admins can access Atlassian Administration and complete tasks related to the specific site they are administering. - atlassian/ai-access - Can use AI features in AI-enabled apps they have access to.
parameters.searchTerm?stringA search term to search the nickname and email fields.
parameters.status?( | "active" | "suspended" | string & object | "not_invited" | "deactivated" | "for_deletion")[]The status for the user account. This status is a composite of accountStatus and membershipStatus. - active - accountStatus is active and membershipStatus is active. - suspended - accountStatus is active and membershipStatus is suspended. - not_invited - accountStatus is active and membershipStatus is no_membership. - deactivated - accountStatus is inactive. - for_deletion - Indicates whether or not a managed account is scheduled for deletion.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; count?: number; }>

users.getUserLastActiveDates ​

ts
getUserLastActiveDates: (parameters, options?) => Promise<{
[key: string]: unknown;
  data?: {
   [key: string]: unknown;
     added_to_org?: string | null;
     added_to_org_timestamp?: Date | null;
     product_access: object[];
  };
  links?: {
   [key: string]: unknown;
     next?: string | null;
  };
}>;
Parameters ​
ParameterTypeDescription
parameters{ accountId: string; cursor?: string; orgId: string; }-
parameters.accountIdstringUnique ID of the user's account. Use the Jira User Search API to get the accountId (if Jira is available for your Organization). Jira APIs use a different authentication method . If you don’t have Jira, export a .csv of the user list. Learn how to export users from a site.
parameters.cursor?stringCursor to fetch the next page
parameters.orgId?stringYour organization has a unique ID. Find this ID in your Atlassian Administration URL or when you create your API key.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; data?: { [key: string]: unknown; added_to_org?: string | null; added_to_org_timestamp?: Date | null; product_access: object[]; }; links?: { [key: string]: unknown; next?: string | null; }; }>

users.getUserRoleAssignments ​

ts
getUserRoleAssignments: (parameters, options?) => Promise<{
[key: string]: unknown;
  data?: object[];
  links?: {
   [key: string]: unknown;
     next?: string | null;
     prev?: string | null;
     self?: string | null;
  };
}>;
Parameters ​
ParameterTypeDescription
parameters{ accountId: string; cursor?: string; directoryId: string; directoryIds?: string[]; limit?: number; orgId: string; resourceIds?: string[]; resourceOwners?: string[]; roleIds?: ( | string & object | "atlassian/org-admin" | "atlassian/site-admin" | "atlassian/user-access-admin" | "atlassian/ai-access" | "atlassian/user" | "atlassian/admin" | "atlassian/guest" | "atlassian/customer" | "atlassian/contributor" | "atlassian/basic" | "atlassian/stakeholder")[]; }-
parameters.accountIdstringUnique ID associated with a user account.
parameters.cursor?stringSets the cursor position to retrieve the next set of results. If present, all other parameters are discarded when searching.
parameters.directoryId?stringUnique ID associated with a directory. The - character can be used to increase the operation scope to all directories the requestor has permission to manage.
parameters.directoryIds?string[]A list of directory IDs. The requestor must have permissions to administer resources linked to these directories.
parameters.limit?numberThe desired number of results for the search request.
parameters.orgId?stringYour organization has a unique ID. Find this ID in your Atlassian Administration URL or when you create your API key.
parameters.resourceIds?string[]A list of resource IDs. The resource IDs should be specified using the Atlassian Resource Identifier (ARI) format. Example ARI: ari:cloud:jira-core::site/1
parameters.resourceOwners?string[]The list of resource owners to filter the results by. Used to identify resources using their owner to which the user has at least one role assigned to.
parameters.roleIds?( | string & object | "atlassian/org-admin" | "atlassian/site-admin" | "atlassian/user-access-admin" | "atlassian/ai-access" | "atlassian/user" | "atlassian/admin" | "atlassian/guest" | "atlassian/customer" | "atlassian/contributor" | "atlassian/basic" | "atlassian/stakeholder")[]A list of role IDs. The Atlassian canonical roles are used to determine the permissions of the user against resources within the organization. The allowed roles are: - atlassian/user - Can access the product, with no product admin permissions - atlassian/admin - Can access the product, with product admin permissions - atlassian/guest - Can only access one space you or space admins specify - atlassian/customer - (Jira Service Management) Can visit help center, submit help requests, and view articles (non-billable) - atlassian/user-access-admin - No product access. Can administer users and groups for this product in Atlassian Administration - atlassian/contributor - Can access the product to view, comment, and vote only (non-billable) - atlassian/basic - Can access basic product features, with no product admin permissions (non-billable) - atlassian/stakeholder - Can receive incident updates and has the same product access as Customer. Non-billable but available only on Premium and Enterprise plans - atlassian/org-admin - An organization admin is the highest level of admin and can complete any administrative task in Atlassian Administration - atlassian/site-admin - Site admins can access Atlassian Administration and complete tasks related to the specific site they are administering. - atlassian/ai-access - Can use AI features in AI-enabled apps they have access to.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; data?: object[]; links?: { [key: string]: unknown; next?: string | null; prev?: string | null; self?: string | null; }; }>

users.getUsers ​

ts
getUsers: (parameters, options?) => Promise<{
[key: string]: unknown;
  data?: object[];
  links?: {
   [key: string]: unknown;
     next?: string | null;
     prev?: string | null;
     self?: string | null;
  };
  meta?: {
   [key: string]: unknown;
     total?: number;
  };
}>;
Parameters ​
ParameterTypeDescription
parameters{ cursor?: string; orgId: string; }-
parameters.cursor?stringSets the starting point for the page of results to return.
parameters.orgId?stringYour organization has a unique ID. Find this ID in your Atlassian Administration URL or when you create your API key.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; data?: object[]; links?: { [key: string]: unknown; next?: string | null; prev?: string | null; self?: string | null; }; meta?: { [key: string]: unknown; total?: number; }; }>

users.getUserStats ​

ts
getUserStats: (parameters, options?) => Promise<{
[key: string]: unknown;
  accountStatus?: object[];
  roles?: object[];
}>;
Parameters ​
ParameterTypeDescription
parameters{ directoryId: string; orgId: string; }-
parameters.directoryIdstringUnique ID associated with a directory. The - character can be used to increase the operation scope to all directories the requestor has permission to manage.
parameters.orgId?stringYour organization has a unique ID. Find this ID in your Atlassian Administration URL or when you create your API key.
options?RequestOptions-
Returns ​

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

users.grantUserAccess ​

ts
grantUserAccess: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ orgId: string; resource?: string; role: | string & object | "atlassian/org-admin" | "atlassian/site-admin" | "atlassian/user-access-admin" | "atlassian/user" | "atlassian/admin" | "atlassian/guest" | "atlassian/customer" | "atlassian/contributor" | "atlassian/basic" | "atlassian/stakeholder"; userId: string; }-
parameters.orgIdstringYour organization has a unique ID. Find this ID in your Atlassian Administration URL or when you create your API key.
parameters.resource?stringUse the Get Workspaces API to get an id. Resource is required for all roles other than org-admin. Any resource passed for org-admin shall be ignored
parameters.role?| string & object | "atlassian/org-admin" | "atlassian/site-admin" | "atlassian/user-access-admin" | "atlassian/user" | "atlassian/admin" | "atlassian/guest" | "atlassian/customer" | "atlassian/contributor" | "atlassian/basic" | "atlassian/stakeholder"Role to assign/revoke for a user
parameters.userId?stringThe UserId on which the action(Role Assign) needs to happen. Use the Search for users within an organization API to get the userId.
options?RequestOptions-
Returns ​

Promise<void>

users.inviteUsers ​

ts
inviteUsers: (parameters, options?) => Promise<{
[key: string]: unknown;
  data?: object[];
}>;
Parameters ​
ParameterTypeDescription
parameters{ additionalGroups?: string[]; emails: string[]; notificationText?: string; orgId: string; permissionRules?: object[]; sendNotification?: boolean; }-
parameters.additionalGroups?string[]The groups you want to add users to from this invitation. Use the Get groups in an organization endpoint to find the group IDs.
parameters.emails?string[]Email addresses of the people you want to invite.
parameters.notificationText?stringAdd a message to your email invitation.
parameters.orgId?stringYour organization has a unique ID. Find this ID in your Atlassian Administration URL or when you create your API key.
parameters.permissionRules?object[]The access you want to give users from this invitation.
parameters.sendNotification?booleanSet to true if you want to send an email invitation.
options?RequestOptions-
Returns ​

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

users.removeDirectoryUser ​

ts
removeDirectoryUser: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ accountId: string; directoryId: string; orgId: string; }-
parameters.accountIdstringEvery user has a unique ID. Find a user’s account ID by using the Get users endpoint.
parameters.directoryId?stringA directory has a unique ID. Use the Get directories endpoint to find the directory ID.
parameters.orgId?stringYour organization has a unique ID. Find this ID in your Atlassian Administration URL or when you create your API key.
options?RequestOptions-
Returns ​

Promise<void>

users.restoreDirectoryUser ​

ts
restoreDirectoryUser: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ accountId: string; directoryId: string; orgId: string; }-
parameters.accountIdstringEvery user has a unique ID. Find a user’s account ID by using the Get users endpoint.
parameters.directoryId?stringA directory has a unique ID. Use the Get directories endpoint to find the directory ID.
parameters.orgId?stringYour organization has a unique ID. Find this ID in your Atlassian Administration URL or when you create your API key.
options?RequestOptions-
Returns ​

Promise<void>

users.revokeOrganizationRole ​

ts
revokeOrganizationRole: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ orgId: string; role: string & object | "atlassian/org-admin"; userId: string; }-
parameters.orgIdstringYour organization has a unique ID. Find this ID in your Atlassian Administration URL or when you create your API key.
parameters.role?string & object | "atlassian/org-admin"-
parameters.userId?stringEvery user has a unique ID. Find a user's account ID by using the Get users endpoint.
options?RequestOptions-
Returns ​

Promise<void>

users.revokeUserAccess ​

ts
revokeUserAccess: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ orgId: string; resource?: string; role: | string & object | "atlassian/org-admin" | "atlassian/site-admin" | "atlassian/user-access-admin" | "atlassian/user" | "atlassian/admin" | "atlassian/guest" | "atlassian/customer" | "atlassian/contributor" | "atlassian/basic" | "atlassian/stakeholder"; userId: string; }-
parameters.orgIdstringYour organization has a unique ID. Find this ID in your Atlassian Administration URL or when you create your API key.
parameters.resource?stringUse the Get Workspaces API to get an id. Resource is required for all roles other than org-admin. Any resource passed for org-admin shall be ignored
parameters.role?| string & object | "atlassian/org-admin" | "atlassian/site-admin" | "atlassian/user-access-admin" | "atlassian/user" | "atlassian/admin" | "atlassian/guest" | "atlassian/customer" | "atlassian/contributor" | "atlassian/basic" | "atlassian/stakeholder"Role to assign/revoke for a user
parameters.userId?stringThe UserId on which the action(Role Revoke) needs to happen. Use the Search for users within an organization API to get the userId.
options?RequestOptions-
Returns ​

Promise<void>

users.searchDirectoryUsers ​

ts
searchDirectoryUsers: (parameters, options?) => Promise<{
[key: string]: unknown;
  data: object[];
  links?: {
   [key: string]: unknown;
     next?: string | null;
     prev?: string | null;
     self?: string | null;
  };
}>;
Parameters ​
ParameterTypeDescription
parameters{ accountIds?: string[]; accountStatus?: ("active" | "inactive" | "closed" | string & object)[]; claimStatus?: string & object | "managed" | "unmanaged"; cursor?: string; directoryId: string; directoryIds?: string[]; emailDomains?: string[]; emails?: string[]; expand?: ( | "groups" | string & object | "platformRoles" | "productAccess" | "counts.resources")[]; groupIds?: string[]; limit?: number; membershipStatus?: ("active" | "suspended" | string & object | "no_membership")[]; mfaEnabled?: boolean; orgId: string; resourceIds?: string[]; roleIds?: ( | string & object | "atlassian/org-admin" | "atlassian/site-admin" | "atlassian/user-access-admin" | "atlassian/ai-access" | "atlassian/user" | "atlassian/admin" | "atlassian/guest" | "atlassian/customer" | "atlassian/contributor" | "atlassian/basic" | "atlassian/stakeholder")[]; searchTerm?: string; sortBy?: object[]; status?: ( | "active" | "suspended" | string & object | "not_invited" | "deactivated" | "for_deletion")[]; }-
parameters.accountIds?string[]A list of user account IDs.
parameters.accountStatus?("active" | "inactive" | "closed" | string & object)[]The lifecycle status of the account. - active - The account is active and can be used. - inactive - The account is inactive and doesn't have access to any resources. - closed - The account is closed and can't be used.
parameters.claimStatus?string & object | "managed" | "unmanaged"The claim status for the user account. By default, both managed and unmanaged accounts are returned. - managed - Returns only managed accounts. For more on managed accounts: https://support.atlassian.com/user-management/docs/what-are-managed-accounts/ - unmanaged - Returns only unmanaged accounts.
parameters.cursor?stringSets the starting point for the page of results to return.
parameters.directoryId?stringUnique ID associated with a directory. The - character can be used to increase the operation scope to all directories the requestor has permission to manage.
parameters.directoryIds?string[]A list of directory IDs. The requestor must have permissions to administer resources linked to these directories.
parameters.emailDomains?string[]The email domain to filter the results. The email domain will be used to search against the account email domain. For example, get all users with the @atlassian.com or @example.com email domain.
parameters.emails?string[]List of full email addresses to filter by. Only exact matches are returned. Mutually exclusive with searchTerm — providing both returns a 400 Bad Request error.
parameters.expand?( | "groups" | string & object | "platformRoles" | "productAccess" | "counts.resources")[]List of additional fields to include in the response. Available values: - platformRoles – the user's organization-level admin role assignments (for example, org admin, site admin, or unit admin). - counts.resources – the number of resources the user has access to. - productAccess – the user's last active timestamp for each product in the given directory. - groups – the user's group memberships within the requested directory (id, name, description).
parameters.groupIds?string[]A list of group IDs.
parameters.limit?numberThe number of results to return per page. Defaults to 50.
parameters.membershipStatus?("active" | "suspended" | string & object | "no_membership")[]A list of membership statuses. The membership status is the status of the user account in the organization. - active - the account has an active membership for one or more directories within the organization. - suspended - the account is suspended in ALL directories within the organization, to which the requestor has permission to access. - no_membership - the account is in NONE of the organization’s directories.
parameters.mfaEnabled?booleanWhether or not a managed account has two-step verification enabled on their account. If true, they have two-step verification enabled. By default, all accounts are returned, regardless of two-step verification status.
parameters.orgId?stringYour organization has a unique ID. Find this ID in your Atlassian Administration URL or when you create your API key.
parameters.resourceIds?string[]A list of resource IDs. The resource IDs should be specified using the Atlassian Resource Identifier (ARI) format. Example ARI: ari:cloud:jira-core::site/1
parameters.roleIds?( | string & object | "atlassian/org-admin" | "atlassian/site-admin" | "atlassian/user-access-admin" | "atlassian/ai-access" | "atlassian/user" | "atlassian/admin" | "atlassian/guest" | "atlassian/customer" | "atlassian/contributor" | "atlassian/basic" | "atlassian/stakeholder")[]A list of role IDs. The Atlassian canonical roles are used to determine the permissions of the user against resources within the organization. The allowed roles are: - atlassian/user - Can access the product, with no product admin permissions - atlassian/admin - Can access the product, with product admin permissions - atlassian/guest - Can only access one space you or space admins specify - atlassian/customer - (Jira Service Management) Can visit help center, submit help requests, and view articles (non-billable) - atlassian/user-access-admin - No product access. Can administer users and groups for this product in Atlassian Administration - atlassian/contributor - Can access the product to view, comment, and vote only (non-billable) - atlassian/basic - Can access basic product features, with no product admin permissions (non-billable) - atlassian/stakeholder - Can receive incident updates and has the same product access as Customer. Non-billable but available only on Premium and Enterprise plans - atlassian/org-admin - An organization admin is the highest level of admin and can complete any administrative task in Atlassian Administration - atlassian/site-admin - Site admins can access Atlassian Administration and complete tasks related to the specific site they are administering. - atlassian/ai-access - Can use AI features in AI-enabled apps they have access to.
parameters.searchTerm?stringFree-text search term matched against display names and email addresses. Mutually exclusive with emails — providing both returns a 400 Bad Request error.
parameters.sortBy?object[]The field and direction to sort the results by. Currently, only a single field can be sorted by. If null, the default sorting will be used.
parameters.status?( | "active" | "suspended" | string & object | "not_invited" | "deactivated" | "for_deletion")[]The status for the user account. This status is a composite of accountStatus and membershipStatus. - active - accountStatus is active and membershipStatus is active. - suspended - accountStatus is active and membershipStatus is suspended. - not_invited - accountStatus is active and membershipStatus is no_membership. - deactivated - accountStatus is inactive. - for_deletion - Indicates whether or not a managed account is scheduled for deletion.
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; data: object[]; links?: { [key: string]: unknown; next?: string | null; prev?: string | null; self?: string | null; }; }>

users.suspendDirectoryUser ​

ts
suspendDirectoryUser: (parameters, options?) => Promise<void>;
Parameters ​
ParameterTypeDescription
parameters{ accountId: string; directoryId: string; orgId: string; }-
parameters.accountIdstringEvery user has a unique ID. Find a user’s account ID by using the Get users endpoint.
parameters.directoryId?stringA directory has a unique ID. Use the Get directories endpoint to find the directory ID.
parameters.orgId?stringYour organization has a unique ID. Find this ID in your Atlassian Administration URL or when you create your API key.
options?RequestOptions-
Returns ​

Promise<void>

workspaces ​

ts
workspaces: object;

workspaces.queryWorkspaces ​

ts
queryWorkspaces: (parameters, options?) => Promise<{
[key: string]: unknown;
  data?: object[];
  links?: {
   [key: string]: unknown;
     next?: string | null;
     prev?: string | null;
     self?: string | null;
  };
  meta?: {
   [key: string]: unknown;
     attributes?: unknown;
     endIndex?: number | null;
     pageSize?: number;
     startIndex?: number | null;
     total?: number;
  };
}>;
Parameters ​
ParameterTypeDescription
parameters{ cursor?: string | null; limit?: number; orgId: string; query?: QueryVariantsInput; sort?: object[] | null; }-
parameters.cursor?string | nullA base-64 encoded continuation token used for pagination. When a cursor is provided in the request body, no other properties may be present.
parameters.limit?numberSpecifies the maximum page size.
parameters.orgId?stringYour organization has a unique ID. Find this ID in your Atlassian Administration URL or when you create your API key.
parameters.query?QueryVariantsInput-
parameters.sort?object[] | null-
options?RequestOptions-
Returns ​

Promise<{ [key: string]: unknown; data?: object[]; links?: { [key: string]: unknown; next?: string | null; prev?: string | null; self?: string | null; }; meta?: { [key: string]: unknown; attributes?: unknown; endIndex?: number | null; pageSize?: number; startIndex?: number | null; total?: number; }; }>