Liking cljdoc? Tell your friends :D

atlassian.jira.permissions

Jira Cloud permissions, permission schemes, and issue security schemes.

Covers:

  • /mypermissions, /permissions — current-user and all permissions
  • /permissionscheme — CRUD on permission schemes and grants
  • /issuesecurityschemes — CRUD on issue security schemes, levels, and members
  • /project/{id}/permissionscheme, /project/{id}/securitylevel — project-scoped ops
Jira Cloud permissions, permission schemes, and issue security schemes.

Covers:
 - /mypermissions, /permissions — current-user and all permissions
 - /permissionscheme — CRUD on permission schemes and grants
 - /issuesecurityschemes — CRUD on issue security schemes, levels, and members
 - /project/{id}/permissionscheme, /project/{id}/securitylevel — project-scoped ops
raw docstring

add-security-levelclj

(add-security-level client scheme-id body)

Add issue security levels to a scheme. PUT /rest/api/3/issuesecurityschemes/{schemeId}/level Path params: schemeId — the ID of the issue security scheme. Body: AddSecuritySchemeLevelsRequestBean {:levels [{:name, :description, :isDefault, :members []}]}

Add issue security levels to a scheme.
PUT /rest/api/3/issuesecurityschemes/{schemeId}/level
Path params: schemeId — the ID of the issue security scheme.
Body: AddSecuritySchemeLevelsRequestBean {:levels [{:name, :description, :isDefault, :members []}]}
sourceraw docstring

add-security-level-membersclj

(add-security-level-members client scheme-id level-id body)

Add issue security level members. PUT /rest/api/3/issuesecurityschemes/{schemeId}/level/{levelId}/member Path params: schemeId, levelId. Body: SecuritySchemeMembersRequest {:members [{:type, :parameter}]}

Add issue security level members.
PUT /rest/api/3/issuesecurityschemes/{schemeId}/level/{levelId}/member
Path params: schemeId, levelId.
Body: SecuritySchemeMembersRequest {:members [{:type, :parameter}]}
sourceraw docstring

assign-permission-schemeclj

(assign-permission-scheme client project-key-or-id body)
(assign-permission-scheme client project-key-or-id body opts)

Assign permission scheme — assigns a permission scheme to a project. PUT /rest/api/3/project/{projectKeyOrId}/permissionscheme Path params: projectKeyOrId — the project ID or key (case sensitive). Body: IdBean {:id} opts keys: expand

Assign permission scheme — assigns a permission scheme to a project.
PUT /rest/api/3/project/{projectKeyOrId}/permissionscheme
Path params: projectKeyOrId — the project ID or key (case sensitive).
Body: IdBean {:id}
opts keys: expand
sourceraw docstring

associate-schemes-to-projectsclj

(associate-schemes-to-projects client body)

Associate security scheme to project. PUT /rest/api/3/issuesecurityschemes/project Body: AssociateSecuritySchemeWithProjectDetails {:issueSecuritySchemeId, :projectId}

Associate security scheme to project.
PUT /rest/api/3/issuesecurityschemes/project
Body: AssociateSecuritySchemeWithProjectDetails {:issueSecuritySchemeId, :projectId}
sourceraw docstring

create-issue-security-schemeclj

(create-issue-security-scheme client body)

Create issue security scheme. POST /rest/api/3/issuesecurityschemes Body: CreateIssueSecuritySchemeDetails {:name, :description, :levels []}

Create issue security scheme.
POST /rest/api/3/issuesecurityschemes
Body: CreateIssueSecuritySchemeDetails {:name, :description, :levels []}
sourceraw docstring

create-permission-grantclj

(create-permission-grant client scheme-id body)
(create-permission-grant client scheme-id body opts)

Create permission grant — add a permission grant to a permission scheme. POST /rest/api/3/permissionscheme/{schemeId}/permission Path params: schemeId — the ID of the permission scheme. Body: PermissionGrant {:permission, :holder {:type, :parameter}} opts keys: expand

Create permission grant — add a permission grant to a permission scheme.
POST /rest/api/3/permissionscheme/{schemeId}/permission
Path params: schemeId — the ID of the permission scheme.
Body: PermissionGrant {:permission, :holder {:type, :parameter}}
opts keys: expand
sourceraw docstring

create-permission-schemeclj

(create-permission-scheme client body)
(create-permission-scheme client body opts)

Create permission scheme. POST /rest/api/3/permissionscheme Body: PermissionScheme {:name, :description, :permissions []} opts keys: expand

