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.
string
List of all permission schemes
1
2
3
4
curl --request GET \
--url 'http://{baseurl}/rest/api/2/permissionscheme' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json'Create a new permission scheme. This method can create schemes with a defined permission set, or without.
string
string
string
integer
string
array<PermissionGrantBean>
string
Returned if the scheme is created successfully.
1
2
3
4
5
curl --request POST \
--url 'http://{baseurl}/rest/api/2/permissionscheme' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'Returns the attribute for a permission scheme specified by permission scheme id and attribute key.
integer
Requiredstring
RequiredPermission scheme attribute
1
2
3
4
curl --request GET \
--url 'http://{baseurl}/rest/api/2/permissionscheme/{permissionSchemeId}/attribute/{attributeKey}' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json'Updates or inserts the attribute for a permission scheme specified by permission scheme id. The attribute consists of the key and the value. The value will be converted to Boolean using Boolean#valueOf.
integer
Requiredstring
Requiredstring
Returned if the attribute is updated successfully.
1
2
3
curl --request PUT \
--url 'http://{baseurl}/rest/api/2/permissionscheme/{permissionSchemeId}/attribute/{key}' \
--user 'email@example.com:<api_token>'Returns a permission scheme identified by the given id.
integer
Requiredstring
Permission scheme
1
2
3
4
curl --request GET \
--url 'http://{baseurl}/rest/api/2/permissionscheme/{schemeId}' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json'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.
integer
Requiredstring
string
string
integer
string
array<PermissionGrantBean>
string
Returned if the scheme is updated successfully.
1
2
3
4
5
curl --request PUT \
--url 'http://{baseurl}/rest/api/2/permissionscheme/{schemeId}' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'Deletes a permission scheme identified by the given id.
integer
RequiredReturned if the permission scheme is successfully deleted.
1
2
3
curl --request DELETE \
--url 'http://{baseurl}/rest/api/2/permissionscheme/{schemeId}' \
--user 'email@example.com:<api_token>'Returns all permission grants of the given permission scheme.
integer
Requiredstring
Permission grants
1
2
3
4
curl --request GET \
--url 'http://{baseurl}/rest/api/2/permissionscheme/{schemeId}/permission' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json'Creates a permission grant in a permission scheme.
integer
Requiredstring
PermissionHolderBean
integer
string
string
Returned if the scheme permission is created successfully.
1
2
3
4
5
curl --request POST \
--url 'http://{baseurl}/rest/api/2/permissionscheme/{schemeId}/permission' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'Returns a permission grant identified by the given id.
integer
Requiredinteger
Requiredstring
Permission grant
1
2
3
4
curl --request GET \
--url 'http://{baseurl}/rest/api/2/permissionscheme/{schemeId}/permission/{permissionId}' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json'Deletes a permission grant from a permission scheme.
integer
Requiredinteger
RequiredReturned if the permission grant is deleted successfully.
1
2
3
curl --request DELETE \
--url 'http://{baseurl}/rest/api/2/permissionscheme/{schemeId}/permission/{permissionId}' \
--user 'email@example.com:<api_token>'Rate this page: