Acquia Teams and Permissions API
The Teams and Permissions API from Acquia — 10 operation(s) for teams and permissions.
OpenAPI Specification
openapi: 3.0.0
info:
contact:
name: Customer Experience Engineering (CXE)
url: https://www.acquia.com
description: "Acquia Cloud API\n\n# Compatibility\n\n## Stability\n\nThe response for all resource endpoints includes an `X-CloudAPI-Stability` header that indicates what changes, if any, Acquia will make to the resource and how changes will be communicated.\n\nThere are three levels of stability:\n\n* `prototype`: A prototype resource is experimental and major changes are likely. A prototype resource may not reach production.\n * Compatible and emergency changes may be made with no advance notice\n * Disruptive changes may be made with one week notice\n * Deprecated resources will remain available for at least one month after deprecation\n* `development`: A resource that is unlikely to change, but is still being worked on, will be marked as in development. These resources are very likely to reach production.\n * Compatible and emergency changes may be made with no advance notice\n * Disruptive changes may be made with one month notice\n * Deprecated resources will remain available for at least six months after deprecation\n* `production`: A production resource will not introduce breaking changes within a version, and any breaking changes between versions will be communicated ahead of time.\n\n## Deprecation\n\nOver time, endpoints may become obsolete and will be removed in the future. These endpoints will be marked with an `X-CloudAPI-Deprecated` header indicating the version in which they were deprecated and the reason for the deprecation. Deprecated endpoints may be removed in the next version of the resource.\n\n## Versioning\n\nAll resource endpoints are versioned within the API. Endpoints that have reached production will not introduce breaking changes between versions. Non-production endpoints will not version for changes.\n\nA specific version of an endpoint can be requested via the `Accept` header:\n\n Accept: application/hal+json, version=2\n\nIf the version is not specified, the latest version of the endpoint will be used.\n\nStarting with version 3, we will support the current version of an endpoint and the previous version. Version 1 of the API is [provided elsewhere](https://cloudapi.acquia.com/).\n\n## Errors\n\nSome endpoints will return a 503 status when dependent services are unavailable:\n\n application/hal+json\n {\n \"error\": \"system\",\n \"message\": \"This action is currently unavailable. Please try again later.\"\n }\n\n## Authentication\n\nAll Acquia Cloud API calls require authentication to work properly.\n\nLearn more: <a href='https://docs.acquia.com/acquia-cloud/develop/api/auth/' target='_blank'>https://docs.acquia.com/acquia-cloud/develop/api/auth/</a>\n\n### Example implementation\n\nAn example PHP script for making authenticated API requests can be found <a href='https://docs.acquia.com/resources/useful-references' target='_blank'>here</a>. This script uses the <a href='https://oauth2-client.thephpleague.com/' target='_blank'>League/oauth2-client</a> library, installed via Composer.\n"
title: Acquia Cloud API Account Teams and Permissions API
version: 2.0.0
x-logo:
altText: Acquia Cloud
backgroundColor: '#FFFFFF'
url: assets/cloud-platform.svg
servers: []
tags:
- name: Teams and Permissions
x-displayName: Teams and Permissions
paths:
/permissions:
servers:
- url: https://cloud.acquia.com/api
description: Cloud API
get:
tags:
- Teams and Permissions
summary: Return a list of permissions.
description: 'Displays a list of all available permissions currently in the system. This will include permissions that the user
may not have access to.
'
operationId: getPermissions
x-cli-name: permissions:list
responses:
'200':
description: OK
content:
application/hal+json:
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_permissions'
example:
total: 49
_links:
self:
href: https://cloud.acquia.com/api/permissions
_embedded:
items:
- name: deploy to non-prod
label: Pull and deploy code, files, or databases to non-production environments
description: Grants the ability to enable or disable live development and non-production work.
group_label: Workflow
flags:
deprecated: false
- name: deploy to prod
label: Deploy code, files, or databases to the production environment
description: null
group_label: Workflow
flags:
deprecated: false
- name: pull from prod
label: Pull files or databases from the production environment
description: null
group_label: Workflow
flags:
deprecated: false
- name: move file to non-prod
label: Move files to non-production environments
description: null
group_label: Workflow
flags:
deprecated: false
- name: move file to prod
label: Move files to the production environment
description: null
group_label: Workflow
flags:
deprecated: false
- name: move file from prod
label: Move files from production environments
description: null
group_label: Workflow
flags:
deprecated: false
- name: move file from non-prod
label: Move files from non-production environments
description: null
group_label: Workflow
flags:
deprecated: false
- name: clear varnish on non-prod
label: Clear Varnish cache for non-production environments
description: null
group_label: Workflow
flags:
deprecated: true
- name: clear varnish on prod
label: Clear Varnish cache for the production environment
description: null
group_label: Workflow
flags:
deprecated: true
- name: configure prod env
label: Configure production environment
description: null
group_label: Workflow
flags:
deprecated: false
- name: configure non-prod env
label: Configure non-production environments
description: null
group_label: Workflow
flags:
deprecated: false
- name: add an environment
label: Add an environment
description: null
group_label: Workflow
flags:
deprecated: false
- name: delete an environment
label: Delete an environment
description: null
group_label: Workflow
flags:
deprecated: false
- name: administer domain non-prod
label: Add or remove domains for non-production environments
description: null
group_label: Domains
flags:
deprecated: false
- name: administer domain prod
label: Add or remove domains for the production environment
description: null
group_label: Domains
flags:
deprecated: false
- name: administer ssl prod
label: Add or remove SSL certificates for the production environment
description: null
group_label: Domains
flags:
deprecated: false
- name: administer ssl non-prod
label: Add or remove SSL certificates for the non-production environments
description: null
group_label: Domains
flags:
deprecated: false
- name: reboot server
label: Reboot server
description: null
group_label: Server administration
flags:
deprecated: false
- name: resize server
label: Resize server
description: Increasing the size of your server costs money.
group_label: Server administration
flags:
deprecated: false
- name: suspend server
label: Suspend server
description: null
group_label: Server administration
flags:
deprecated: false
- name: configure server
label: Configure server
description: null
group_label: Server administration
flags:
deprecated: false
- name: download logs non-prod
label: Download logs for non-production environments
description: null
group_label: Logs
flags:
deprecated: false
- name: download logs prod
label: Download logs for the production environment
description: null
group_label: Logs
flags:
deprecated: false
- name: add database
label: Add a database
description: null
group_label: Databases
flags:
deprecated: false
- name: remove database
label: Remove a database
description: null
group_label: Databases
flags:
deprecated: false
- name: view database connection
label: View database connection details (username, password, or hostname)
description: null
group_label: Databases
flags:
deprecated: false
- name: download db backup non-prod
label: Download database backups for non-production environments
description: null
group_label: Databases
flags:
deprecated: false
- name: download db backup prod
label: Download database backups for the production environment
description: null
group_label: Databases
flags:
deprecated: false
- name: create db backup non-prod
label: Create database backups for non-production environments
description: null
group_label: Databases
flags:
deprecated: false
- name: create db backup prod
label: Create database backups for the production environment
description: null
group_label: Databases
flags:
deprecated: false
- name: restore db backup non-prod
label: Restore database backups for non-production environments
description: null
group_label: Databases
flags:
deprecated: false
- name: restore db backup prod
label: Restore database backups for the production environment
description: null
group_label: Databases
flags:
deprecated: false
- name: administer team
label: Add or remove a user of a team
description: Granting this permission will give any user with this role full permissions on this team.
group_label: Administration
flags:
deprecated: false
- name: access cloud api
label: Access the Cloud API
description: Grants the ability to use the API and bypass all other permissions via command line tools.
group_label: Administration
flags:
deprecated: false
- name: administer cron non-prod
label: Modify cron tasks for non-production environments
description: null
group_label: Cron
flags:
deprecated: false
- name: administer cron prod
label: Modify cron tasks for the production environment
description: null
group_label: Cron
flags:
deprecated: false
- name: create support ticket
label: Create a support ticket
description: null
group_label: Support
flags:
deprecated: false
- name: edit any support ticket
label: View and edit any support tickets for a subscription
description: null
group_label: Support
flags:
deprecated: false
- name: view build plans
label: View Build plans
description: null
group_label: Build
flags:
deprecated: false
- name: edit build plans
label: Edit Build plans
description: null
group_label: Build
flags:
deprecated: false
- name: run build plans
label: Run Build plans
description: null
group_label: Build
flags:
deprecated: false
- name: add ssh key to git
label: Add SSH key to git repository
description: null
group_label: SSH keys
flags:
deprecated: false
- name: add ssh key to non-prod
label: Add SSH key to non-production environments
description: null
group_label: SSH keys
flags:
deprecated: false
- name: add ssh key to prod
label: Add SSH key to the production environment
description: null
group_label: SSH keys
flags:
deprecated: false
- name: view remote administration
label: View Remote Administration
description: This permission is only relevant if your subscription has remote administration.
group_label: Administration
flags:
deprecated: false
- name: edit remote administration
label: Edit Remote Administration
description: This permission is only relevant if your subscription has remote administration.
group_label: Administration
flags:
deprecated: false
- name: clear caches on prod
label: Clear caches for the production environment
description: null
group_label: Workflow
flags:
deprecated: false
- name: clear caches on non-prod
label: Clear caches for non-production environments
description: null
group_label: Workflow
flags:
deprecated: false
/roles/{roleUuid}:
servers:
- url: https://cloud.acquia.com/api
description: Cloud API
get:
tags:
- Teams and Permissions
summary: Return details about a specific role.
description: 'Roles may be assigned to team members, and grant various permissions to the applications that the team is assigned
to. Roles are unique within a organization.
'
operationId: getRole
x-cli-name: tps:role-find
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_role-uuid'
security:
- Acquia_Cloud_API_Documentation_OAuth2: []
responses:
'200':
description: OK
content:
application/hal+json:
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_role'
example:
uuid: c885728d-cbbe-4e54-bf09-19b751b6d0c7
name: My Custom Role
description: Some details about my custom role.
permissions:
- name: deploy to non-prod
label: Pull and deploy code, files, or databases to non-production environments
description: Grants the ability to enable or disable live development and non-production work.
group_label: Workflow
flags:
deprecated: false
- name: configure non-prod env
label: Configure non-production environments
description: null
group_label: Workflow
flags:
deprecated: false
- name: download logs non-prod
label: Download logs for non-production environments
description: null
group_label: Logs
flags:
deprecated: false
- name: view database connection
label: View database connection details (username, password, or hostname)
description: null
group_label: Databases
flags:
deprecated: false
organization:
uuid: d122cc06-35bd-41bf-9baa-5b770c8ca0f1
name: My Organization
last_edited:
edited_at: '2011-03-28T13:09:41-04:00'
user:
uuid: 590909a0-e819-43e6-a8e3-212dc3e35852
first_name: Jane
last_name: Doe
mail: jane.doe@example.com
picture_url: https://accounts.acquia.com/sites/default/files/avatars/123abc?mail=jane.doe@example.com
username: jane.doe
flags:
default: false
'404':
description: Not Found
content:
application/hal+json:
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
examples:
Role not found:
value:
error: not_found
message: The role you are trying to access does not exist, or you do not have permission to access it.
delete:
tags:
- Teams and Permissions
summary: Deletes a specific role by its UUID.
description: Deletes a specific role.
operationId: deleteRole
x-cli-name: tps:roles-delete
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_role-uuid'
security:
- Acquia_Cloud_API_Documentation_OAuth2: []
responses:
'200':
description: OK
content:
application/hal+json:
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_message'
example:
message: Deleted role.
'404':
description: Not Found
content:
application/hal+json:
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
examples:
Role not found:
value:
error: not_found
message: The role you are trying to delete does not exist, or you do not have permission to delete it.
put:
tags:
- Teams and Permissions
summary: Updates a role.
operationId: putRoleByUuid
x-cli-name: tps:role-update
security:
- Acquia_Cloud_API_Documentation_OAuth2: []
description: Modifies a role.
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_role-uuid'
requestBody:
required: true
content:
application/hal+json:
schema:
type: object
properties:
name:
type: string
description: The new name of the role.
minLength: 1
maxLength: 255
description:
type: string
description: The new description of the role.
minLength: 1
maxLength: 255
permissions:
type: array
description: An array of the permissions associated with the role.
items:
type: string
example:
name: My new role name
description: My new role description.
permisions:
- permission 4
- permission 5
application/x-www-form-urlencoded:
schema:
type: object
properties:
name:
description: The updated name of the role.
type: string
minLength: 1
maxLength: 255
description:
description: The updated description of the role.
type: string
minLength: 1
maxLength: 255
permissions:
description: A list of permissions to grant to this role.
type: array
items:
type: string
example:
name: My new role name
description: My new role description.
status:
- permission 4
- permission 5
example:
name: My new application name
responses:
'200':
description: OK
content:
application/hal+json:
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_message'
example:
message: Updating role.
'404':
description: Not Found
content:
application/hal+json:
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
examples:
Role not found:
value:
error: not_found
message: The role you are trying to access does not exist, or you do not have permission to edit it.
/teams:
servers:
- url: https://cloud.acquia.com/api
description: Cloud API
get:
tags:
- Teams and Permissions
summary: Return teams the current user has access to.
description: 'Returns a list of teams the current user has access to.
Filterable fields:
* `name`
Sortable fields:
* `name`
'
operationId: getTeams
x-cli-name: tps:teams-list
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_sort'
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_filter'
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_limit'
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_offset'
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_range'
security:
- Acquia_Cloud_API_Documentation_OAuth2: []
responses:
'200':
description: OK
content:
application/hal+json:
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_teams'
example:
total: 2
_links:
self:
href: https://cloud.acquia.com/api/teams
_embedded:
items:
- uuid: abcd1234-82b5-11e3-9170-12313920a02c
name: Team Name 1
created_at: 2013-10-28T14:16:07-0700
updated_at: 2015-02-19T08:53:10-0800
organization:
uuid: 2375e327-3fff-11e3-9170-12313920a02c
name: Sample Organization
_links:
self:
href: https://cloud.acquia.com/api/teams/2c9ea556-4016-11e3-9170-12313920a02c
- uuid: 1234abcd-82b5-11e3-9170-12313920a02c
name: Team Name 2
created_at: 2014-05-27T11:55:39-0700
updated_at: 2015-01-30T05:49:16-0800
organization:
uuid: 2375e327-3fff-11e3-9170-12313920a02c
name: Sample Organization
_links:
self:
href: https://cloud.acquia.com/api/teams/9ca6ecc0-e5d0-11e3-9eb3-22000b04072f
'403':
description: Forbidden
content:
application/hal+json:
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
examples:
No permission:
value:
error: forbidden
message: You do not have permission to view teams.
/teams/{teamUuid}:
servers:
- url: https://cloud.acquia.com/api
description: Cloud API
get:
tags:
- Teams and Permissions
summary: Return details about a specific team.
description: Return details about a specific team.
operationId: getTeam
x-cli-name: tps:team-find
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_team-uuid'
security:
- Acquia_Cloud_API_Documentation_OAuth2: []
responses:
'200':
description: OK
content:
application/hal+json:
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_team'
example:
uuid: 2c9ea556-4016-11e3-9170-12313920a02c
name: Sample Team
created_at: 2013-10-28T14:16:07-0700
updated_at: 2015-02-19T08:53:10-0800
organization:
uuid: 2375e327-3fff-11e3-9170-12313920a02c
name: Sample Organization
_links:
self:
href: https://cloud.acquia.com/api/teams/2c9ea556-4016-11e3-9170-12313920a02c
members:
href: https://cloud.acquia.com/api/teams/2c9ea556-4016-11e3-9170-12313920a02c/members
applications:
href: https://cloud.acquia.com/api/teams/2c9ea556-4016-11e3-9170-12313920a02c/applications
invites:
href: https://cloud.acquia.com/api/teams/2c9ea556-4016-11e3-9170-12313920a02c/invites
parent:
href: https://cloud.acquia.com/api/teams
_embedded:
organization:
- uuid: 2375e327-3fff-11e3-9170-12313920a02c
name: Sample Organization
_links:
self:
href: https://cloud.acquia.com/api/organizations/2375e327-3fff-11e3-9170-12313920a02c
'404':
description: Not Found
content:
application/hal+json:
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
examples:
Role not found:
value:
error: not_found
message: The team you are trying to access does not exist, or you do not have permission to access it.
put:
tags:
- Teams and Permissions
summary: Change the name of a team.
description: Change the name of a team.
operationId: putTeamsName
x-cli-name: tps:team-update
security:
- Acquia_Cloud_API_Documentation_OAuth2: []
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_team-uuid'
requestBody:
required: true
content:
application/hal+json:
schema:
type: object
properties:
name:
type: string
description: The new name of the team.
minLength: 1
maxLength: 255
example:
name: My new team name
application/x-www-form-urlencoded:
schema:
type: object
properties:
name:
type: string
description: The new name of the team.
minLength: 1
maxLength: 255
example:
name: My new team name
responses:
'200':
description: OK
content:
application/hal+json:
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_message'
examples:
Team renamed:
value:
message: Team renamed.
'404':
description: Not Found
content:
application/hal+json:
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
examples:
Role not found:
value:
error: not_found
message: The team you are trying to access does not exist, or you do not have permission to rename it.
delete:
tags:
- Teams and Permissions
summary: Deletes a specific team by its UUID.
description: Deletes a specific team by its UUID.
operationId: deleteTeam
x-cli-name: tps:team-delete
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_team-uuid'
security:
- Acquia_Cloud_API_Documentation_OAuth2: []
responses:
'200':
description: OK
content:
application/hal+json:
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_message'
examples:
Removed team:
value:
message: Removed team.
'404':
description: Not Found
content:
application/hal+json:
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
examples:
# --- truncated at 32 KB (82 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/acquia/refs/heads/main/openapi/acquia-teams-and-permissions-api-openapi.yml