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

Acquia Account API

The Account API from Acquia — 23 operation(s) for account.

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

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

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

27 operations 23 paths 35 schemas 2 DELETE19 GET6 POST

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
Resource Areas
1

Authentication & Security 4

Acquia Account 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 23 paths, the API surfaces 27 operations — 2 DELETE, 19 GET, 6 POST. Each is listed below with its method, path, parameters, and response codes.

Account 27
GET
/account
Acquia Returns Details About Your Account.
getAccount → 200404
POST
/account/applications/{applicationUuid}/actions/mark-recent
Acquia Marks an Application as Recently Viewed.
postAccountApplicationMarkRecent 1 param → 200404409
POST
/account/applications/{applicationUuid}/actions/star
Acquia Stars an Application.
postAccountApplicationStar 1 param → 200404409
POST
/account/applications/{applicationUuid}/actions/unstar
Acquia Removes an Application from the User's Starred List.
postAccountApplicationUnstar 1 param → 200404409
GET
/account/applications/{applicationUuid}/has-permission
Acquia Returns Whether Your Account Has Access to a Specific Application Permission.
getAccountApplicationHasPermission 2 params → 200403404
GET
/account/applications/{applicationUuid}/is-admin
Acquia Returns Whether Your Account is an Administrator for an Application.
getAccountApplicationIsAdministrator 1 param → 200403404
GET
/account/applications/{applicationUuid}/is-owner
Acquia Returns Whether Your Account is the Owner for an Application.
getAccountApplicationIsOwner 1 param → 200404
GET
/account/drush-aliases/download
Acquia Returns the Drush Aliases as a Compressed Archive Download.
getAccountDrushAliasesDownload 1 param → 200403404
GET
/account/ides
Acquia Returns a List of Cloud IDEs Associated with the Current User.
getAccountIdes → 200404
GET
/account/invites
Acquia Gets a List of All Organization Admin and Team Invites That Are Pending for the Current User.
getAccountInvites 6 params → 200404
GET
/account/messages
Acquia Returns a List of Messages Associated with the Current User.
getAccountMessages 6 params → 200404
GET
/account/organizations/{organizationUuid}/is-admin
Acquia Returns Whether Your Account is an Administrator for an Organization.
getAccountOrganizationIsAdministrator 1 param → 200403404
GET
/account/organizations/{organizationUuid}/is-owner
Acquia Returns Whether Your Account is the Owner for an Organization.
getAccountOrganizationIsOwner 1 param → 200404
POST
/account/password
Acquia Verifies That the Supplied Password Matches the Current User's Password.
postAccountPassword body → 200
GET
/account/ssh-keys
Acquia Gets a List of SSH Keys Associated with the Current User.
getAccountSshKeys 6 params → 200404
POST
/account/ssh-keys
Acquia Installs a New SSH Key for the Current User.
postAccountSshKeys body → 202400404409
DELETE
/account/ssh-keys/{sshKeyUuid}
Acquia Deletes an SSH Key.
deleteAccountSshKey 1 param → 202404
GET
/account/ssh-keys/{sshKeyUuid}
Acquia Get an SSH Key Associated with the Currently-logged in User.
getAccountSshKey 1 param → 200404
GET
/account/subscriptions/{subscriptionUuid}/is-admin
Acquia Returns Whether Your Account is an Administrator for a Subscription.
getAccountSubscriptionIsAdministrator 1 param → 200403404
GET
/account/subscriptions/{subscriptionUuid}/is-owner
Acquia Returns Whether Your Account is the Owner for a Subscription.
getAccountSubscriptionIsOwner 1 param → 200404
GET
/account/teams/{teamUuid}/has-permission
Acquia Returns Whether Your Account Has Access to a Specific Team Permission.
getAccountTeamHasPermission 2 params → 200403404
GET
/account/teams/{teamUuid}/is-admin
Acquia Returns Whether Your Account is an Administrator for a Team.
getAccountTeamIsAdministrator 1 param → 200403404
GET
/account/teams/{teamUuid}/is-owner
Acquia Returns Whether Your Account is the Owner for a Team.
getAccountTeamIsOwner 1 param → 200404
GET
/account/tokens
Acquia Returns a List of Metadata for API Access Tokens Tied to Your Account.
getAccountTokens → 200404
POST
/account/tokens
Acquia Creates an API Access Token Tied to Your Account.
postAccountTokens body → 201404
DELETE
/account/tokens/{tokenUuid}
Acquia Revokes an Access Token.
deleteAccountToken 2 params → 200404409
GET
/account/tokens/{tokenUuid}
Acquia Return Details About a Specific Token.
getAccountToken 1 param → 200404

