Class Permissions

Index

Constructors

constructor

Methods

getAllPermissions getBulkPermissions getMyPermissions getPermittedProjects

Constructors

constructor

new Permissions(client: Client): Version3.Permissions
Parameters
- client: Client
Returns Version3.Permissions
- Defined in src/version3/permissions.ts:8

Methods

getAllPermissions

getAllPermissions<T = Version3Models.Permissions>(
callback: Callback<T>,
): Promise<void>
Returns all permissions, including:
- Global permissions.
- Project permissions.
- Global permissions added by plugins.
This operation can be accessed anonymously.

Permissions required: None.
Type Parameters
- T = Version3Models.Permissions
Parameters
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/permissions.ts:117
getAllPermissions<T = Version3Models.Permissions>(
callback?: undefined,
): Promise<T>
Returns all permissions, including:
- Global permissions.
- Project permissions.
- Global permissions added by plugins.
This operation can be accessed anonymously.

Permissions required: None.
Type Parameters
- T = Version3Models.Permissions
Parameters
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/permissions.ts:129

getBulkPermissions

getBulkPermissions<T = Version3Models.BulkPermissionGrants>(
parameters: undefined | Version3Parameters.GetBulkPermissions,
callback: Callback<T>,
): Promise<void>
Returns:
- For a list of global permissions, the global permissions granted to a user.
- For a list of project permissions and lists of projects and issues, for each project permission a list of the projects and issues a user can access or manipulate.
If no account ID is provided, the operation returns details for the logged in user.

Note that:
- Invalid project and issue IDs are ignored.
- A maximum of 1000 projects and 1000 issues can be checked.
- Null values in globalPermissions, projectPermissions, projectPermissions.projects, and projectPermissions.issues are ignored.
- Empty strings in projectPermissions.permissions are ignored.
Deprecation notice: The required OAuth 2.0 scopes will be updated on June 15, 2024.
- Classic: read:jira-work
- Granular: read:permission:jira
This operation can be accessed anonymously.

Permissions required: Administer Jira global permission to check the permissions for other users, otherwise none. However, Connect apps can make a call from the app server to the product to obtain permission details for any user, without admin permission. This Connect app ability doesn't apply to calls made using AP.request() in a browser.
Type Parameters
- T = Version3Models.BulkPermissionGrants
Parameters
- parameters: undefined | Version3Parameters.GetBulkPermissions
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/permissions.ts:169
getBulkPermissions<T = Version3Models.BulkPermissionGrants>(
parameters?: Version3Parameters.GetBulkPermissions,
callback?: undefined,
): Promise<T>
Returns:
- For a list of global permissions, the global permissions granted to a user.
- For a list of project permissions and lists of projects and issues, for each project permission a list of the projects and issues a user can access or manipulate.
If no account ID is provided, the operation returns details for the logged in user.

Note that:
- Invalid project and issue IDs are ignored.
- A maximum of 1000 projects and 1000 issues can be checked.
- Null values in globalPermissions, projectPermissions, projectPermissions.projects, and projectPermissions.issues are ignored.
- Empty strings in projectPermissions.permissions are ignored.
Deprecation notice: The required OAuth 2.0 scopes will be updated on June 15, 2024.
- Classic: read:jira-work
- Granular: read:permission:jira
This operation can be accessed anonymously.

Permissions required: Administer Jira global permission to check the permissions for other users, otherwise none. However, Connect apps can make a call from the app server to the product to obtain permission details for any user, without admin permission. This Connect app ability doesn't apply to calls made using AP.request() in a browser.
Type Parameters
- T = Version3Models.BulkPermissionGrants
Parameters
- Optionalparameters: Version3Parameters.GetBulkPermissions
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/permissions.ts:203

getMyPermissions

getMyPermissions<T = Version3Models.Permissions>(
parameters: undefined | Version3Parameters.GetMyPermissions,
callback: Callback<T>,
): Promise<void>
Returns a list of permissions indicating which permissions the user has. Details of the user's permissions can be obtained in a global, project, issue or comment context.

