Acquia Organizations API
The Organizations API from Acquia — 18 operation(s) for organizations.
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 Organizations API
version: 2.0.0
x-logo:
altText: Acquia Cloud
backgroundColor: '#FFFFFF'
url: assets/cloud-platform.svg
servers: []
tags:
- name: Organizations
x-displayName: Organizations
paths:
/organizations:
servers:
- url: https://cloud.acquia.com/api
description: Cloud API
get:
tags:
- Organizations
summary: Return a list of organizations.
description: 'An organization is a container for some or all of a customer''s subscriptions. The owner of the organization is the
main billing contact. The owner, along with organization administrators, can set up teams and roles to grant various
permissions to access the applications within each subscription in the organization. Results can be filtered and
sorted by name.
'
operationId: getOrganizations
x-cli-name: organizations:list
responses:
'200':
description: OK
content:
application/hal+json:
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_organizations'
example:
total: 3
_links:
self:
href: https://cloud.acquia.com/api/organizations
sort:
href: https://cloud.acquia.com/api/organizations{?sort}
templated: true
filter:
href: https://cloud.acquia.com/api/organizations{?filter}
templated: true
limit:
href: https://cloud.acquia.com/api/organizations{?limit}
templated: true
parent:
href: https://cloud.acquia.com/api/
_embedded:
items:
- id: '6'
uuid: bfafd31a-83a6-4257-b0ec-afdeff83117a
name: Sample organization
subscriptions_total: 115
admins_total: 2
users_total: 82
teams_total: 13
roles_total: 4
owner:
uuid: 10be1d3e-f2b4-4d34-855d-321df3938ffd
first_name: First
last_name: Last
picture_url: https://accounts.acquia.com/path/to/image.png
username: user.name
mail: user.name@example.com
flags:
federated_authentication: false
_links:
self:
href: https://cloud.acquia.com/api/organizations/bfafd31a-83a6-4257-b0ec-afdeff83117a
- id: '4841'
uuid: 1992bfe6-c5bf-4a90-810e-a65acab42c6e
name: Sample organization 2
subscriptions_total: 4
admins_total: 0
users_total: 0
teams_total: 0
roles_total: 0
owner:
uuid: 10be1d3e-f2b4-4d34-855d-321df3938ffd
first_name: First
last_name: Last
picture_url: https://accounts.acquia.com/path/to/image.png
username: user.name
mail: user.name@example.com
flags:
federated_authentication: true
_links:
self:
href: https://cloud.acquia.com/api/organizations/1992bfe6-c5bf-4a90-810e-a65acab42c6e
- id: '4841'
uuid: 3ff5a541-64cf-4334-acc7-af70b4374373
name: Sample organization 3
subscriptions_total: 4
admins_total: 0
users_total: 0
teams_total: 0
roles_total: 0
owner:
uuid: 10be1d3e-f2b4-4d34-855d-321df3938ffd
first_name: First
last_name: Last
picture_url: https://accounts.acquia.com/path/to/image.png
username: user.name
mail: user.name@example.com
flags:
federated_authentication: false
_links:
self:
href: https://cloud.acquia.com/api/organizations/3ff5a541-64cf-4334-acc7-af70b4374373
/organizations/{organizationUuid}:
servers:
- url: https://cloud.acquia.com/api
description: Cloud API
get:
tags:
- Organizations
summary: Return details about a specific organization.
operationId: getOrganizationByUuid
x-cli-name: organizations:find
security:
- Acquia_Cloud_API_Documentation_OAuth2: []
description: A specific organization.
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_organization-uuid'
responses:
'200':
description: OK
content:
application/hal+json:
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_organization'
example:
id: '6'
uuid: a81c08c6-a02f-4b57-87e3-c3f395a2bb34
name: Sample organization
subscriptions_total: 115
admins_total: 2
users_total: 82
teams_total: 13
roles_total: 4
owner:
uuid: 98d56f28-cff0-421d-9985-58f15cbd6907
first_name: First
last_name: Last
picture_url: https://accounts.acquia.com/path/to/image.png
username: user.name
mail: user.name@example.com
flags:
federated_authentication: false
_links:
self:
href: https://cloud.acquia.com/api/organizations/a81c08c6-a02f-4b57-87e3-c3f395a2bb34
admin-invites:
href: https://cloud.acquia.com/api/organizations/a81c08c6-a02f-4b57-87e3-c3f395a2bb34/admin-invites
admins:
href: https://cloud.acquia.com/api/organizations/a81c08c6-a02f-4b57-87e3-c3f395a2bb34/admins
applications:
href: https://cloud.acquia.com/api/organizations/a81c08c6-a02f-4b57-87e3-c3f395a2bb34/applications
identity-provider:
href: https://cloud.acquia.com/api/organizations/a81c08c6-a02f-4b57-87e3-c3f395a2bb34/identity-provider
members:
href: https://cloud.acquia.com/api/organizations/a81c08c6-a02f-4b57-87e3-c3f395a2bb34/members
roles:
href: https://cloud.acquia.com/api/organizations/a81c08c6-a02f-4b57-87e3-c3f395a2bb34/roles
subscriptions:
href: https://cloud.acquia.com/api/organizations/a81c08c6-a02f-4b57-87e3-c3f395a2bb34/subscriptions
team-invites:
href: https://cloud.acquia.com/api/organizations/a81c08c6-a02f-4b57-87e3-c3f395a2bb34/team-invites
teams:
href: https://cloud.acquia.com/api/organizations/a81c08c6-a02f-4b57-87e3-c3f395a2bb34/teams
parent:
href: https://cloud.acquia.com/api/organizations
_embedded:
owner:
uuid: 98d56f28-cff0-421d-9985-58f15cbd6907
first_name: First
last_name: Last
picture_url: https://accounts.acquia.com/path/to/image.png
username: user.name
mail: user.name@example.com
_links:
self:
href: https://cloud.acquia.com/api/users/98d56f28-cff0-421d-9985-58f15cbd6907
'404':
description: Not Found
content:
application/hal+json:
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
example:
error: not_found
message: The organization you are trying to access does not exist, or you do not have permission to access it.
put:
tags:
- Organizations
summary: Renames an organization.
description: Renames an organization.
operationId: putOrganization
x-cli-name: organizations:update
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_organization-uuid'
requestBody:
required: true
content:
application/hal+json:
schema:
type: object
required:
- name
properties:
name:
type: string
description: The new name of the organization.
minLength: 1
maxLength: 255
example:
name: My renamed organization
application/x-www-form-urlencoded:
schema:
type: object
required:
- name
properties:
name:
type: string
description: The new name of the organization.
minLength: 1
maxLength: 255
example:
name: My renamed organization
security:
- Acquia_Cloud_API_Documentation_OAuth2: []
responses:
'200':
description: OK
content:
application/hal+json:
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_message'
examples:
Organization renamed:
value:
message: Organization renamed.
'400':
description: Bad Request
content:
application/hal+json:
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_validation-error'
examples:
Name unavailable:
value:
error: conflict
message:
name: The organization owner already has an organization with this name.
'404':
description: Not Found
content:
application/hal+json:
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
examples:
Not Found or Does Not Exist:
value:
error: not_found
message: The organization you are trying to access does not exist, or you do not have permission to access it.
delete:
tags:
- Organizations
summary: Deletes a specific organization by its UUID.
description: Deletes a specific organization.
operationId: deleteOrganization
x-cli-name: organizations:delete
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_organization-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:
Deleted organization:
value:
message: Deleted organization.
'400':
description: Bad Request
content:
application/hal+json:
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_validation-error'
examples:
Associated subscriptions:
value:
error: validation_error
message:
general: This organization has associated subscriptions and cannot be deleted.
'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 delete this organization.
'404':
description: Not Found
content:
application/hal+json:
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
examples:
Not Found or No Permission:
value:
error: not_found
message: The organization you are trying to delete does not exist, or you do not have permission to delete it.
Not Found:
value:
error: not_found
message: The organization with UUID bfafd31a-83a6-4257-b0ec-afdeff83117a does not exist.
/organizations/{organizationUuid}/actions/change-owner:
servers:
- url: https://cloud.acquia.com/api
description: Cloud API
post:
tags:
- Organizations
summary: Changes the organization owner.
description: Changes the organization owner.
operationId: postChangeOrganizationOwner
x-cli-name: organizations:owner-change
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_organization-uuid'
requestBody:
required: true
content:
application/hal+json:
schema:
type: object
required:
- user_uuid
properties:
user_uuid:
type: string
description: The uuid of the user you want to make the owner for this organization.
format: uuid
application/x-www-form-urlencoded:
schema:
type: object
required:
- user_uuid
properties:
user_uuid:
type: string
description: The uuid of the user you want to make the owner for this organization.
format: 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:
Changed owner:
value:
message: Changed organization owner.
'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 change the organization owner.
'404':
description: Not Found
content:
application/hal+json:
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
examples:
No organization or permission:
value:
error: not_found
message: The organization you are trying to access does not exist, or you do not have permission to access it.
No organization:
value:
error: not_found
message: The organization with UUID 07557159-264f-45eb-8f70-553b8ed21b16 does not exist.
No user:
value:
error: not_found
message: The user with UUID 3ba405e6-8621-4557-b78a-7d92baa79783 does not exist.
'409':
description: Conflict
content:
application/hal+json:
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
examples:
New owner must be administrator:
value:
error: conflict
message: The new owner must be an existing administrator of the organization.
/organizations/{organizationUuid}/actions/leave:
servers:
- url: https://cloud.acquia.com/api
description: Cloud API
post:
tags:
- Organizations
summary: Removes your account from an organization.
description: Removes your account from an organization.
operationId: postLeaveOrganization
x-cli-name: organizations:leave
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_organization-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:
Left organization:
value:
message: Left organization.
'404':
description: Not Found
content:
application/hal+json:
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
examples:
No organization or permission:
value:
error: not_found
message: The organization you are trying to access does not exist, or you do not have permission to access it.
No organization:
value:
error: not_found
message: The organization with UUID 07557159-264f-45eb-8f70-553b8ed21b16 does not exist.
Not a member:
value:
error: not_found
message: You are not a member of this organization.
No user:
value:
error: not_found
message: The user with UUID 3ba405e6-8621-4557-b78a-7d92baa79783 does not exist.
'409':
description: Conflict
content:
application/hal+json:
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
examples:
Organization owner cannot be removed:
value:
error: conflict
message: The organization owner cannot be removed.
/organizations/{organizationUuid}/admins:
servers:
- url: https://cloud.acquia.com/api
description: Cloud API
get:
tags:
- Organizations
summary: Returns a list of organization administrators.
description: 'Returns a list of organization administrators.
Filterable fields:
* `first_name`
* `last_name`
* `mail`
* `username`
Sortable fields:
* `first_name`
* `last_name`
* `mail`
* `username`
'
operationId: getOrganizationAdmins
x-cli-name: organizations:admin-list
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_organization-uuid'
- $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'
security:
- Acquia_Cloud_API_Documentation_OAuth2: []
responses:
'200':
description: OK
content:
application/hal+json:
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_organization-admin-user-profiles'
example:
total: 3
_links:
self:
href: https://cloud.acquia.com/api/organizations/3c9ea553-3216-11e3-9170-12313920a23a/admins
parent:
href: https://cloud.acquia.com/api/organizations/3c9ea553-3216-11e3-9170-12313920a23a
_embedded:
items:
- uuid: 5aa902c5-f1c1-6c94-edfa-86bc58d0dce3
first_name: James
last_name: Kirk
last_login_at: 2017-03-28T13:07:54-0500
mail: james.kirk@example.com
picture_url: https://accounts.acquia.com/images/users/5aa902c5-f1c1-6c94-edfa-86bc58d0dce3/style/avatar
username: james.kirk
flags:
owner: true
_links:
self:
href: https://cloud.acquia.com/api/organizations/3c9ea553-3216-11e3-9170-12313920a23a/admins/5aa902c5-f1c1-6c94-edfa-86bc58d0dce3
- uuid: 30dacb5e-4122-11e1-9eb5-12313928d3c2
first_name: Christopher
last_name: Pike
last_login_at: 2016-03-28T13:07:54-0500
mail: chris.pike@example.com
picture_url: https://accounts.acquia.com/images/users/30dacb5e-4122-11e1-9eb5-12313928d3c2/style/avatar
username: chris.pike
flags:
owner: false
_links:
self:
href: https://cloud.acquia.com/api/organizations/3c9ea553-3216-11e3-9170-12313920a23a/admins/30dacb5e-4122-11e1-9eb5-12313928d3c2
- uuid: 3bcddc3a-52ba-4cce-aaa3-9adf721c1b52
first_name: Jonathan
last_name: Archer
last_login_at: null
mail: jonathan.archer@example.com
picture_url: https://accounts.acquia.com/images/users/3bcddc3a-52ba-4cce-aaa3-9adf721c1b52/style/avatar
username: jonathan.archer
flags:
owner: false
_links:
self:
href: https://cloud.acquia.com/api/organizations/3c9ea553-3216-11e3-9170-12313920a23a/admins/3bcddc3a-52ba-4cce-aaa3-9adf721c1b52
'404':
description: Not Found
content:
application/hal+json:
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
examples:
Not found:
value:
error: not_found
message: The organization you are trying to access does not exist, or you do not have permission to access it.
/organizations/{organizationUuid}/admins/{userUuid}:
servers:
- url: https://cloud.acquia.com/api
description: Cloud API
get:
tags:
- Organizations
summary: Returns the user profile of this organization administrator.
description: Returns the user profile of this organization administrator.
operationId: getOrganizationAdmin
x-cli-name: organizations:admin-find
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_organization-uuid'
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_user-uuid'
security:
- Acquia_Cloud_API_Documentation_OAuth2: []
responses:
'200':
description: OK
content:
application/hal+json:
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_organization-admin-user-profile'
example:
uuid: 5aa902c5-f1c1-6c94-edfa-86bc58d0dce3
first_name: James
last_name: Kirk
last_login_at: 2017-03-28T13:07:54-0500
mail: james.kirk@example.com
picture_url: https://accounts.acquia.com/images/users/5aa902c5-f1c1-6c94-edfa-86bc58d0dce3/style/avatar
username: james.kirk
flags:
owner: true
_links:
self:
href: https://cloud.acquia.com/api/organizations/2375e327-3fff-11e3-9170-12313920a02c/admins/5aa902c5-f1c1-6c94-edfa-86bc58d0dce3
parent:
href: https://cloud.acquia.com/api/organizations/2375e327-3fff-11e3-9170-12313920a02c/admins
'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 this administrator.
'404':
description: Not Found
content:
application/hal+json:
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
examples:
Not found or no permission:
value:
error: not_found
message: The organization you are trying to access does not exist, or you do not have permission to access it.
delete:
tags:
- Organizations
summary: Removes the user from the list of administrators for the organization.
description: Removes the user from the list of administrators for the organization.
operationId: deleteOrganizationAdmin
x-cli-name: organizations:admin-delete
security:
- Acquia_Cloud_API_Documentation_OAuth2: []
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_organization-uuid'
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_user-uuid'
responses:
'200':
description: OK
content:
application/hal+json:
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_message'
examples:
Member removed:
value:
message: Organization administrator removed.
'404':
description: Not Found
content:
application/hal+json:
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
examples:
No organization or permission:
value:
error: not_found
message: The organization you are trying to administer does not exist, or you do not have permission to administer it.
Organization not found:
value:
error: not_found
message: The organization with UUID 653077de-9349-4822-a104-5e5a8dd2ba05 does not exist.
User mismatch:
value:
error: validation_failed
message: The user is not an administrator for this organization.
User not found:
value:
error: not_found
message: The user with UUID 5404f30f-465c-4d94-80f1-61f1d35fde0b does not exist.
/organizations/{organizationUuid}/admin-invites:
servers:
- url: https://cloud.acquia.com/api
description: Cloud API
get:
tags:
- Organizations
summary: Gets a list of invitations of administrators for this organization.
description: 'Gets a list of invitations of administrators for this organization.
Filterable fields:
* `first_name`
* `last_name`
* `permission`
Sortable fields:
* `first_name`
* `last_name`
* `permission`
'
operationId: getOrganizationAdminInvites
x-cli-name: organizations:admin-invite-list
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_organization-uuid'
- $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_organization-admin-invites'
example:
total: 2
_links:
self:
href: https://cloud.acquia.com/api/organizations/3c9ea553-3216-11e3-9170-12313920a23a/admin-invites
parent:
href: https://cloud.acquia.
# --- truncated at 32 KB (148 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/acquia/refs/heads/main/openapi/acquia-organizations-api-openapi.yml