Atlassian: Permissions schemas

9 Atlassian schemas with complete fields and constraints.

Field	Type	Presence	Description and constraints
`$`	object	Root	Details of global permissions to look up and project permissions with associated projects and issues to look up. Additional keys: not allowed
`accountId`	string	Optional	The account ID of a user.
`globalPermissions`	array	Optional	Global permissions to look up. Unique items: true
`globalPermissions[]`	string	Each item
`projectPermissions`	array	Optional	Project permissions with associated projects and issues to look up. Unique items: true
`projectPermissions[]`	Model	Each item	Expand Get bulk permissions — request body — body project Permissions item

Field	Type	Presence	Description and constraints
`$`	object	Root	Details of project permissions and associated issues and projects to look up. Additional keys: not allowed
`issues`	array	Optional	List of issue IDs. Unique items: true
`issues[]`	integer	Each item	Format: int64
`permissions`	array	Required within parent	List of project permissions. Unique items: true
`permissions[]`	string	Each item
`projects`	array	Optional	List of project IDs. Unique items: true
`projects[]`	integer	Each item	Format: int64

Field	Type	Presence	Description and constraints
`$`	object	Root	Details of global and project permissions granted to the user.
`globalPermissions`	JSON	Optional
`globalPermissions (anyOf 1)`	array	Alternative	List of permissions granted to the user. Unique items: true
`globalPermissions (anyOf 1)[]`	string	Each item
`globalPermissions (anyOf 2)`	null	Alternative
`projectPermissions`	JSON	Optional
`projectPermissions (anyOf 1)`	array	Alternative	List of project permissions and the projects and issues those permissions provide access to. Unique items: true
`projectPermissions (anyOf 1)[]`	Model	Each item	Expand Get bulk permissions — response body — project Permissions array item
`projectPermissions (anyOf 2)`	null	Alternative

Field	Type	Presence	Description and constraints
`$`	object	Root	List of project permissions and the projects and issues those permissions grant access to.
`issues`	JSON	Optional
`issues (anyOf 1)`	array	Alternative	IDs of the issues the user has the permission for. Unique items: true
`issues (anyOf 1)[]`	JSON	Each item
`issues (anyOf 1)[] (anyOf 1)`	integer	Alternative	Format: int64
`issues (anyOf 1)[] (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`issues (anyOf 2)`	null	Alternative
`permission`	JSON	Optional
`permission (anyOf 1)`	string	Alternative	A project permission,
`permission (anyOf 2)`	null	Alternative
`projects`	JSON	Optional
`projects (anyOf 1)`	array	Alternative	IDs of the projects the user has the permission for. Unique items: true
`projects (anyOf 1)[]`	JSON	Each item
`projects (anyOf 1)[] (anyOf 1)`	integer	Alternative	Format: int64
`projects (anyOf 1)[] (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`projects (anyOf 2)`	null	Alternative

Field	Type	Presence	Description and constraints
`$`	object	Root	Details about permissions.
`permissions`	JSON	Optional
`permissions (anyOf 1)`	object	Alternative	List of permissions. Read only: true Additional keys: see wildcard field
`permissions (anyOf 1).*`	Model	Additional keys	Expand Get my permissions — response body — permissions List of permissions value
`permissions (anyOf 2)`	null	Alternative

Field	Type	Presence	Description and constraints
`$`	object	Root	Details of a permission and its availability to a user. Additional keys: allowed
`deprecatedKey`	JSON	Optional
`deprecatedKey (anyOf 1)`	boolean	Alternative	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.`
`deprecatedKey (anyOf 2)`	null	Alternative
`description`	JSON	Optional
`description (anyOf 1)`	string	Alternative	The description of the permission.
`description (anyOf 2)`	null	Alternative
`havePermission`	JSON	Optional
`havePermission (anyOf 1)`	boolean	Alternative	Whether the permission is available to the user in the queried context.
`havePermission (anyOf 2)`	null	Alternative
`id`	JSON	Optional
`id (anyOf 1)`	string	Alternative	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.
`id (anyOf 2)`	null	Alternative
`key`	JSON	Optional
`key (anyOf 1)`	string	Alternative	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.
`key (anyOf 2)`	null	Alternative
`name`	JSON	Optional
`name (anyOf 1)`	string	Alternative	The name of the permission.
`name (anyOf 2)`	null	Alternative
`type`	JSON	Optional
`type (anyOf 1)`	string	Alternative	The type of the permission. Known values: GLOBAL, PROJECT
`type (anyOf 2)`	null	Alternative

Field	Type	Presence	Description and constraints
`$`	object	Root	Additional keys: not allowed
`permissions`	array	Required within parent	A list of permission keys.
`permissions[]`	string	Each item

Field	Type	Presence	Description and constraints
`$`	object	Root	A list of projects in which a user is granted permissions.
`projects`	JSON	Optional
`projects (anyOf 1)`	array	Alternative	A list of projects. Read only: true
`projects (anyOf 1)[]`	Model	Each item	Expand Get permitted projects — response body — projects A list of projects item
`projects (anyOf 2)`	null	Alternative

Field	Type	Presence	Description and constraints
`$`	object	Root	The identifiers for a project.
`id`	JSON	Optional
`id (anyOf 1)`	JSON	Alternative
`id (anyOf 1) (anyOf 1)`	integer	Alternative	The ID of the project. Format: int64 Read only: true
`id (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`id (anyOf 2)`	null	Alternative
`key`	JSON	Optional
`key (anyOf 1)`	string	Alternative	The key of the project. Read only: true
`key (anyOf 2)`	null	Alternative