{
"opencollection": "1.0.0",
"info": {
"name": "Atlassian Admin Account Project Role Actors API",
"version": "1.0.0"
},
"request": {
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"items": [
{
"info": {
"name": "Project Role Actors",
"type": "folder"
},
"items": [
{
"info": {
"name": "Atlassian Add Actors To Project Role",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.atlassian.com/rest/api/3/project/:projectIdOrKey/role/:id",
"params": [
{
"name": "projectIdOrKey",
"value": "",
"type": "path",
"description": "The project ID or project key (case sensitive)."
},
{
"name": "id",
"value": "",
"type": "path",
"description": "The ID of the project role. Use [Get all project roles](#api-rest-api-3-role-get) to get a list of project role IDs."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Adds actors to a project role for the project.
To replace all actors for the project, use [Set actors for project role](#api-rest-api-3-project-projectIdOrKey-role-id-put).
This operation can be accessed anonymously.
**[Permissions](#permissions) required:** *Administer Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project or *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg)."
},
{
"info": {
"name": "Atlassian Set Actors For Project Role",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.atlassian.com/rest/api/3/project/:projectIdOrKey/role/:id",
"params": [
{
"name": "projectIdOrKey",
"value": "",
"type": "path",
"description": "The project ID or project key (case sensitive)."
},
{
"name": "id",
"value": "",
"type": "path",
"description": "The ID of the project role. Use [Get all project roles](#api-rest-api-3-role-get) to get a list of project role IDs."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Sets the actors for a project role for a project, replacing all existing actors.
To add actors to the project without overwriting the existing list, use [Add actors to project role](#api-rest-api-3-project-projectIdOrKey-role-id-post).
**[Permissions](#permissions) required:** *Administer Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project or *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg)."
},
{
"info": {
"name": "Atlassian Delete Actors From Project Role",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.atlassian.com/rest/api/3/project/:projectIdOrKey/role/:id",
"params": [
{
"name": "projectIdOrKey",
"value": "",
"type": "path",
"description": "The project ID or project key (case sensitive)."
},
{
"name": "id",
"value": "",
"type": "path",
"description": "The ID of the project role. Use [Get all project roles](#api-rest-api-3-role-get) to get a list of project role IDs."
},
{
"name": "user",
"value": "",
"type": "query",
"description": "The user account ID of the user to remove from the project role."
},
{
"name": "group",
"value": "",
"type": "query",
"description": "The name of the group to remove from the project role. This parameter cannot be used with the `groupId` parameter. As a group's name can change, use of `groupId` is recommended."
},
{
"name": "groupId",
"value": "",
"type": "query",
"description": "The ID of the group to remove from the project role. This parameter cannot be used with the `group` parameter."
}
]
},
"docs": "Deletes actors from a project role for the project.
To remove default actors from the project role, use [Delete default actors from project role](#api-rest-api-3-role-id-actors-delete).
This operation can be accessed anonymously.
**[Permissions](#permissions) required:** *Administer Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project or *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg)."
},
{
"info": {
"name": "Atlassian Get Default Actors For Project Role",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.atlassian.com/rest/api/3/role/:id/actors",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The ID of the project role. Use [Get all project roles](#api-rest-api-3-role-get) to get a list of project role IDs."
}
]
},
"docs": "Returns the [default actors](#api-rest-api-3-resolution-get) for the project role.
**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg)."
},
{
"info": {
"name": "Atlassian Add Default Actors To Project Role",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.atlassian.com/rest/api/3/role/:id/actors",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The ID of the project role. Use [Get all project roles](#api-rest-api-3-role-get) to get a list of project role IDs."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Adds [default actors](#api-rest-api-3-resolution-get) to a role. You may add groups or users, but you cannot add groups and users in the same request.
Changing a project role's default actors does not affect project role members for projects already created.
**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg)."
},
{
"info": {
"name": "Atlassian Delete Default Actors From Project Role",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.atlassian.com/rest/api/3/role/:id/actors",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The ID of the project role. Use [Get all project roles](#api-rest-api-3-role-get) to get a list of project role IDs."
},
{
"name": "user",
"value": "",
"type": "query",
"description": "The user account ID of the user to remove as a default actor."
},
{
"name": "groupId",
"value": "",
"type": "query",
"description": "The group ID of the group to be removed as a default actor. This parameter cannot be used with the `group` parameter."
},
{
"name": "group",
"value": "",
"type": "query",
"description": "The group name of the group to be removed as a default actor.This parameter cannot be used with the `groupId` parameter. As a group's name can change, use of `groupId` is recommended."
}
]
},
"docs": "Deletes the [default actors](#api-rest-api-3-resolution-get) from a project role. You may delete a group or user, but you cannot delete a group and a user in the same request.
Changing a project role's default actors does not affect project role members for projects already created.
**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg)."
}
]
}
],
"bundled": true
}