Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

Acquia

Acquia Organizations API

The Organizations API from Acquia — 18 operation(s) for organizations.

Documentation Provider Profile APIs.io OpenAPI GitHub

Acquia Organizations API is one of 21 APIs that Acquia publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Organizations. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 27 operations across 18 paths, and defines 41 schemas. It is described by OpenAPI 3.0.0, at version 2.0.0.

27 operations 18 paths 41 schemas 4 DELETE16 GET6 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
2.0.0
Authentication
OAuth 2.0, API Key, API Key, API Key
Contact
Customer Experience Engineering (CXE)
Resource Areas
1

Authentication & Security 4

Acquia Organizations API declares 4 security schemes for authenticating requests. It supports OAuth 2.0 (Acquia_Cloud_API_Documentation_OAuth2) using the clientCredentials flow. An API key is passed in the header as Authorization (Codebase_Service_JWT). An API key is passed in the header as Authorization (MEO_Environment_Service_JWT). An API key is passed in the header as Authorization (Site_Service_JWT).

  • Acquia_Cloud_API_Documentation_OAuth2 — All Cloud API calls need to be authenticated in order to work. You authenticate using a token that you can generate on your Acquia Profile page. To generate a…
  • Codebase_Service_JWT — Value for the Authorization header parameter.
  • MEO_Environment_Service_JWT — Value for the Authorization header parameter.
  • Site_Service_JWT — Value for the Authorization header parameter.

Paths & Operations 27

Across 18 paths, the API surfaces 27 operations — 4 DELETE, 16 GET, 6 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Organizations 27
GET
/organizations
Return a list of organizations.
getOrganizations → 200
GET
/organizations/{organizationUuid}
Return details about a specific organization.
getOrganizationByUuid 1 param → 200404
PUT
/organizations/{organizationUuid}
Renames an organization.
putOrganization 1 param body → 200400404
DELETE
/organizations/{organizationUuid}
Deletes a specific organization by its UUID.
deleteOrganization 1 param → 200400403404
POST
/organizations/{organizationUuid}/actions/change-owner
Changes the organization owner.
postChangeOrganizationOwner 1 param body → 200403404409
POST
/organizations/{organizationUuid}/actions/leave
Removes your account from an organization.
postLeaveOrganization 1 param → 200404409
GET
/organizations/{organizationUuid}/admins
Returns a list of organization administrators.
getOrganizationAdmins 5 params → 200404
GET
/organizations/{organizationUuid}/admins/{userUuid}
Returns the user profile of this organization administrator.
getOrganizationAdmin 2 params → 200403404
DELETE
/organizations/{organizationUuid}/admins/{userUuid}
Removes the user from the list of administrators for the organization.
deleteOrganizationAdmin 2 params → 200404
GET
/organizations/{organizationUuid}/admin-invites
Gets a list of invitations of administrators for this organization.
getOrganizationAdminInvites 6 params → 200404
POST
/organizations/{organizationUuid}/admin-invites
Invites a user to be an administrator in this organization.
postOrganizationAdminInvite 1 param body → 200404409
GET
/organizations/{organizationUuid}/applications
Returns a list of applications that belong to the organization.
getOrganizationApplications 5 params → 200404
GET
/organizations/{organizationUuid}/available-tags
Returns a list of all available application tags.
getOrganizationAvailableTags 1 param → 200404
POST
/organizations/{organizationUuid}/available-tags
Adds bulk tags to organization resources.
postOrganizationAvailableTags 1 param body → 201403404
DELETE
/organizations/{organizationUuid}/available-tags
Deletes bulk tags from organization resources.
deleteOrganizationAvailableTags 1 param body → 200403404
GET
/organizations/{organizationUuid}/identity-provider
Returns an identity provider for an organization.
getOrganizationIdentityProvider 1 param → 200404
GET
/organizations/{organizationUuid}/members
Returns a list of all organization members.
getOrganizationMembers 4 params → 200404
GET
/organizations/{organizationUuid}/members/{userUuid}
Returns the user profile of this organization member.
getOrganizationMember 2 params → 200403404
DELETE
/organizations/{organizationUuid}/members/{userUuid}
Removes the member from the organization.
postOrganizationMemberDelete 2 params → 200404409
GET
/organizations/{organizationUuid}/members/{userUuid}/applications
Returns a list of applications that an organization member has access to.
getOrganizationMemberApplications 2 params → 200403404
GET
/organizations/{organizationUuid}/notifications
Returns a list of notifications associated with this organization by its UUID.
getOrganizationNotifications 5 params → 200404
GET
/organizations/{organizationUuid}/roles
Returns a list of all the canonical roles within the organization.
getOrganizationRoles 6 params → 200404
POST
/organizations/{organizationUuid}/roles
Creates a role.
postOrganizationRoles 1 param body → 200400404409
GET
/organizations/{organizationUuid}/subscriptions
Returns a list of subscriptions that belong to the organization.
getOrganizationSubscriptions 6 params → 200404
GET
/organizations/{organizationUuid}/team-invites
Gets a list of member invitations for all teams in this organization.
getOrganizationTeamInvites 5 params → 200404
GET
/organizations/{organizationUuid}/teams
Returns a list of teams associated with the organization.
getOrganizationTeams 5 params → 200404
POST
/organizations/{organizationUuid}/teams
Creates a team.
postOrganizationTeams 1 param body → 200201404409

Schemas 41

