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 Identity Providers API

The Identity Providers API from Acquia — 4 operation(s) for identity providers.

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

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

This API exposes 6 operations across 4 paths, and defines 7 schemas. It is described by OpenAPI 3.0.0, at version 2.0.0.

6 operations 4 paths 7 schemas 1 DELETE2 GET2 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
Resource Areas
1

Authentication & Security 4

Acquia Identity Providers 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 6

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

Identity Providers 6
GET
/identity-providers
Acquia Returns a List of Identity Providers for a User.
getIdentityProviders 4 params → 200
DELETE
/identity-providers/{identityProviderUuid}
Acquia Deletes a Specific Identity Provider by its UUID.
deleteIdentityProvider 1 param → 202403404
GET
/identity-providers/{identityProviderUuid}
Acquia Returns a Specific Identity Provider by UUID.
getIdentityProvider 1 param → 200404
PUT
/identity-providers/{identityProviderUuid}
Acquia Modifies an Identity Provider by its UUID.
putIdentityProvider 1 param body → 202400403404409
POST
/identity-providers/{identityProviderUuid}/actions/disable
Acquia Disables an Identity Provider by its UUID.
postDisableIdentityProvider 1 param → 200403404409
POST
/identity-providers/{identityProviderUuid}/actions/enable
Acquia Enables an Identity Provider by its UUID.
postEnableIdentityProvider 1 param → 200403404409

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are Acquia_Cloud_API_Documentation_identity-provider (8 properties), Acquia_Cloud_API_Documentation_identity-providers (3 properties), Acquia_Cloud_API_Documentation_message-with-links (2 properties), Acquia_Cloud_API_Documentation_error (2 properties). Each schema is shown below with its type and property counts.

Acquia_Cloud_API_Documentation_identity-provider
object
8 properties 8 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_error
object
2 properties 2 required
Acquia_Cloud_API_Documentation_identity-providers
object
3 properties 3 required
Acquia_Cloud_API_Documentation_links
object
HAL links about the current resource.
1 property 1 required
Acquia_Cloud_API_Documentation_message-with-links
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

acquia-identity-providers-api-openapi.yml Raw ↑

Other APIs Acquia publishes across the network.

Acquia Cloud Site Factory API
Acquia Content Hub API
Acquia Account 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