Create permission scheme.
POST /rest/api/3/permissionscheme
Body: PermissionScheme {:name, :description, :permissions []}
opts keys: expand
sourceraw docstring

delete-permission-schemeclj

(delete-permission-scheme client scheme-id)

Delete permission scheme. DELETE /rest/api/3/permissionscheme/{schemeId} Path params: schemeId — the ID of the permission scheme to delete.

Delete permission scheme.
DELETE /rest/api/3/permissionscheme/{schemeId}
Path params: schemeId — the ID of the permission scheme to delete.
sourceraw docstring

delete-permission-scheme-entityclj

(delete-permission-scheme-entity client scheme-id permission-id)

Delete permission scheme grant — removes a permission grant from a permission scheme. DELETE /rest/api/3/permissionscheme/{schemeId}/permission/{permissionId} Path params: schemeId, permissionId.

Delete permission scheme grant — removes a permission grant from a permission scheme.
DELETE /rest/api/3/permissionscheme/{schemeId}/permission/{permissionId}
Path params: schemeId, permissionId.
sourceraw docstring

delete-security-schemeclj

(delete-security-scheme client scheme-id)

Delete issue security scheme. DELETE /rest/api/3/issuesecurityschemes/{schemeId} Path params: schemeId — the ID of the issue security scheme.

Delete issue security scheme.
DELETE /rest/api/3/issuesecurityschemes/{schemeId}
Path params: schemeId — the ID of the issue security scheme.
sourceraw docstring

get-all-permission-schemesclj

(get-all-permission-schemes client)
(get-all-permission-schemes client opts)

Get all permission schemes. GET /rest/api/3/permissionscheme opts keys: expand

Get all permission schemes.
GET /rest/api/3/permissionscheme
opts keys: expand
sourceraw docstring

get-all-permissionsclj

(get-all-permissions client)

Get all permissions — returns all system and project permissions. GET /rest/api/3/permissions

Get all permissions — returns all system and project permissions.
GET /rest/api/3/permissions
sourceraw docstring

get-assigned-permission-schemeclj

(get-assigned-permission-scheme client project-key-or-id)
(get-assigned-permission-scheme client project-key-or-id opts)

Get assigned permission scheme — the permission scheme assigned to a project. GET /rest/api/3/project/{projectKeyOrId}/permissionscheme Path params: projectKeyOrId — the project ID or key (case sensitive). opts keys: expand

Get assigned permission scheme — the permission scheme assigned to a project.
GET /rest/api/3/project/{projectKeyOrId}/permissionscheme
Path params: projectKeyOrId — the project ID or key (case sensitive).
opts keys: expand
sourceraw docstring

get-bulk-permissionsclj

(get-bulk-permissions client body)

Get bulk permissions — check multiple permissions for one or more contexts. POST /rest/api/3/permissions/check Body: BulkPermissionsRequestBean {:globalPermissions [], :projectPermissions []}

Get bulk permissions — check multiple permissions for one or more contexts.
POST /rest/api/3/permissions/check
Body: BulkPermissionsRequestBean {:globalPermissions [], :projectPermissions []}
sourceraw docstring

get-issue-security-levelclj

(get-issue-security-level client id)

Get issue security level by ID. GET /rest/api/3/securitylevel/{id} Path params: id — the ID of the issue security level.

Get issue security level by ID.
GET /rest/api/3/securitylevel/{id}
Path params: id — the ID of the issue security level.
sourceraw docstring

get-issue-security-level-membersclj

(get-issue-security-level-members client issue-security-scheme-id)
(get-issue-security-level-members client issue-security-scheme-id opts)

Get issue security level members by issue security scheme. GET /rest/api/3/issuesecurityschemes/{issueSecuritySchemeId}/members Path params: issueSecuritySchemeId. opts keys: startAt, maxResults, issueSecurityLevelId (array), expand

Get issue security level members by issue security scheme.
GET /rest/api/3/issuesecurityschemes/{issueSecuritySchemeId}/members
Path params: issueSecuritySchemeId.
opts keys: startAt, maxResults, issueSecurityLevelId (array), expand
sourceraw docstring

get-issue-security-schemeclj

(get-issue-security-scheme client id)

Get issue security scheme by ID. GET /rest/api/3/issuesecurityschemes/{id} Path params: id — the ID of the issue security scheme.

Get issue security scheme by ID.
GET /rest/api/3/issuesecurityschemes/{id}
Path params: id — the ID of the issue security scheme.
sourceraw docstring

get-issue-security-schemesclj

(get-issue-security-schemes client)

Get issue security schemes — all issue security schemes. GET /rest/api/3/issuesecurityschemes

Get issue security schemes — all issue security schemes.
GET /rest/api/3/issuesecurityschemes
sourceraw docstring

get-my-permissionsclj

(get-my-permissions client)
(get-my-permissions client opts)

Get my permissions — which permissions the current user has, optionally scoped to a project or issue. GET /rest/api/3/mypermissions opts keys: projectKey, projectId, issueKey, issueId, permissions (CSV), projectUuid, projectConfigurationUuid, commentId

Get my permissions — which permissions the current user has, optionally
scoped to a project or issue.
GET /rest/api/3/mypermissions
opts keys: projectKey, projectId, issueKey, issueId, permissions (CSV),
           projectUuid, projectConfigurationUuid, commentId
sourceraw docstring

get-permission-schemeclj

(get-permission-scheme client scheme-id)
(get-permission-scheme client scheme-id opts)

Get permission scheme. GET /rest/api/3/permissionscheme/{schemeId} Path params: schemeId — the ID of the permission scheme. opts keys: expand

Get permission scheme.
GET /rest/api/3/permissionscheme/{schemeId}
Path params: schemeId — the ID of the permission scheme.
opts keys: expand
sourceraw docstring

get-permission-scheme-grantclj

(get-permission-scheme-grant client scheme-id permission-id)
(get-permission-scheme-grant client scheme-id permission-id opts)

Get permission scheme grant — a single permission grant. GET /rest/api/3/permissionscheme/{schemeId}/permission/{permissionId} Path params: schemeId, permissionId. opts keys: expand

Get permission scheme grant — a single permission grant.
GET /rest/api/3/permissionscheme/{schemeId}/permission/{permissionId}
Path params: schemeId, permissionId.
opts keys: expand
sourceraw docstring

get-permission-scheme-grantsclj

(get-permission-scheme-grants client scheme-id)
(get-permission-scheme-grants client scheme-id opts)

Get permission scheme grants — all grants for a permission scheme. GET /rest/api/3/permissionscheme/{schemeId}/permission Path params: schemeId — the ID of the permission scheme. opts keys: expand

Get permission scheme grants — all grants for a permission scheme.
GET /rest/api/3/permissionscheme/{schemeId}/permission
Path params: schemeId — the ID of the permission scheme.
opts keys: expand
sourceraw docstring

get-permitted-projectsclj

(get-permitted-projects client body)

Get permitted projects — returns projects where the caller has specified permissions. POST /rest/api/3/permissions/project Body: PermissionsKeysBean {:permissions []}

Get permitted projects — returns projects where the caller has specified permissions.
POST /rest/api/3/permissions/project
Body: PermissionsKeysBean {:permissions []}
sourceraw docstring

get-project-issue-security-schemeclj

(get-project-issue-security-scheme client project-key-or-id)

Get project issue security scheme — the security scheme associated with a project. GET /rest/api/3/project/{projectKeyOrId}/issuesecuritylevelscheme Path params: projectKeyOrId — the project ID or key (case sensitive).

Get project issue security scheme — the security scheme associated with a project.
GET /rest/api/3/project/{projectKeyOrId}/issuesecuritylevelscheme
Path params: projectKeyOrId — the project ID or key (case sensitive).
sourceraw docstring

get-security-level-membersclj

(get-security-level-members client)
(get-security-level-members client opts)

Get issue security level members — paginated list of security level members. GET /rest/api/3/issuesecurityschemes/level/member opts keys: startAt, maxResults, id (array), schemeId (array), levelId (array), expand

Get issue security level members — paginated list of security level members.
GET /rest/api/3/issuesecurityschemes/level/member
opts keys: startAt, maxResults, id (array), schemeId (array), levelId (array), expand
sourceraw docstring

get-security-levelsclj

(get-security-levels client)
(get-security-levels client opts)

Get issue security levels — paginated list of issue security levels. GET /rest/api/3/issuesecurityschemes/level opts keys: startAt, maxResults, id (array), schemeId (array), onlyDefault

Get issue security levels — paginated list of issue security levels.
GET /rest/api/3/issuesecurityschemes/level
opts keys: startAt, maxResults, id (array), schemeId (array), onlyDefault
sourceraw docstring

get-security-levels-for-projectclj

(get-security-levels-for-project client project-key-or-id)

Get project issue security levels — security levels visible to the user for a project. GET /rest/api/3/project/{projectKeyOrId}/securitylevel Path params: projectKeyOrId — the project ID or key (case sensitive).