The user is reported as having a project permission:
- In the global context, if the user has the project permission in any project.
- For a project, where the project permission is determined using issue data, if the user meets the permission's criteria for any issue in the project. Otherwise, if the user has the project permission in the project.
- For an issue, where a project permission is determined using issue data, if the user has the permission in the issue. Otherwise, if the user has the project permission in the project containing the issue.
- For a comment, where the user has both the permission to browse the comment and the project permission for the comment's parent issue. Only the BROWSE_PROJECTS permission is supported. If a commentId is provided whose permissions does not equal BROWSE_PROJECTS, a 400 error will be returned.
This means that users may be shown as having an issue permission (such as EDIT_ISSUES) in the global context or a project context but may not have the permission for any or all issues. For example, if Reporters have the EDIT_ISSUES permission a user would be shown as having this permission in the global context or the context of a project, because any user can be a reporter. However, if they are not the user who reported the issue queried they would not have EDIT_ISSUES permission for that issue.

For Jira Service Management project permissions, this will be evaluated similarly to a user in the customer portal. For example, if the BROWSE_PROJECTS permission is granted to Service Project Customer - Portal Access, any users with access to the customer portal will have the BROWSE_PROJECTS permission.

Global permissions are unaffected by context.

This operation can be accessed anonymously.

Permissions required: None.
Type Parameters
- T = Version3Models.Permissions
Parameters
- parameters: undefined | Version3Parameters.GetMyPermissions
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/permissions.ts:43
getMyPermissions<T = Version3Models.Permissions>(
parameters?: Version3Parameters.GetMyPermissions,
callback?: undefined,
): Promise<T>
Returns a list of permissions indicating which permissions the user has. Details of the user's permissions can be obtained in a global, project, issue or comment context.

The user is reported as having a project permission:
- In the global context, if the user has the project permission in any project.
- For a project, where the project permission is determined using issue data, if the user meets the permission's criteria for any issue in the project. Otherwise, if the user has the project permission in the project.
- For an issue, where a project permission is determined using issue data, if the user has the permission in the issue. Otherwise, if the user has the project permission in the project containing the issue.
- For a comment, where the user has both the permission to browse the comment and the project permission for the comment's parent issue. Only the BROWSE_PROJECTS permission is supported. If a commentId is provided whose permissions does not equal BROWSE_PROJECTS, a 400 error will be returned.
This means that users may be shown as having an issue permission (such as EDIT_ISSUES) in the global context or a project context but may not have the permission for any or all issues. For example, if Reporters have the EDIT_ISSUES permission a user would be shown as having this permission in the global context or the context of a project, because any user can be a reporter. However, if they are not the user who reported the issue queried they would not have EDIT_ISSUES permission for that issue.

For Jira Service Management project permissions, this will be evaluated similarly to a user in the customer portal. For example, if the BROWSE_PROJECTS permission is granted to Service Project Customer - Portal Access, any users with access to the customer portal will have the BROWSE_PROJECTS permission.

Global permissions are unaffected by context.

This operation can be accessed anonymously.

Permissions required: None.
Type Parameters
- T = Version3Models.Permissions
Parameters
- Optionalparameters: Version3Parameters.GetMyPermissions
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/permissions.ts:80

getPermittedProjects

getPermittedProjects<T = Version3Models.PermittedProjects>(
parameters: undefined | Version3Parameters.GetPermittedProjects,
callback: Callback<T>,
): Promise<void>
Returns all the projects where the user is granted a list of project permissions.

This operation can be accessed anonymously.

Permissions required: None.
Type Parameters
- T = Version3Models.PermittedProjects
Parameters
- parameters: undefined | Version3Parameters.GetPermittedProjects
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/permissions.ts:231
getPermittedProjects<T = Version3Models.PermittedProjects>(
parameters?: Version3Parameters.GetPermittedProjects,
callback?: undefined,
): Promise<T>
Returns all the projects where the user is granted a list of project permissions.

This operation can be accessed anonymously.

Permissions required: None.
Type Parameters
- T = Version3Models.PermittedProjects
Parameters
- Optionalparameters: Version3Parameters.GetPermittedProjects
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/permissions.ts:242

Class Permissions

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns Version3.Permissions

Methods

getAllPermissions

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getBulkPermissions

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getMyPermissions

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getPermittedProjects

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

Settings

On This Page