Atlassian · Schema
UserPermission
Details of a permission and its availability to a user.
CodeCollaborationPlatformProductivitySoftware Development
Properties
| Name | Type | Description |
|---|---|---|
| deprecatedKey | boolean | Indicate whether the permission key is deprecated. Note that deprecated keys cannot be used in the `permissions parameter of Get my permissions. Deprecated keys are not returned by Get all permissions |
| description | string | The description of the permission. |
| havePermission | boolean | Whether the permission is available to the user in the queried context. |
| id | string | The ID of the permission. Either `id` or `key` must be specified. Use [Get all permissions](#api-rest-api-3-permissions-get) to get the list of permissions. |
| key | string | The key of the permission. Either `id` or `key` must be specified. Use [Get all permissions](#api-rest-api-3-permissions-get) to get the list of permissions. |
| name | string | The name of the permission. |
| type | string | The type of the permission. |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/UserPermission",
"title": "UserPermission",
"additionalProperties": true,
"description": "Details of a permission and its availability to a user.",
"properties": {
"deprecatedKey": {
"description": "Indicate whether the permission key is deprecated. Note that deprecated keys cannot be used in the `permissions parameter of Get my permissions. Deprecated keys are not returned by Get all permissions.`",
"type": "boolean"
},
"description": {
"description": "The description of the permission.",
"type": "string"
},
"havePermission": {
"description": "Whether the permission is available to the user in the queried context.",
"type": "boolean"
},
"id": {
"description": "The ID of the permission. Either `id` or `key` must be specified. Use [Get all permissions](#api-rest-api-3-permissions-get) to get the list of permissions.",
"type": "string"
},
"key": {
"description": "The key of the permission. Either `id` or `key` must be specified. Use [Get all permissions](#api-rest-api-3-permissions-get) to get the list of permissions.",
"type": "string"
},
"name": {
"description": "The name of the permission.",
"type": "string"
},
"type": {
"description": "The type of the permission.",
"enum": [
"GLOBAL",
"PROJECT"
],
"type": "string"
}
},
"type": "object"
}