Schemas 35

The contract defines 35 schemas that model the data the API accepts and returns. The most detailed are Acquia_Cloud_API_Documentation_user (20 properties), Acquia_Cloud_API_Documentation_ux-message (11 properties), Acquia_Cloud_API_Documentation_invite (11 properties), Acquia_Cloud_API_Documentation_user-profile (8 properties). Each schema is shown below with its type and property counts.

Acquia_Cloud_API_Documentation_has-permission
object
Determines if a user account has a specific permission.
2 properties 2 required
Acquia_Cloud_API_Documentation_token-request
object
Describes the request body for a token.
1 property 1 required
Acquia_Cloud_API_Documentation_user-profile
object
A user profile.
8 properties 8 required
Acquia_Cloud_API_Documentation_ux-message
object
11 properties 11 required
Acquia_Cloud_API_Documentation_ssh-key-request
object
Describes the request body for an SSH key.
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_validation-error
object
A validation error.
2 properties 2 required
Acquia_Cloud_API_Documentation_user
object
The response for a user object.
20 properties 16 required
Acquia_Cloud_API_Documentation_message
object
1 property 1 required
Acquia_Cloud_API_Documentation_ux-messages
object
3 properties 3 required
Acquia_Cloud_API_Documentation_ides
object
3 properties 3 required
Acquia_Cloud_API_Documentation_token
object
Details a token.
7 properties 7 required
Acquia_Cloud_API_Documentation_message-with-links
object
2 properties 2 required
Acquia_Cloud_API_Documentation_token-creation
object
Details about a created user access token.
5 properties 3 required
Acquia_Cloud_API_Documentation_ux-message-flags
object
An array of various flags associated with a message.
3 properties
Acquia_Cloud_API_Documentation_organization-stub
object
2 properties 2 required
Acquia_Cloud_API_Documentation_ide
object
5 properties 4 required
Acquia_Cloud_API_Documentation_file
string
A binary file response.
Acquia_Cloud_API_Documentation_user-stub
object
6 properties 6 required
Acquia_Cloud_API_Documentation_password
object
Describes the request body for a password.
1 property 1 required
Acquia_Cloud_API_Documentation_password-validation
object
The password validation response.
1 property
Acquia_Cloud_API_Documentation_invite
object
Details an invite.
11 properties 7 required
Acquia_Cloud_API_Documentation_user-flags
object
The various flags for the user.
3 properties
Acquia_Cloud_API_Documentation_team-stub
object
2 properties 2 required
Acquia_Cloud_API_Documentation_is-owner
object
Determines if a user account is an owner.
2 properties 2 required
Acquia_Cloud_API_Documentation_is-administrator
object
Determines if a user account is an administrator.
2 properties 2 required
Acquia_Cloud_API_Documentation_role-stub
object
2 properties 2 required
Acquia_Cloud_API_Documentation_ux-message-filters
object
Defines where a message should appear.
3 properties
Acquia_Cloud_API_Documentation_ssh-key
object
Details an SSH key.
6 properties 6 required
Acquia_Cloud_API_Documentation_error
object
2 properties 2 required
Acquia_Cloud_API_Documentation_ssh-keys
object
A collection of SSH keys.
3 properties 3 required
Acquia_Cloud_API_Documentation_account-invites
object
A collection of invites.
3 properties 3 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_tokens
object
A collection of tokens.
3 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

acquia-account-api-openapi.yml Raw ↑

Other APIs Acquia publishes across the network.

Acquia Cloud Site Factory API
Acquia Content Hub API
Acquia Agreements API
Acquia Application Performance Monitoring Services API
Acquia Applications API
Acquia Cloud IDE API
Acquia Codebases API
Acquia Current system health API
Acquia Distributions API
Acquia Email API
Acquia Environments API
Acquia Identity Providers API