Atlassian: Issue security schemes schemas
21 Atlassian schemas with complete fields and constraints.
← Issue security schemes operations · All schemas
Add issue security level members — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details of issue security scheme level new members. Additional keys: not allowed |
members | array | Required within parent | The list of level members which should be added to the issue security scheme level. write Only: true |
members[] | Model | Each item | Expand Add issue security level members — request body — body members item |
Referenced models: Add issue security level members — request body — body members item
Add issue security level members — request body — body members item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | write Only: true Additional keys: not allowed |
parameter | string | Optional | The value corresponding to the specified member type. write Only: true |
type | string | Required within parent | The issue security level member type, e.g `reporter`, `group`, `user`, `projectrole`, `applicationRole`. write Only: true |
Add issue security levels — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
levels | array | Optional | The list of scheme levels which should be added to the security scheme. write Only: true |
levels[] | Model | Each item | Expand Add issue security levels — request body — body levels item |
Referenced models: Add issue security levels — request body — body levels item
Add issue security levels — request body — body levels item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | write Only: true Additional keys: not allowed |
description | string | Optional | The description of the issue security scheme level. Maximum length: 4000 write Only: true |
isDefault | boolean | Optional | Specifies whether the level is the default level. False by default. write Only: true |
members | array | Optional | The list of level members which should be added to the issue security scheme level. write Only: true |
members[] | Model | Each item | Expand Add issue security level members — request body — body members item |
name | string | Required within parent | The name of the issue security scheme level. Must be unique. Maximum length: 255 write Only: true |
Referenced models: Add issue security level members — request body — body members item
Associate security scheme to project — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Issue security scheme, project, and remapping details. Additional keys: not allowed |
oldToNewSecurityLevelMappings | array | Optional | The list of scheme levels which should be remapped to new levels of the issue security scheme. write Only: true |
oldToNewSecurityLevelMappings[] | Model | Each item | Expand Associate security scheme to project — request body — body old To New Security Level Mappings item |
projectId | string | Required within parent | The ID of the project. write Only: true |
schemeId | string | Required within parent | The ID of the issue security scheme. Providing null will clear the association with the issue security scheme. write Only: true |
Referenced models: Associate security scheme to project — request body — body old To New Security Level Mappings item
Associate security scheme to project — request body — body old To New Security Level Mappings item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | write Only: true Additional keys: not allowed |
newLevelId | string | Required within parent | The new issue security level ID. Providing null will clear the assigned old level from issues. write Only: true |
oldLevelId | string | Required within parent | The old issue security level ID. Providing null will remap all issues without any assigned levels. write Only: true |
Create issue security scheme — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Issue security scheme and it's details Additional keys: allowed |
description | string | Optional | The description of the issue security scheme. Maximum length: 255 write Only: true |
levels | array | Optional | The list of scheme levels which should be added to the security scheme. write Only: true |
levels[] | Model | Each item | Expand Add issue security levels — request body — body levels item |
name | string | Required within parent | The name of the issue security scheme. Must be unique (case-insensitive). Maximum length: 60 write Only: true |
Referenced models: Add issue security levels — request body — body levels item
Create issue security scheme — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The ID of the issue security scheme. Additional keys: allowed |
id | JSON | Optional | |
id (anyOf 1) | string | Alternative | The ID of the issue security scheme. Read only: true |
id (anyOf 2) | null | Alternative |
Get issue security level members — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A page of items. |
isLast | JSON | Optional | |
isLast (anyOf 1) | boolean | Alternative | Whether this is the last page. Read only: true |
isLast (anyOf 2) | null | Alternative | |
maxResults | JSON | Optional | |
maxResults (anyOf 1) | JSON | Alternative | |
maxResults (anyOf 1) (anyOf 1) | integer | Alternative | The maximum number of items that could be returned. Format: int32 Read only: true |
maxResults (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
maxResults (anyOf 2) | null | Alternative | |
nextPage | JSON | Optional | |
nextPage (anyOf 1) | string | Alternative | If there is another page of results, the URL of the next page. Format: uri Read only: true |
nextPage (anyOf 2) | null | Alternative | |
self | JSON | Optional | |
self (anyOf 1) | string | Alternative | The URL of the page. Format: uri Read only: true |
self (anyOf 2) | null | Alternative | |
startAt | JSON | Optional | |
startAt (anyOf 1) | JSON | Alternative | |
startAt (anyOf 1) (anyOf 1) | integer | Alternative | The index of the first item returned. Format: int64 Read only: true |
startAt (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
startAt (anyOf 2) | null | Alternative | |
total | JSON | Optional | |
total (anyOf 1) | JSON | Alternative | |
total (anyOf 1) (anyOf 1) | integer | Alternative | The number of items returned. Format: int64 Read only: true |
total (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
total (anyOf 2) | null | Alternative | |
values | JSON | Optional | |
values (anyOf 1) | array | Alternative | The list of items. Read only: true |
values (anyOf 1)[] | Model | Each item | Expand Get issue security level members — response body — values The list of items item |
values (anyOf 2) | null | Alternative |
Referenced models: Get issue security level members — response body — values The list of items item
Get issue security level members — response body — values The list of items item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Issue security level member. 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` and a type-dependent `parameter`. See [Holder object](../api-group-permission-schemes/#holder-object) in *Get all permission schemes* for more information. Read only: true |
holder (anyOf 2) | null | Alternative | |
id | JSON | Optional | |
id (anyOf 1) | string | Alternative | The ID of the issue security level member. Read only: true |
id (anyOf 2) | null | Alternative | |
issueSecurityLevelId | JSON | Optional | |
issueSecurityLevelId (anyOf 1) | string | Alternative | The ID of the issue security level. Read only: true |
issueSecurityLevelId (anyOf 2) | null | Alternative | |
issueSecuritySchemeId | JSON | Optional | |
issueSecuritySchemeId (anyOf 1) | string | Alternative | The ID of the issue security scheme. Read only: true |
issueSecuritySchemeId (anyOf 2) | null | Alternative | |
managed | JSON | Optional | |
managed (anyOf 1) | boolean | Alternative | write Only: true |
managed (anyOf 2) | null | Alternative |
Referenced models: Create permission grant — response body — holder expand, parameter, type, value
Get issue security levels — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A page of items. |
isLast | JSON | Optional | |
isLast (anyOf 1) | boolean | Alternative | Whether this is the last page. Read only: true |
isLast (anyOf 2) | null | Alternative | |
maxResults | JSON | Optional | |
maxResults (anyOf 1) | JSON | Alternative | |
maxResults (anyOf 1) (anyOf 1) | integer | Alternative | The maximum number of items that could be returned. Format: int32 Read only: true |
maxResults (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
maxResults (anyOf 2) | null | Alternative | |
nextPage | JSON | Optional | |
nextPage (anyOf 1) | string | Alternative | If there is another page of results, the URL of the next page. Format: uri Read only: true |
nextPage (anyOf 2) | null | Alternative | |
self | JSON | Optional | |
self (anyOf 1) | string | Alternative | The URL of the page. Format: uri Read only: true |
self (anyOf 2) | null | Alternative | |
startAt | JSON | Optional | |
startAt (anyOf 1) | JSON | Alternative | |
startAt (anyOf 1) (anyOf 1) | integer | Alternative | The index of the first item returned. Format: int64 Read only: true |
startAt (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
startAt (anyOf 2) | null | Alternative | |
total | JSON | Optional | |
total (anyOf 1) | JSON | Alternative | |
total (anyOf 1) (anyOf 1) | integer | Alternative | The number of items returned. Format: int64 Read only: true |
total (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
total (anyOf 2) | null | Alternative | |
values | JSON | Optional | |
values (anyOf 1) | array | Alternative | The list of items. Read only: true |
values (anyOf 1)[] | Model | Each item | Expand Get issue security level — response body |
values (anyOf 2) | null | Alternative |
Referenced models: Get issue security level — response body
Get issue security scheme — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details about a security scheme. |
defaultSecurityLevelId | JSON | Optional | |
defaultSecurityLevelId (anyOf 1) | JSON | Alternative | |
defaultSecurityLevelId (anyOf 1) (anyOf 1) | integer | Alternative | The ID of the default security level. Format: int64 Read only: true |
defaultSecurityLevelId (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
defaultSecurityLevelId (anyOf 2) | null | Alternative | |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | The description of the issue security scheme. Read only: true |
description (anyOf 2) | null | Alternative | |
id | JSON | Optional | |
id (anyOf 1) | JSON | Alternative | |
id (anyOf 1) (anyOf 1) | integer | Alternative | The ID of the issue security 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 | |
levels | JSON | Optional | |
levels (anyOf 1) | array | Alternative | |
levels (anyOf 1)[] | Model | Each item | Expand Get issue security level — response body |
levels (anyOf 2) | null | Alternative | |
name | JSON | Optional | |
name (anyOf 1) | string | Alternative | The name of the issue security scheme. Read only: true |
name (anyOf 2) | null | Alternative | |
self | JSON | Optional | |
self (anyOf 1) | string | Alternative | The URL of the issue security scheme. Read only: true |
self (anyOf 2) | null | Alternative |
Referenced models: Get issue security level — response body
Get issue security schemes — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | List of security schemes. |
issueSecuritySchemes | JSON | Optional | |
issueSecuritySchemes (anyOf 1) | array | Alternative | List of security schemes. Read only: true |
issueSecuritySchemes (anyOf 1)[] | Model | Each item | Expand Get issue security scheme — response body |
issueSecuritySchemes (anyOf 2) | null | Alternative |
Referenced models: Get issue security scheme — response body
Get projects using issue security schemes — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A page of items. |
isLast | JSON | Optional | |
isLast (anyOf 1) | boolean | Alternative | Whether this is the last page. Read only: true |
isLast (anyOf 2) | null | Alternative | |
maxResults | JSON | Optional | |
maxResults (anyOf 1) | JSON | Alternative | |
maxResults (anyOf 1) (anyOf 1) | integer | Alternative | The maximum number of items that could be returned. Format: int32 Read only: true |
maxResults (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
maxResults (anyOf 2) | null | Alternative | |
nextPage | JSON | Optional | |
nextPage (anyOf 1) | string | Alternative | If there is another page of results, the URL of the next page. Format: uri Read only: true |
nextPage (anyOf 2) | null | Alternative | |
self | JSON | Optional | |
self (anyOf 1) | string | Alternative | The URL of the page. Format: uri Read only: true |
self (anyOf 2) | null | Alternative | |
startAt | JSON | Optional | |
startAt (anyOf 1) | JSON | Alternative | |
startAt (anyOf 1) (anyOf 1) | integer | Alternative | The index of the first item returned. Format: int64 Read only: true |
startAt (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
startAt (anyOf 2) | null | Alternative | |
total | JSON | Optional | |
total (anyOf 1) | JSON | Alternative | |
total (anyOf 1) (anyOf 1) | integer | Alternative | The number of items returned. Format: int64 Read only: true |
total (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
total (anyOf 2) | null | Alternative | |
values | JSON | Optional | |
values (anyOf 1) | array | Alternative | The list of items. Read only: true |
values (anyOf 1)[] | Model | Each item | Expand Get projects using issue security schemes — response body — values The list of items item |
values (anyOf 2) | null | Alternative |
Referenced models: Get projects using issue security schemes — response body — values The list of items item
Get projects using issue security schemes — response body — values The list of items item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details about an project using security scheme mapping. Additional keys: allowed |
issueSecuritySchemeId | JSON | Optional | |
issueSecuritySchemeId (anyOf 1) | string | Alternative | Read only: true |
issueSecuritySchemeId (anyOf 2) | null | Alternative | |
projectId | JSON | Optional | |
projectId (anyOf 1) | string | Alternative | Read only: true |
projectId (anyOf 2) | null | Alternative |
Search issue security schemes — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A page of items. |
isLast | JSON | Optional | |
isLast (anyOf 1) | boolean | Alternative | Whether this is the last page. Read only: true |
isLast (anyOf 2) | null | Alternative | |
maxResults | JSON | Optional | |
maxResults (anyOf 1) | JSON | Alternative | |
maxResults (anyOf 1) (anyOf 1) | integer | Alternative | The maximum number of items that could be returned. Format: int32 Read only: true |
maxResults (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
maxResults (anyOf 2) | null | Alternative | |
nextPage | JSON | Optional | |
nextPage (anyOf 1) | string | Alternative | If there is another page of results, the URL of the next page. Format: uri Read only: true |
nextPage (anyOf 2) | null | Alternative | |
self | JSON | Optional | |
self (anyOf 1) | string | Alternative | The URL of the page. Format: uri Read only: true |
self (anyOf 2) | null | Alternative | |
startAt | JSON | Optional | |
startAt (anyOf 1) | JSON | Alternative | |
startAt (anyOf 1) (anyOf 1) | integer | Alternative | The index of the first item returned. Format: int64 Read only: true |
startAt (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
startAt (anyOf 2) | null | Alternative | |
total | JSON | Optional | |
total (anyOf 1) | JSON | Alternative | |
total (anyOf 1) (anyOf 1) | integer | Alternative | The number of items returned. Format: int64 Read only: true |
total (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
total (anyOf 2) | null | Alternative | |
values | JSON | Optional | |
values (anyOf 1) | array | Alternative | The list of items. Read only: true |
values (anyOf 1)[] | Model | Each item | Expand Search issue security schemes — response body — values The list of items item |
values (anyOf 2) | null | Alternative |
Referenced models: Search issue security schemes — response body — values The list of items item
Search issue security schemes — response body — values The list of items item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details about an issue security scheme. Additional keys: allowed |
defaultLevel | JSON | Optional | |
defaultLevel (anyOf 1) | JSON | Alternative | |
defaultLevel (anyOf 1) (anyOf 1) | integer | Alternative | The default level ID of the issue security scheme. Format: int64 Read only: true |
defaultLevel (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
defaultLevel (anyOf 2) | null | Alternative | |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | The description of the issue security scheme. Read only: true |
description (anyOf 2) | null | Alternative | |
id | JSON | Optional | |
id (anyOf 1) | JSON | Alternative | |
id (anyOf 1) (anyOf 1) | integer | Alternative | The ID of the issue security 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 issue security scheme. Read only: true |
name (anyOf 2) | null | Alternative | |
projectIds | JSON | Optional | |
projectIds (anyOf 1) | array | Alternative | The list of project IDs associated with the issue security scheme. Read only: true Unique items: true |
projectIds (anyOf 1)[] | JSON | Each item | |
projectIds (anyOf 1)[] (anyOf 1) | integer | Alternative | Format: int64 Read only: true |
projectIds (anyOf 1)[] (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
projectIds (anyOf 2) | null | Alternative | |
self | JSON | Optional | |
self (anyOf 1) | string | Alternative | The URL of the issue security scheme. Read only: true |
self (anyOf 2) | null | Alternative |
Set default issue security levels — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details of new default levels. Additional keys: allowed |
defaultValues | array | Required within parent | List of objects with issue security scheme ID and new default level ID. Maximum length: 1000 write Only: true |
defaultValues[] | Model | Each item | Expand Set default issue security levels — request body — body default Values item |
Referenced models: Set default issue security levels — request body — body default Values item
Set default issue security levels — request body — body default Values item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details of scheme and new default level. Maximum length: 1000 write Only: true Additional keys: allowed |
defaultLevelId | string | Required within parent | The ID of the issue security level to set as default for the specified scheme. Providing null will reset the default level. write Only: true |
issueSecuritySchemeId | string | Required within parent | The ID of the issue security scheme to set default level for. write Only: true |
Update issue security level — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details of issue security scheme level. Additional keys: allowed |
description | string | Optional | The description of the issue security scheme level. Maximum length: 255 write Only: true |
name | string | Optional | The name of the issue security scheme level. Must be unique. Maximum length: 60 write Only: true |
Update issue security scheme — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
description | string | Optional | The description of the security scheme scheme. Maximum length: 255 write Only: true |
name | string | Optional | The name of the security scheme scheme. Must be unique. Maximum length: 60 write Only: true |