Atlassian: Permission schemes schemas

11 Atlassian schemas with complete fields and constraints.

← Permission schemes operations · All schemas

Create permission grant — request body — body

Field	Type	Presence	Description and constraints
`$`	object	Root	Details about a permission granted to a user or group. Additional keys: allowed
`holder`	Model	Optional	Expand Create permission grant — request body — body holder The user or group being granted the permission. It consists of a `type`, a type-dependent `parameter` and a type-dependent `value`. See [Holder object](../api-group-permission-schemes/#holder-object) in Get all permission schemes for more information.
`id`	integer	Optional	The ID of the permission granted details. Format: int64 Read only: true
`permission`	string	Optional	The permission to grant. This permission can be one of the built-in permissions or a custom permission added by an app. See [Built-in permissions](../api-group-permission-schemes/#built-in-permissions) in Get all permission schemes for more information about the built-in 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 about custom permissions.
`self`	string	Optional	The URL of the permission granted details. Format: uri Read only: true

Referenced models: Create permission grant — request body — body holder

Create permission grant — request body — body holder

Field	Type	Presence	Description and constraints
`$`	object	Root	Details of a user, group, field, or project role that holds a permission. See [Holder object](../api-group-permission-schemes/#holder-object) in Get all permission schemes for more information. Additional keys: not allowed
`expand`	string	Optional	Expand options that include additional permission holder details in the response. Read only: true
`parameter`	string	Optional	As a group's name can change, use of `value` is recommended. The identifier associated withthe `type` value that defines the holder of the permission.
`type`	string	Required within parent	The type of permission holder.
`value`	string	Optional	The identifier associated with the `type` value that defines the holder of the permission.

Create permission grant — response body

Field	Type	Presence	Description and constraints
`$`	object	Root	Details about a permission granted to a user or group. Additional keys: allowed
`holder`	JSON	Optional
`holder (anyOf 1)`	Model	Alternative	Expand Create permission grant — response body — holder expand, parameter, type, value The user or group being granted the permission. It consists of a `type`, a type-dependent `parameter` and a type-dependent `value`. See [Holder object](../api-group-permission-schemes/#holder-object) in Get all permission schemes for more information.
`holder (anyOf 2)`	null	Alternative
`id`	JSON	Optional
`id (anyOf 1)`	JSON	Alternative
`id (anyOf 1) (anyOf 1)`	integer	Alternative	The ID of the permission granted details. 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
`permission`	JSON	Optional
`permission (anyOf 1)`	string	Alternative	The permission to grant. This permission can be one of the built-in permissions or a custom permission added by an app. See [Built-in permissions](../api-group-permission-schemes/#built-in-permissions) in Get all permission schemes for more information about the built-in 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 about custom permissions.
`permission (anyOf 2)`	null	Alternative
`self`	JSON	Optional
`self (anyOf 1)`	string	Alternative	The URL of the permission granted details. Format: uri Read only: true
`self (anyOf 2)`	null	Alternative

Referenced models: Create permission grant — response body — holder expand, parameter, type, value

Create permission grant — response body — holder expand, parameter, type, value

Field	Type	Presence	Description and constraints
`$`	object	Root	Details of a user, group, field, or project role that holds a permission. See [Holder object](../api-group-permission-schemes/#holder-object) in Get all permission schemes for more information.
`expand`	JSON	Optional
`expand (anyOf 1)`	string	Alternative	Expand options that include additional permission holder details in the response. Read only: true
`expand (anyOf 2)`	null	Alternative
`parameter`	JSON	Optional
`parameter (anyOf 1)`	string	Alternative	As a group's name can change, use of `value` is recommended. The identifier associated withthe `type` value that defines the holder of the permission.
`parameter (anyOf 2)`	null	Alternative
`type`	JSON	Optional
`type (anyOf 1)`	string	Alternative	The type of permission holder.
`type (anyOf 2)`	null	Alternative
`value`	JSON	Optional
`value (anyOf 1)`	string	Alternative	The identifier associated with the `type` value that defines the holder of the permission.
`value (anyOf 2)`	null	Alternative

Create permission scheme — request body — body

Field	Type	Presence	Description and constraints
`$`	object	Root	Details of a permission scheme. Additional keys: allowed
`description`	string	Optional	A description for the permission scheme.
`expand`	string	Optional	The expand options available for the permission scheme. Read only: true
`id`	integer	Optional	The ID of the permission scheme. Format: int64 Read only: true
`name`	string	Required within parent	The name of the permission scheme. Must be unique.
`permissions`	array	Optional	The permission scheme to create or update. See [About permission schemes and grants](../api-group-permission-schemes/#about-permission-schemes-and-grants) for more information.
`permissions[]`	Model	Each item	Expand Create permission grant — request body — body
`scope`	Model	Optional	Expand Create permission scheme — request body — body scope The scope of the permission scheme.
`self`	string	Optional	The URL of the permission scheme. Format: uri Read only: true

Referenced models: Create permission grant — request body — body, Create permission scheme — request body — body scope

Create permission scheme — request body — body scope

Field	Type	Presence	Description and constraints
`$`	object	Root	The projects the item is associated with. Indicated for items associated with [next-gen projects](https://confluence.atlassian.com/x/loMyO). Additional keys: allowed
`project`	Model	Optional	Expand Create permission scheme — request body — body scope project The project the item has scope in. Read only: true
`type`	string	Optional	The type of scope. One of: PROJECT, TEMPLATE Read only: true

Referenced models: Create permission scheme — request body — body scope project

Create permission scheme — request body — body scope project

Field	Type	Presence	Description and constraints
`$`	object	Root	Details about a project. Additional keys: not allowed
`avatarUrls`	Model	Optional	Expand Assign issue — request body — body avatar Urls The URLs of the project's avatars. Read only: true
`id`	string	Optional	The ID of the project.
`key`	string	Optional	The key of the project. Read only: true
`name`	string	Optional	The name of the project. Read only: true
`projectCategory`	Model	Optional	Expand Create permission scheme — request body — body scope project project Category The category the project belongs to. Read only: true
`projectTypeKey`	string	Optional	The [project type](https://confluence.atlassian.com/x/GwiiLQ#Jiraapplicationsoverview-Productfeaturesandprojecttypes) of the project. One of: software, service_desk, business, product_discovery Read only: true
`self`	string	Optional	The URL of the project details. Read only: true
`simplified`	boolean	Optional	Whether or not the project is simplified. Read only: true

Referenced models: Assign issue — request body — body avatar Urls, Create permission scheme — request body — body scope project project Category

Create permission scheme — request body — body scope project project Category

Field	Type	Presence	Description and constraints
`$`	object	Root	A project category. Additional keys: not allowed
`description`	string	Optional	The name of the project category. Read only: true
`id`	string	Optional	The ID of the project category. Read only: true
`name`	string	Optional	The description of the project category. Read only: true
`self`	string	Optional	The URL of the project category. Read only: true

Get all permission schemes — response body

Field	Type	Presence	Description and constraints
`$`	object	Root	List of all permission schemes.
`permissionSchemes`	JSON	Optional
`permissionSchemes (anyOf 1)`	array	Alternative	Permission schemes list. Read only: true
`permissionSchemes (anyOf 1)[]`	Model	Each item	Expand Get permission scheme — response body
`permissionSchemes (anyOf 2)`	null	Alternative

Referenced models: Get permission scheme — response body

Get permission scheme grants — response body

Field	Type	Presence	Description and constraints
`$`	object	Root	List of permission grants.
`expand`	JSON	Optional
`expand (anyOf 1)`	string	Alternative	Expand options that include additional permission grant details in the response. Read only: true
`expand (anyOf 2)`	null	Alternative
`permissions`	JSON	Optional
`permissions (anyOf 1)`	array	Alternative	Permission grants list. Read only: true
`permissions (anyOf 1)[]`	Model	Each item	Expand Create permission grant — response body
`permissions (anyOf 2)`	null	Alternative

Referenced models: Create permission grant — response body

Get permission scheme — response body

Field	Type	Presence	Description and constraints
`$`	object	Root	Details of a permission scheme. Additional keys: allowed
`description`	JSON	Optional
`description (anyOf 1)`	string	Alternative	A description for the permission scheme.
`description (anyOf 2)`	null	Alternative
`expand`	JSON	Optional
`expand (anyOf 1)`	string	Alternative	The expand options available for the permission scheme. Read only: true
`expand (anyOf 2)`	null	Alternative
`id`	JSON	Optional
`id (anyOf 1)`	JSON	Alternative
`id (anyOf 1) (anyOf 1)`	integer	Alternative	The ID of the permission scheme. 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
`name`	JSON	Optional
`name (anyOf 1)`	string	Alternative	The name of the permission scheme. Must be unique.
`name (anyOf 2)`	null	Alternative
`permissions`	JSON	Optional
`permissions (anyOf 1)`	array	Alternative	The permission scheme to create or update. See [About permission schemes and grants](../api-group-permission-schemes/#about-permission-schemes-and-grants) for more information.
`permissions (anyOf 1)[]`	Model	Each item	Expand Create permission grant — response body
`permissions (anyOf 2)`	null	Alternative
`scope`	JSON	Optional
`scope (anyOf 1)`	Model	Alternative	Expand Get status — response body — scope project, type The scope of the permission scheme.
`scope (anyOf 2)`	null	Alternative
`self`	JSON	Optional
`self (anyOf 1)`	string	Alternative	The URL of the permission scheme. Format: uri Read only: true
`self (anyOf 2)`	null	Alternative

Referenced models: Create permission grant — response body, Get status — response body — scope project, type

Report an issue with this page