# TheJiraCloudPlatformRestApi.PermissionSchemesApi All URIs are relative to *https://your-domain.atlassian.net* Method | HTTP request | Description ------------- | ------------- | ------------- [**createPermissionGrant**](PermissionSchemesApi.md#createPermissionGrant) | **POST** /rest/api/3/permissionscheme/{schemeId}/permission | Create permission grant [**createPermissionScheme**](PermissionSchemesApi.md#createPermissionScheme) | **POST** /rest/api/3/permissionscheme | Create permission scheme [**deletePermissionScheme**](PermissionSchemesApi.md#deletePermissionScheme) | **DELETE** /rest/api/3/permissionscheme/{schemeId} | Delete permission scheme [**deletePermissionSchemeEntity**](PermissionSchemesApi.md#deletePermissionSchemeEntity) | **DELETE** /rest/api/3/permissionscheme/{schemeId}/permission/{permissionId} | Delete permission scheme grant [**getAllPermissionSchemes**](PermissionSchemesApi.md#getAllPermissionSchemes) | **GET** /rest/api/3/permissionscheme | Get all permission schemes [**getPermissionScheme**](PermissionSchemesApi.md#getPermissionScheme) | **GET** /rest/api/3/permissionscheme/{schemeId} | Get permission scheme [**getPermissionSchemeGrant**](PermissionSchemesApi.md#getPermissionSchemeGrant) | **GET** /rest/api/3/permissionscheme/{schemeId}/permission/{permissionId} | Get permission scheme grant [**getPermissionSchemeGrants**](PermissionSchemesApi.md#getPermissionSchemeGrants) | **GET** /rest/api/3/permissionscheme/{schemeId}/permission | Get permission scheme grants [**updatePermissionScheme**](PermissionSchemesApi.md#updatePermissionScheme) | **PUT** /rest/api/3/permissionscheme/{schemeId} | Update permission scheme # **createPermissionGrant** > PermissionGrant createPermissionGrant(body, schemeId, opts) Create permission grant Creates a permission grant in a permission scheme. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). ### Example ```javascript import {TheJiraCloudPlatformRestApi} from 'the_jira_cloud_platform_rest_api'; let defaultClient = TheJiraCloudPlatformRestApi.ApiClient.instance; // Configure OAuth2 access token for authorization: OAuth2 let OAuth2 = defaultClient.authentications['OAuth2']; OAuth2.accessToken = 'YOUR ACCESS TOKEN'; // Configure HTTP basic authorization: basicAuth let basicAuth = defaultClient.authentications['basicAuth']; basicAuth.username = 'YOUR USERNAME'; basicAuth.password = 'YOUR PASSWORD'; let apiInstance = new TheJiraCloudPlatformRestApi.PermissionSchemesApi(); let body = new TheJiraCloudPlatformRestApi.PermissionGrant(); // PermissionGrant | The permission grant to create. let schemeId = 789; // Number | The ID of the permission scheme in which to create a new permission grant. let opts = { 'expand': "expand_example" // String | 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: * `permissions` Returns all permission grants for each permission scheme. * `user` Returns information about the user who is granted the permission. * `group` Returns information about the group that is granted the permission. * `projectRole` Returns information about the project role granted the permission. * `field` Returns information about the custom field granted the permission. * `all` Returns all expandable information. }; apiInstance.createPermissionGrant(body, schemeId, opts, (error, data, response) => { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**PermissionGrant**](PermissionGrant.md)| The permission grant to create. | **schemeId** | **Number**| The ID of the permission scheme in which to create a new permission grant. | **expand** | **String**| 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: * `permissions` Returns all permission grants for each permission scheme. * `user` Returns information about the user who is granted the permission. * `group` Returns information about the group that is granted the permission. * `projectRole` Returns information about the project role granted the permission. * `field` Returns information about the custom field granted the permission. * `all` Returns all expandable information. | [optional] ### Return type [**PermissionGrant**](PermissionGrant.md) ### Authorization [OAuth2](../README.md#OAuth2), [basicAuth](../README.md#basicAuth) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json # **createPermissionScheme** > PermissionScheme createPermissionScheme(body, opts) Create permission scheme 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). ### Example ```javascript import {TheJiraCloudPlatformRestApi} from 'the_jira_cloud_platform_rest_api'; let defaultClient = TheJiraCloudPlatformRestApi.ApiClient.instance; // Configure OAuth2 access token for authorization: OAuth2 let OAuth2 = defaultClient.authentications['OAuth2']; OAuth2.accessToken = 'YOUR ACCESS TOKEN'; // Configure HTTP basic authorization: basicAuth let basicAuth = defaultClient.authentications['basicAuth']; basicAuth.username = 'YOUR USERNAME'; basicAuth.password = 'YOUR PASSWORD'; let apiInstance = new TheJiraCloudPlatformRestApi.PermissionSchemesApi(); let body = { "description" : "description", "name" : "Example permission scheme", "permissions" : [ { "holder" : { "parameter" : "jira-core-users", "type" : "group", "value" : "ca85fac0-d974-40ca-a615-7af99c48d24f" }, "permission" : "ADMINISTER_PROJECTS" } ] }; // {String: Object} | The permission scheme to create. let opts = { 'expand': "expand_example" // String | 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: * `all` Returns all expandable information. * `field` Returns information about the custom field granted the permission. * `group` Returns information about the group that is granted the permission. * `permissions` Returns all permission grants for each permission scheme. * `projectRole` Returns information about the project role granted the permission. * `user` Returns information about the user who is granted the permission. }; apiInstance.createPermissionScheme(body, opts, (error, data, response) => { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**{String: Object}**](Object.md)| The permission scheme to create. | **expand** | **String**| 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: * `all` Returns all expandable information. * `field` Returns information about the custom field granted the permission. * `group` Returns information about the group that is granted the permission. * `permissions` Returns all permission grants for each permission scheme. * `projectRole` Returns information about the project role granted the permission. * `user` Returns information about the user who is granted the permission. | [optional] ### Return type [**PermissionScheme**](PermissionScheme.md) ### Authorization [OAuth2](../README.md#OAuth2), [basicAuth](../README.md#basicAuth) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json # **deletePermissionScheme** > deletePermissionScheme(schemeId) Delete permission scheme Deletes a permission scheme. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). ### Example ```javascript import {TheJiraCloudPlatformRestApi} from 'the_jira_cloud_platform_rest_api'; let defaultClient = TheJiraCloudPlatformRestApi.ApiClient.instance; // Configure OAuth2 access token for authorization: OAuth2 let OAuth2 = defaultClient.authentications['OAuth2']; OAuth2.accessToken = 'YOUR ACCESS TOKEN'; // Configure HTTP basic authorization: basicAuth let basicAuth = defaultClient.authentications['basicAuth']; basicAuth.username = 'YOUR USERNAME'; basicAuth.password = 'YOUR PASSWORD'; let apiInstance = new TheJiraCloudPlatformRestApi.PermissionSchemesApi(); let schemeId = 789; // Number | The ID of the permission scheme being deleted. apiInstance.deletePermissionScheme(schemeId, (error, data, response) => { if (error) { console.error(error); } else { console.log('API called successfully.'); } }); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **schemeId** | **Number**| The ID of the permission scheme being deleted. | ### Return type null (empty response body) ### Authorization [OAuth2](../README.md#OAuth2), [basicAuth](../README.md#basicAuth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: Not defined # **deletePermissionSchemeEntity** > deletePermissionSchemeEntity(schemeId, permissionId) Delete permission scheme grant 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). ### Example ```javascript import {TheJiraCloudPlatformRestApi} from 'the_jira_cloud_platform_rest_api'; let defaultClient = TheJiraCloudPlatformRestApi.ApiClient.instance; // Configure OAuth2 access token for authorization: OAuth2 let OAuth2 = defaultClient.authentications['OAuth2']; OAuth2.accessToken = 'YOUR ACCESS TOKEN'; // Configure HTTP basic authorization: basicAuth let basicAuth = defaultClient.authentications['basicAuth']; basicAuth.username = 'YOUR USERNAME'; basicAuth.password = 'YOUR PASSWORD'; let apiInstance = new TheJiraCloudPlatformRestApi.PermissionSchemesApi(); let schemeId = 789; // Number | The ID of the permission scheme to delete the permission grant from. let permissionId = 789; // Number | The ID of the permission grant to delete. apiInstance.deletePermissionSchemeEntity(schemeId, permissionId, (error, data, response) => { if (error) { console.error(error); } else { console.log('API called successfully.'); } }); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **schemeId** | **Number**| The ID of the permission scheme to delete the permission grant from. | **permissionId** | **Number**| The ID of the permission grant to delete. | ### Return type null (empty response body) ### Authorization [OAuth2](../README.md#OAuth2), [basicAuth](../README.md#basicAuth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: Not defined # **getAllPermissionSchemes** > PermissionSchemes getAllPermissionSchemes(opts) Get all permission schemes 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\"`, and the parameter is the group name, `\"parameter\": \"Teams in space administrators\"` and the value is group ID, `\"value\": \"ca85fac0-d974-40ca-a615-7af99c48d24f\"`. The `holder` object is defined by the following properties: * `type` Identifies the user or group (see the list of types below). * `parameter` As a group's name can change, use of `value` is recommended. The value of this property depends on the `type`. For example, if the `type` is a group, then you need to specify the group name. * `value` The value of this property depends on the `type`. If the `type` is a group, then you need to specify the group ID. For other `type` it has the same value as `parameter` The following `types` are available. The expected values for `parameter` and `value` are given in parentheses (some types may not have a `parameter` or `value`): * `anyone` Grant for anonymous users. * `applicationRole` Grant for users with access to the specified application (application name, application name). See [Update product access settings](https://confluence.atlassian.com/x/3YxjL) for more information. * `assignee` Grant for the user currently assigned to an issue. * `group` Grant for the specified group (`parameter` : group name, `value` : group ID). * `groupCustomField` Grant for a user in the group selected in the specified custom field (`parameter` : custom field ID, `value` : custom field ID). * `projectLead` Grant for a project lead. * `projectRole` Grant for the specified project role (`parameter` :project role ID, `value` : project role ID). * `reporter` Grant for the user who reported the issue. * `sd.customer.portal.only` Jira Service Desk only. Grants customers permission to access the customer portal but not Jira. See [Customizing Jira Service Desk permissions](https://confluence.atlassian.com/x/24dKLg) for more information. * `user` Grant for the specified user (`parameter` : user ID - historically this was the userkey but that is deprecated and the account ID should be used, `value` : user ID). * `userCustomField` Grant for a user selected in the specified custom field (`parameter` : custom field ID, `value` : custom field ID). #### Built-in permissions #### The [built-in Jira permissions](https://confluence.atlassian.com/x/yodKLg) are listed below. Apps can also define custom permissions. See the [project permission](https://developer.atlassian.com/cloud/jira/platform/modules/project-permission/) and [global permission](https://developer.atlassian.com/cloud/jira/platform/modules/global-permission/) module documentation for more information. **Project permissions** * `ADMINISTER_PROJECTS` * `BROWSE_PROJECTS` * `MANAGE_SPRINTS_PERMISSION` (Jira Software only) * `SERVICEDESK_AGENT` (Jira Service Desk only) * `VIEW_DEV_TOOLS` (Jira Software only) * `VIEW_READONLY_WORKFLOW` **Issue permissions** * `ASSIGNABLE_USER` * `ASSIGN_ISSUES` * `CLOSE_ISSUES` * `CREATE_ISSUES` * `DELETE_ISSUES` * `EDIT_ISSUES` * `LINK_ISSUES` * `MODIFY_REPORTER` * `MOVE_ISSUES` * `RESOLVE_ISSUES` * `SCHEDULE_ISSUES` * `SET_ISSUE_SECURITY` * `TRANSITION_ISSUES` **Voters and watchers permissions** * `MANAGE_WATCHERS` * `VIEW_VOTERS_AND_WATCHERS` **Comments permissions** * `ADD_COMMENTS` * `DELETE_ALL_COMMENTS` * `DELETE_OWN_COMMENTS` * `EDIT_ALL_COMMENTS` * `EDIT_OWN_COMMENTS` **Attachments permissions** * `CREATE_ATTACHMENTS` * `DELETE_ALL_ATTACHMENTS` * `DELETE_OWN_ATTACHMENTS` **Time tracking permissions** * `DELETE_ALL_WORKLOGS` * `DELETE_OWN_WORKLOGS` * `EDIT_ALL_WORKLOGS` * `EDIT_OWN_WORKLOGS` * `WORK_ON_ISSUES` **[Permissions](#permissions) required:** Permission to access Jira. ### Example ```javascript import {TheJiraCloudPlatformRestApi} from 'the_jira_cloud_platform_rest_api'; let defaultClient = TheJiraCloudPlatformRestApi.ApiClient.instance; // Configure OAuth2 access token for authorization: OAuth2 let OAuth2 = defaultClient.authentications['OAuth2']; OAuth2.accessToken = 'YOUR ACCESS TOKEN'; // Configure HTTP basic authorization: basicAuth let basicAuth = defaultClient.authentications['basicAuth']; basicAuth.username = 'YOUR USERNAME'; basicAuth.password = 'YOUR PASSWORD'; let apiInstance = new TheJiraCloudPlatformRestApi.PermissionSchemesApi(); let opts = { 'expand': "expand_example" // String | 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: * `all` Returns all expandable information. * `field` Returns information about the custom field granted the permission. * `group` Returns information about the group that is granted the permission. * `permissions` Returns all permission grants for each permission scheme. * `projectRole` Returns information about the project role granted the permission. * `user` Returns information about the user who is granted the permission. }; apiInstance.getAllPermissionSchemes(opts, (error, data, response) => { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **expand** | **String**| 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: * `all` Returns all expandable information. * `field` Returns information about the custom field granted the permission. * `group` Returns information about the group that is granted the permission. * `permissions` Returns all permission grants for each permission scheme. * `projectRole` Returns information about the project role granted the permission. * `user` Returns information about the user who is granted the permission. | [optional] ### Return type [**PermissionSchemes**](PermissionSchemes.md) ### Authorization [OAuth2](../README.md#OAuth2), [basicAuth](../README.md#basicAuth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json # **getPermissionScheme** > PermissionScheme getPermissionScheme(schemeId, opts) Get permission scheme Returns a permission scheme. **[Permissions](#permissions) required:** Permission to access Jira. ### Example ```javascript import {TheJiraCloudPlatformRestApi} from 'the_jira_cloud_platform_rest_api'; let defaultClient = TheJiraCloudPlatformRestApi.ApiClient.instance; // Configure OAuth2 access token for authorization: OAuth2 let OAuth2 = defaultClient.authentications['OAuth2']; OAuth2.accessToken = 'YOUR ACCESS TOKEN'; // Configure HTTP basic authorization: basicAuth let basicAuth = defaultClient.authentications['basicAuth']; basicAuth.username = 'YOUR USERNAME'; basicAuth.password = 'YOUR PASSWORD'; let apiInstance = new TheJiraCloudPlatformRestApi.PermissionSchemesApi(); let schemeId = 789; // Number | The ID of the permission scheme to return. let opts = { 'expand': "expand_example" // String | 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: * `all` Returns all expandable information. * `field` Returns information about the custom field granted the permission. * `group` Returns information about the group that is granted the permission. * `permissions` Returns all permission grants for each permission scheme. * `projectRole` Returns information about the project role granted the permission. * `user` Returns information about the user who is granted the permission. }; apiInstance.getPermissionScheme(schemeId, opts, (error, data, response) => { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **schemeId** | **Number**| The ID of the permission scheme to return. | **expand** | **String**| 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: * `all` Returns all expandable information. * `field` Returns information about the custom field granted the permission. * `group` Returns information about the group that is granted the permission. * `permissions` Returns all permission grants for each permission scheme. * `projectRole` Returns information about the project role granted the permission. * `user` Returns information about the user who is granted the permission. | [optional] ### Return type [**PermissionScheme**](PermissionScheme.md) ### Authorization [OAuth2](../README.md#OAuth2), [basicAuth](../README.md#basicAuth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json # **getPermissionSchemeGrant** > PermissionGrant getPermissionSchemeGrant(schemeId, permissionId, opts) Get permission scheme grant Returns a permission grant. **[Permissions](#permissions) required:** Permission to access Jira. ### Example ```javascript import {TheJiraCloudPlatformRestApi} from 'the_jira_cloud_platform_rest_api'; let defaultClient = TheJiraCloudPlatformRestApi.ApiClient.instance; // Configure OAuth2 access token for authorization: OAuth2 let OAuth2 = defaultClient.authentications['OAuth2']; OAuth2.accessToken = 'YOUR ACCESS TOKEN'; // Configure HTTP basic authorization: basicAuth let basicAuth = defaultClient.authentications['basicAuth']; basicAuth.username = 'YOUR USERNAME'; basicAuth.password = 'YOUR PASSWORD'; let apiInstance = new TheJiraCloudPlatformRestApi.PermissionSchemesApi(); let schemeId = 789; // Number | The ID of the permission scheme. let permissionId = 789; // Number | The ID of the permission grant. let opts = { 'expand': "expand_example" // String | 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: * `all` Returns all expandable information. * `field` Returns information about the custom field granted the permission. * `group` Returns information about the group that is granted the permission. * `permissions` Returns all permission grants for each permission scheme. * `projectRole` Returns information about the project role granted the permission. * `user` Returns information about the user who is granted the permission. }; apiInstance.getPermissionSchemeGrant(schemeId, permissionId, opts, (error, data, response) => { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **schemeId** | **Number**| The ID of the permission scheme. | **permissionId** | **Number**| The ID of the permission grant. | **expand** | **String**| 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: * `all` Returns all expandable information. * `field` Returns information about the custom field granted the permission. * `group` Returns information about the group that is granted the permission. * `permissions` Returns all permission grants for each permission scheme. * `projectRole` Returns information about the project role granted the permission. * `user` Returns information about the user who is granted the permission. | [optional] ### Return type [**PermissionGrant**](PermissionGrant.md) ### Authorization [OAuth2](../README.md#OAuth2), [basicAuth](../README.md#basicAuth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json # **getPermissionSchemeGrants** > PermissionGrants getPermissionSchemeGrants(schemeId, opts) Get permission scheme grants Returns all permission grants for a permission scheme. **[Permissions](#permissions) required:** Permission to access Jira. ### Example ```javascript import {TheJiraCloudPlatformRestApi} from 'the_jira_cloud_platform_rest_api'; let defaultClient = TheJiraCloudPlatformRestApi.ApiClient.instance; // Configure OAuth2 access token for authorization: OAuth2 let OAuth2 = defaultClient.authentications['OAuth2']; OAuth2.accessToken = 'YOUR ACCESS TOKEN'; // Configure HTTP basic authorization: basicAuth let basicAuth = defaultClient.authentications['basicAuth']; basicAuth.username = 'YOUR USERNAME'; basicAuth.password = 'YOUR PASSWORD'; let apiInstance = new TheJiraCloudPlatformRestApi.PermissionSchemesApi(); let schemeId = 789; // Number | The ID of the permission scheme. let opts = { 'expand': "expand_example" // String | 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: * `permissions` Returns all permission grants for each permission scheme. * `user` Returns information about the user who is granted the permission. * `group` Returns information about the group that is granted the permission. * `projectRole` Returns information about the project role granted the permission. * `field` Returns information about the custom field granted the permission. * `all` Returns all expandable information. }; apiInstance.getPermissionSchemeGrants(schemeId, opts, (error, data, response) => { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **schemeId** | **Number**| The ID of the permission scheme. | **expand** | **String**| 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: * `permissions` Returns all permission grants for each permission scheme. * `user` Returns information about the user who is granted the permission. * `group` Returns information about the group that is granted the permission. * `projectRole` Returns information about the project role granted the permission. * `field` Returns information about the custom field granted the permission. * `all` Returns all expandable information. | [optional] ### Return type [**PermissionGrants**](PermissionGrants.md) ### Authorization [OAuth2](../README.md#OAuth2), [basicAuth](../README.md#basicAuth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json # **updatePermissionScheme** > PermissionScheme updatePermissionScheme(body, schemeId, opts) Update permission scheme 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 updating the whole list, see [Create permission grant](#api-rest-api-3-permissionscheme-schemeId-permission-post) or [Delete permission scheme entity](#api-rest-api-3-permissionscheme-schemeId-permission-permissionId-delete). 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). ### Example ```javascript import {TheJiraCloudPlatformRestApi} from 'the_jira_cloud_platform_rest_api'; let defaultClient = TheJiraCloudPlatformRestApi.ApiClient.instance; // Configure OAuth2 access token for authorization: OAuth2 let OAuth2 = defaultClient.authentications['OAuth2']; OAuth2.accessToken = 'YOUR ACCESS TOKEN'; // Configure HTTP basic authorization: basicAuth let basicAuth = defaultClient.authentications['basicAuth']; basicAuth.username = 'YOUR USERNAME'; basicAuth.password = 'YOUR PASSWORD'; let apiInstance = new TheJiraCloudPlatformRestApi.PermissionSchemesApi(); let body = { "description" : "description", "name" : "Example permission scheme", "permissions" : [ { "holder" : { "parameter" : "jira-core-users", "type" : "group", "value" : "ca85fac0-d974-40ca-a615-7af99c48d24f" }, "permission" : "ADMINISTER_PROJECTS" } ] }; // {String: Object} | let schemeId = 789; // Number | The ID of the permission scheme to update. let opts = { 'expand': "expand_example" // String | 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: * `all` Returns all expandable information. * `field` Returns information about the custom field granted the permission. * `group` Returns information about the group that is granted the permission. * `permissions` Returns all permission grants for each permission scheme. * `projectRole` Returns information about the project role granted the permission. * `user` Returns information about the user who is granted the permission. }; apiInstance.updatePermissionScheme(body, schemeId, opts, (error, data, response) => { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**{String: Object}**](Object.md)| | **schemeId** | **Number**| The ID of the permission scheme to update. | **expand** | **String**| 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: * `all` Returns all expandable information. * `field` Returns information about the custom field granted the permission. * `group` Returns information about the group that is granted the permission. * `permissions` Returns all permission grants for each permission scheme. * `projectRole` Returns information about the project role granted the permission. * `user` Returns information about the user who is granted the permission. | [optional] ### Return type [**PermissionScheme**](PermissionScheme.md) ### Authorization [OAuth2](../README.md#OAuth2), [basicAuth](../README.md#basicAuth) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json