{
"opencollection": "1.0.0",
"info": {
"name": "Atlassian Admin Account Permission Schemes API",
"version": "1.0.0"
},
"request": {
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"items": [
{
"info": {
"name": "Permission Schemes",
"type": "folder"
},
"items": [
{
"info": {
"name": "Atlassian Get Permission Scheme",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.atlassian.com/rest/api/3/permissionscheme/:schemeId",
"params": [
{
"name": "schemeId",
"value": "",
"type": "path",
"description": "The ID of the permission scheme to return."
},
{
"name": "expand",
"value": "",
"type": "query",
"description": "Use expand to include additional information in the response. This parameter accepts a comma-separated list. Note that permissions are included when you specify any value. Expand options include:\n\n * `all` Returns all expandable information.\n * `field` Returns information about the custom field granted the permission.\n * `group` Returns information about the group that is granted the permission.\n * `permissions` Returns all permission grants for each permission scheme.\n * `projectRole` Returns information about the project role granted the permission.\n * `user` Returns information about the user who is granted the permission."
}
]
},
"docs": "Returns a permission scheme.
**[Permissions](#permissions) required:** Permission to access Jira."
},
{
"info": {
"name": "Atlassian Update Permission Scheme",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.atlassian.com/rest/api/3/permissionscheme/:schemeId",
"params": [
{
"name": "schemeId",
"value": "",
"type": "path",
"description": "The ID of the permission scheme to update."
},
{
"name": "expand",
"value": "",
"type": "query",
"description": "Use expand to include additional information in the response. This parameter accepts a comma-separated list. Note that permissions are always included when you specify any value. Expand options include:\n\n * `all` Returns all expandable information.\n * `field` Returns information about the custom field granted the permission.\n * `group` Returns information about the group that is granted the permission.\n * `permissions` Returns all permission grants for each permission scheme.\n * `projectRole` Returns information about the project role granted the permission.\n * `user` Returns information about the user who is granted the permission."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Updates a permission scheme. Below are some important things to note when using this resource:
* If a permissions list is present in the request, then it is set in the permission scheme, overwriting *all existing* grants.
* If you want to update only the name and description, then do not send a permissions list in the request.
* Sending an empty list will remove all permission grants from the permission scheme.
If you want to add or delete a permission grant instead of "
},
{
"info": {
"name": "Atlassian Delete Permission Scheme",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.atlassian.com/rest/api/3/permissionscheme/:schemeId",
"params": [
{
"name": "schemeId",
"value": "",
"type": "path",
"description": "The ID of the permission scheme being deleted."
}
]
},
"docs": "Deletes a permission scheme.
**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg)."
},
{
"info": {
"name": "Atlassian Get Permission Scheme Grants",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.atlassian.com/rest/api/3/permissionscheme/:schemeId/permission",
"params": [
{
"name": "schemeId",
"value": "",
"type": "path",
"description": "The ID of the permission scheme."
},
{
"name": "expand",
"value": "",
"type": "query",
"description": "Use expand to include additional information in the response. This parameter accepts a comma-separated list. Note that permissions are always included when you specify any value. Expand options include:\n\n * `permissions` Returns all permission grants for each permission scheme.\n * `user` Returns information about the user who is granted the permission.\n * `group` Returns information about the group that is granted the permission.\n * `projectRole` Returns information about the project role granted the permission.\n * `field` Returns information about the custom field granted the permission.\n * `all` Returns all expandable information."
}
]
},
"docs": "Returns all permission grants for a permission scheme.
**[Permissions](#permissions) required:** Permission to access Jira."
},
{
"info": {
"name": "Atlassian Create Permission Grant",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.atlassian.com/rest/api/3/permissionscheme/:schemeId/permission",
"params": [
{
"name": "schemeId",
"value": "",
"type": "path",
"description": "The ID of the permission scheme in which to create a new permission grant."
},
{
"name": "expand",
"value": "",
"type": "query",
"description": "Use expand to include additional information in the response. This parameter accepts a comma-separated list. Note that permissions are always included when you specify any value. Expand options include:\n\n * `permissions` Returns all permission grants for each permission scheme.\n * `user` Returns information about the user who is granted the permission.\n * `group` Returns information about the group that is granted the permission.\n * `projectRole` Returns information about the project role granted the permission.\n * `field` Returns information about the custom field granted the permission.\n * `all` Returns all expandable information."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Creates a permission grant in a permission scheme.
**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg)."
},
{
"info": {
"name": "Atlassian Get Permission Scheme Grant",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.atlassian.com/rest/api/3/permissionscheme/:schemeId/permission/:permissionId",
"params": [
{
"name": "schemeId",
"value": "",
"type": "path",
"description": "The ID of the permission scheme."
},
{
"name": "permissionId",
"value": "",
"type": "path",
"description": "The ID of the permission grant."
},
{
"name": "expand",
"value": "",
"type": "query",
"description": "Use expand to include additional information in the response. This parameter accepts a comma-separated list. Note that permissions are always included when you specify any value. Expand options include:\n\n * `all` Returns all expandable information.\n * `field` Returns information about the custom field granted the permission.\n * `group` Returns information about the group that is granted the permission.\n * `permissions` Returns all permission grants for each permission scheme.\n * `projectRole` Returns information about the project role granted the permission.\n * `user` Returns information about the user who is granted the permission."
}
]
},
"docs": "Returns a permission grant.
**[Permissions](#permissions) required:** Permission to access Jira."
},
{
"info": {
"name": "Atlassian Delete Permission Scheme Grant",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.atlassian.com/rest/api/3/permissionscheme/:schemeId/permission/:permissionId",
"params": [
{
"name": "schemeId",
"value": "",
"type": "path",
"description": "The ID of the permission scheme to delete the permission grant from."
},
{
"name": "permissionId",
"value": "",
"type": "path",
"description": "The ID of the permission grant to delete."
}
]
},
"docs": "Deletes a permission grant from a permission scheme. See [About permission schemes and grants](../api-group-permission-schemes/#about-permission-schemes-and-grants) for more details.
**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg)."
},
{
"info": {
"name": "Atlassian Get All Permission Schemes",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.atlassian.com/rest/api/3/permissionscheme",
"params": [
{
"name": "expand",
"value": "",
"type": "query",
"description": "Use expand to include additional information in the response. This parameter accepts a comma-separated list. Note that permissions are included when you specify any value. Expand options include:\n\n * `all` Returns all expandable information.\n * `field` Returns information about the custom field granted the permission.\n * `group` Returns information about the group that is granted the permission.\n * `permissions` Returns all permission grants for each permission scheme.\n * `projectRole` Returns information about the project role granted the permission.\n * `user` Returns information about the user who is granted the permission."
}
]
},
"docs": "Returns all permission schemes.
### About permission schemes and grants ###
A permission scheme is a collection of permission grants. A permission grant consists of a `holder` and a `permission`.
#### Holder object ####
The `holder` object contains information about the user or group being granted the permission. For example, the *Administer projects* permission is granted to a group named *Teams in space administrators*. In this case, the type is `\"type\": \"group\"`, a"
},
{
"info": {
"name": "Atlassian Create Permission Scheme",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.atlassian.com/rest/api/3/permissionscheme",
"params": [
{
"name": "expand",
"value": "",
"type": "query",
"description": "Use expand to include additional information in the response. This parameter accepts a comma-separated list. Note that permissions are always included when you specify any value. Expand options include:\n\n * `all` Returns all expandable information.\n * `field` Returns information about the custom field granted the permission.\n * `group` Returns information about the group that is granted the permission.\n * `permissions` Returns all permission grants for each permission scheme.\n * `projectRole` Returns information about the project role granted the permission.\n * `user` Returns information about the user who is granted the permission."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Creates a new permission scheme. You can create a permission scheme with or without defining a set of permission grants.
**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg)."
}
]
}
],
"bundled": true
}