Get project issue security levels — security levels visible to the user for a project.
GET /rest/api/3/project/{projectKeyOrId}/securitylevel
Path params: projectKeyOrId — the project ID or key (case sensitive).
sourceraw docstring

remove-levelclj

(remove-level client scheme-id level-id)
(remove-level client scheme-id level-id opts)

Remove issue security level from a scheme. DELETE /rest/api/3/issuesecurityschemes/{schemeId}/level/{levelId} Path params: schemeId, levelId. opts keys: replaceWith (ID of replacement level)

Remove issue security level from a scheme.
DELETE /rest/api/3/issuesecurityschemes/{schemeId}/level/{levelId}
Path params: schemeId, levelId.
opts keys: replaceWith (ID of replacement level)
sourceraw docstring

remove-member-from-security-levelclj

(remove-member-from-security-level client scheme-id level-id member-id)

Remove member from issue security level. DELETE /rest/api/3/issuesecurityschemes/{schemeId}/level/{levelId}/member/{memberId} Path params: schemeId, levelId, memberId.

Remove member from issue security level.
DELETE /rest/api/3/issuesecurityschemes/{schemeId}/level/{levelId}/member/{memberId}
Path params: schemeId, levelId, memberId.
sourceraw docstring

search-projects-using-security-schemesclj

(search-projects-using-security-schemes client)
(search-projects-using-security-schemes client opts)

Get projects using issue security schemes — paginated. GET /rest/api/3/issuesecurityschemes/project opts keys: startAt, maxResults, issueSecuritySchemeId (array), projectId (array)

Get projects using issue security schemes — paginated.
GET /rest/api/3/issuesecurityschemes/project
opts keys: startAt, maxResults, issueSecuritySchemeId (array), projectId (array)
sourceraw docstring

search-security-schemesclj

(search-security-schemes client)
(search-security-schemes client opts)

Search issue security schemes — filtered, paginated. GET /rest/api/3/issuesecurityschemes/search opts keys: startAt, maxResults, id (array), projectId (array)

Search issue security schemes — filtered, paginated.
GET /rest/api/3/issuesecurityschemes/search
opts keys: startAt, maxResults, id (array), projectId (array)
sourceraw docstring

set-default-levelsclj

(set-default-levels client body)

Set default issue security levels — sets the default security level for schemes. PUT /rest/api/3/issuesecurityschemes/level/default Body: SetDefaultLevelsRequest {:defaultValues [{:issueSecuritySchemeId, :defaultLevelId}]}

Set default issue security levels — sets the default security level for schemes.
PUT /rest/api/3/issuesecurityschemes/level/default
Body: SetDefaultLevelsRequest {:defaultValues [{:issueSecuritySchemeId, :defaultLevelId}]}
sourceraw docstring

update-issue-security-schemeclj

(update-issue-security-scheme client id body)

Update issue security scheme. PUT /rest/api/3/issuesecurityschemes/{id} Path params: id — the ID of the issue security scheme. Body: UpdateIssueSecuritySchemeRequestBean {:name, :description}

Update issue security scheme.
PUT /rest/api/3/issuesecurityschemes/{id}
Path params: id — the ID of the issue security scheme.
Body: UpdateIssueSecuritySchemeRequestBean {:name, :description}
sourceraw docstring

update-permission-schemeclj

(update-permission-scheme client scheme-id body)
(update-permission-scheme client scheme-id body opts)

Update permission scheme. PUT /rest/api/3/permissionscheme/{schemeId} Path params: schemeId — the ID of the permission scheme. Body: PermissionScheme {:name, :description, :permissions []} opts keys: expand

Update permission scheme.
PUT /rest/api/3/permissionscheme/{schemeId}
Path params: schemeId — the ID of the permission scheme.
Body: PermissionScheme {:name, :description, :permissions []}
opts keys: expand
sourceraw docstring

update-security-levelclj

(update-security-level client scheme-id level-id body)

Update issue security level. PUT /rest/api/3/issuesecurityschemes/{schemeId}/level/{levelId} Path params: schemeId, levelId. Body: UpdateIssueSecurityLevelDetails {:name, :description}

Update issue security level.
PUT /rest/api/3/issuesecurityschemes/{schemeId}/level/{levelId}
Path params: schemeId, levelId.
Body: UpdateIssueSecurityLevelDetails {:name, :description}
sourceraw docstring

cljdoc builds & hosts documentation for Clojure/Script libraries

Keyboard shortcuts
Ctrl+kJump to recent docs
Move to previous article
Move to next article
Ctrl+/Jump to the search field
× close