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 Teams and Permissions API

The Teams and Permissions API from Acquia — 10 operation(s) for teams and permissions.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

This API exposes 17 operations across 10 paths, and defines 25 schemas. It is described by OpenAPI 3.0.0, at version 2.0.0.

17 operations 10 paths 25 schemas 4 DELETE7 GET3 POST3 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 Teams and Permissions 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 17

Across 10 paths, the API surfaces 17 operations — 4 DELETE, 7 GET, 3 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

Teams and Permissions 17
GET
/permissions
Return a list of permissions.
getPermissions → 200
GET
/roles/{roleUuid}
Return details about a specific role.
getRole 1 param → 200404
DELETE
/roles/{roleUuid}
Deletes a specific role by its UUID.
deleteRole 1 param → 200404
PUT
/roles/{roleUuid}
Updates a role.
putRoleByUuid 1 param body → 200404
GET
/teams
Return teams the current user has access to.
getTeams 5 params → 200403
GET
/teams/{teamUuid}
Return details about a specific team.
getTeam 1 param → 200404
PUT
/teams/{teamUuid}
Change the name of a team.
putTeamsName 1 param body → 200404
DELETE
/teams/{teamUuid}
Deletes a specific team by its UUID.
deleteTeam 1 param → 200404
POST
/teams/{teamUuid}/actions/leave
Removes the current user from a team.
postLeaveTeam 1 param → 200404
GET
/teams/{teamUuid}/applications
Returns a list of applications this team has access to.
getTeamApplications 5 params → 200404
POST
/teams/{teamUuid}/applications
Adds an application to this team.
postTeamAddApplication 1 param body → 200403404409
DELETE
/teams/{teamUuid}/applications/{applicationUuid}
Removes the application from this team.
deleteTeamsRemoveApplication 2 params → 200403404
GET
/teams/{teamUuid}/invites
Returns a list of invitations to this team.
getTeamInvites 6 params → 200403404
POST
/teams/{teamUuid}/invites
Invites a user to join a team.
postTeamsInviteUser 1 param body → 200201400403404409
GET
/teams/{teamUuid}/members
Returns a list of team members.
getTeamMembers 5 params → 200404
PUT
/teams/{teamUuid}/members/{userUuid}
Grant team roles to a member.
putTeamsMember 2 params body → 200403404
DELETE
/teams/{teamUuid}/members/{userUuid}
Remove a user from a team.
deleteTeamsRemoveMember 2 params → 200403404

Schemas 25

The contract defines 25 schemas that model the data the API accepts and returns. The most detailed are Acquia_Cloud_API_Documentation_invite (11 properties), Acquia_Cloud_API_Documentation_application-no-embedded (10 properties), Acquia_Cloud_API_Documentation_role (7 properties), Acquia_Cloud_API_Documentation_team-user-profile (7 properties). Each schema is shown below with its type and property counts.

Acquia_Cloud_API_Documentation_permission
object
5 properties 5 required
Acquia_Cloud_API_Documentation_permission-flags
object
An array of various flags regarding the status of the permission.
1 property
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_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_team-applications
object
A collection of applications associated with a team.
3 properties 3 required
Acquia_Cloud_API_Documentation_team-user-profile
object
A user profile for a team member.
7 properties 7 required
Acquia_Cloud_API_Documentation_organization-stub
object
2 properties 2 required
Acquia_Cloud_API_Documentation_post-invite
object
2 properties 2 required
Acquia_Cloud_API_Documentation_user-stub
object
6 properties 6 required
Acquia_Cloud_API_Documentation_permissions
object
A collection of all permissions that may be granted.
3 properties
Acquia_Cloud_API_Documentation_invite
object
Details an invite.
11 properties 7 required
Acquia_Cloud_API_Documentation_team-stub
object
2 properties 2 required
Acquia_Cloud_API_Documentation_application-flags
object
An array of various flags that indicate functionality associated with applications.
1 property
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_team-members
object
A collection of team members.
3 properties 3 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_team-invites
object
A collection of invites.
3 properties 3 required
Acquia_Cloud_API_Documentation_links
object
HAL links about the current resource.
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

acquia-teams-and-permissions-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
#Teams and Permissions
← Back to A APIs
API Details
ID
acquia:acquia-teams-and-permissions-api
Docs
https://cloudapi-docs.acquia.com/
Provider
Acquia
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network