The contract defines 41 schemas that model the data the API accepts and returns. The most detailed are Acquia_Cloud_API_Documentation_organization (12 properties), Acquia_Cloud_API_Documentation_notification-stub (11 properties), Acquia_Cloud_API_Documentation_organization-no-embedded (11 properties), Acquia_Cloud_API_Documentation_organization-team-invite (11 properties). Each schema is shown below with its type and property counts.

Acquia_Cloud_API_Documentation_resource-tag-organization
object
3 properties 3 required
Acquia_Cloud_API_Documentation_user-stub-embedded
object
A related user.
7 properties 7 required
Acquia_Cloud_API_Documentation_permission
object
5 properties 5 required
Acquia_Cloud_API_Documentation_organization
object
Organization information.
12 properties 12 required
Acquia_Cloud_API_Documentation_pagination
object
A collection of pagination properties.
3 properties
Acquia_Cloud_API_Documentation_permission-flags
object
An array of various flags regarding the status of the permission.
1 property
Acquia_Cloud_API_Documentation_applications
object
3 properties
Acquia_Cloud_API_Documentation_organization-user-profile
object
A user profile for an organization member.
8 properties 8 required
Acquia_Cloud_API_Documentation_organization-applications
object
A collection of applications associated with an organization.
3 properties 3 required
Acquia_Cloud_API_Documentation_subscription-stub
object
The subscription this application belongs to.
2 properties 2 required
Acquia_Cloud_API_Documentation_invite-flags
object
An array of various flags providing more context for the Invite response object.
1 property
Acquia_Cloud_API_Documentation_organization-admin-user-profile
object
An organization admin user profile.
9 properties 9 required
Acquia_Cloud_API_Documentation_application-no-embedded
object
10 properties 10 required
Acquia_Cloud_API_Documentation_validation-error
object
A validation error.
2 properties 2 required
Acquia_Cloud_API_Documentation_message
object
1 property 1 required
Acquia_Cloud_API_Documentation_role
object
7 properties
Acquia_Cloud_API_Documentation_roles
object
Collection of roles.
3 properties
Acquia_Cloud_API_Documentation_organizations-notifications
object
A collection of notifications matching the request parameters.
4 properties
Acquia_Cloud_API_Documentation_organization-team-invites
object
A collection of invitations to join a team.
3 properties 3 required
Acquia_Cloud_API_Documentation_organization-no-embedded
object
Organization information.
11 properties 11 required
Acquia_Cloud_API_Documentation_organization-admin-user-profiles
object
A collection of organization administrator user profiles.
3 properties 3 required
Acquia_Cloud_API_Documentation_message-with-links
object
2 properties 2 required
Acquia_Cloud_API_Documentation_identity-provider
object
8 properties 8 required
Acquia_Cloud_API_Documentation_organization-stub
object
2 properties 2 required
Acquia_Cloud_API_Documentation_organization-available-tags
object
A collection of organization members.
3 properties 3 required
Acquia_Cloud_API_Documentation_user-stub
object
6 properties 6 required
Acquia_Cloud_API_Documentation_team-stub
object
2 properties 2 required
Acquia_Cloud_API_Documentation_organizations
object
A collection of all organizations the current user has access to.
3 properties
Acquia_Cloud_API_Documentation_application-flags
object
An array of various flags that indicate functionality associated with applications.
1 property
Acquia_Cloud_API_Documentation_organization-admin-invite
object
An invitation to become an organization administrator.
8 properties 8 required
Acquia_Cloud_API_Documentation_organization-team-stub
object
A team within an organization.
3 properties 3 required
Acquia_Cloud_API_Documentation_notification-stub
object
A notification about an event or a task.
11 properties 10 required
Acquia_Cloud_API_Documentation_role-stub
object
2 properties 2 required
Acquia_Cloud_API_Documentation_team
object
6 properties 6 required
Acquia_Cloud_API_Documentation_teams
object
A collection of teams.
3 properties 3 required
Acquia_Cloud_API_Documentation_organization-members
object
A collection of organization members.
3 properties 3 required
Acquia_Cloud_API_Documentation_organization-team-invite
object
11 properties 11 required
Acquia_Cloud_API_Documentation_error
object
2 properties 2 required
Acquia_Cloud_API_Documentation_application-stub
object
2 properties 2 required
Acquia_Cloud_API_Documentation_links
object
HAL links about the current resource.
1 property 1 required
Acquia_Cloud_API_Documentation_organization-admin-invites
object
A collection of invitations to become an organization administrator.
3 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

acquia-organizations-api-openapi.yml Raw ↑

Other APIs Acquia publishes across the network.

Acquia Cloud Site Factory API
AE Profile APIs.io
Acquia Content Hub API
AE Profile APIs.io
Acquia Account API
AE Profile APIs.io
Acquia Agreements API
AE Profile APIs.io
Acquia Application Performance Monitoring Services API
AE Profile APIs.io
Acquia Applications API
AE Profile APIs.io
Acquia Cloud IDE API
AE Profile APIs.io
Acquia Codebases API
AE Profile APIs.io
Acquia Current system health API
AE Profile APIs.io
Acquia Distributions API
AE Profile APIs.io
Acquia Email API
AE Profile APIs.io
Acquia Environments API
AE Profile APIs.io
#Organizations
← Back to A APIs
API Details
ID
acquia:acquia-organizations-api
Docs
https://cloudapi-docs.acquia.com/
Provider
Acquia
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network