JSDoc: Class: PermissionSchemeClient

new PermissionSchemeClient(jiraClient)

Used to access Jira REST endpoints in '/rest/api/2/permissionscheme'

Parameters:

Name	Type	Description
`jiraClient`	JiraClient

Source:

api/permission-scheme.js, line 5

Methods

createPermissionGrantInScheme(opts, callbackopt) → {Promise}

Creates a permission grant in a permission scheme.

Parameters:

Name Type Attributes Description

opts

The request options sent to the Jira API.

Properties

Name	Type	Description
`schemeId`		The id of the scheme to which the permission grant belongs.
`grant`		See https://docs.atlassian.com/software/jira/docs/api/REST/7.6.1/#api/2/permissionscheme-createPermissionGrant

callback

Called when the permission grant has been created.

Source:

api/permission-scheme.js, line 178

Returns:

Resolved when the permission grant has been created.

Type: Promise

createPermissionScheme(opts, callbackopt) → {Promise}

Create a new permission scheme. This method can create schemes with a defined permission set, or without.

Parameters:

Name Type Attributes Description

opts

The request options sent to the Jira API.

Properties

Name	Type	Description
`scheme`		See https://developer.atlassian.com/cloud/jira/platform/rest/#api-api-2-permissionscheme-post

callback

Called when the scheme has been created.

Source:

api/permission-scheme.js, line 46

Returns:

Resolved when the scheme has been created.

Type: Promise

deletePermissionGrantFromScheme(opts, callbackopt) → {Promise}

Deletes a permission grant from a permission scheme.

Parameters:

Name Type Attributes Description

opts

The request options sent to the Jira API

Properties

Name	Type	Description
`schemeId`		The name of the scheme to delete.
`permissionId`		The id of the permission to delete.

callback

Called when the scheme has been deleted.

Source:

api/permission-scheme.js, line 201

Returns:

Resolved when the scheme has been deleted.

Type: Promise

deletePermissionScheme(opts, callbackopt) → {Promise}

Removes Permission Scheme.

Parameters:

Name Type Attributes Description

opts

The request options sent to the Jira API

Properties

Name	Type	Description
`schemeId`		The name of the scheme to delete.

callback

Called when the scheme has been deleted.

Source:

api/permission-scheme.js, line 128

Returns:

Resolved when the scheme has been deleted.

Type: Promise

editPermissionScheme(opts, callbackopt) → {Promise}

Updates a permission scheme.

If the permissions list is present then it will be set in the permission scheme, which basically means it will overwrite any permission grants that existed in the permission scheme. Sending an empty list will remove all permission grants from the permission scheme.

To update just the name and description, do not send permissions list at all. To add or remove a single permission grant instead of updating the whole list at once use the {schemeId}/permission/ resource.

Parameters:

Name Type Attributes Description

opts

The request options sent to the Jira API

Properties

Name	Type	Description
`schemeId`		The id of the scheme to retrieve.
`scheme`		The body of the scheme to edit.

callback

Called when the user has been edited.

Source:

api/permission-scheme.js, line 97

Returns:

Resolved when the user has been edited.

Type: Promise

getAllPermissionSchemes(opts, callbackopt) → {Promise}

Returns a list of all permission schemes.

By default only shortened beans are returned. If you want to include permissions of all the schemes, then specify the permissions expand parameter. Permissions will be included also if you specify any other expand parameter.

Parameters:

Name Type Attributes Description

opts

Object

The request options sent to the Jira API.

Properties

Name	Type	Description
`expand`	String \| Array

callback

Called when the schemes have been returned.

Source:

api/permission-scheme.js, line 14

Returns:

Resolved when the schemes have been returned.

Type: Promise

getPermissionScheme(opts, callbackopt) → {Promise}

Get a PermissionScheme. This resource cannot be accessed anonymously.

Parameters:

Name Type Attributes Description

opts

The request options sent to the Jira API

Properties

Name	Type	Description
`schemeId`		The id of the scheme to retrieve.
`expand`	Object	The fields to be expanded.

callback

Called when the scheme has been retrieved.

Source:

api/permission-scheme.js, line 68

Returns:

Resolved when the scheme has been retrieved.

Type: Promise

getPermissionSchemeGrantById(opts, callbackopt) → {Promise}

Returns a permission grant identified by the given id.

Parameters:

Name Type Attributes Description

opts

The request options sent to the Jira API

Properties

Name	Type	Description
`schemeId`		The id of the scheme to which the permission grant belongs.
`permissionId`		The id of the permission to fetch.
`expand`	Object	The fields to be expanded.

callback

Called when the scheme grants have been retrieved.

Source:

api/permission-scheme.js, line 223

Returns:

Resolved when the scheme grants have been retrieved.

Type: Promise

getPermissionSchemeGrants(opts, callbackopt) → {Promise}

Returns all permission grants of the given permission scheme.

Parameters:

Name Type Attributes Description

opts

The request options sent to the Jira API

Properties

Name	Type	Description
`schemeId`		The id of the scheme to which the permission grant belongs.
`expand`	Object	The fields to be expanded.

callback

Called when the scheme grants have been retrieved.

Source:

api/permission-scheme.js, line 149

Returns:

Resolved when the scheme grants have been retrieved.

Type: Promise