Acquia Identity Providers API
The Identity Providers API from Acquia — 4 operation(s) for identity providers.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/acquia-identity-providers-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Acquia Cloud API Documentation Identity Providers API
x-logo:
url: assets/cloud-platform.svg
backgroundColor: '#FFFFFF'
altText: Acquia Cloud
description: 'Acquia Cloud API
# Compatibility
## Stability
The 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.'
version: 2.0.0
contact:
name: Customer Experience Engineering (CXE)
url: https://www.acquia.com
tags:
- name: Identity Providers
x-displayName: Identity Providers
paths:
/identity-providers:
servers:
- url: https://cloud.acquia.com/api
description: Cloud API
get:
tags:
- Identity Providers
summary: Returns a list of identity providers for a user
description: 'Returns a list of identity providers you have access to.
Filterable fields:
* `label`
Sortable fields:
* `label`'
operationId: getIdentityProviders
x-cli-name: identity-providers:list
parameters:
- $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_identity-providers'
example:
total: 2
pagination:
total: 2
limit: 2
offset: 0
_links:
self:
href: https://cloud.acquia.com/api/identity-providers
parent:
href: https://cloud.acquia.com/api/
filter:
href: https://cloud.acquia.com/api/identity-providers{?filter}
templated: true
sort:
href: https://cloud.acquia.com/api/identity-providers{?sort}
templated: true
limit:
href: https://cloud.acquia.com/api/identity-providers{?limit}
templated: true
offset:
href: https://cloud.acquia.com/api/identity-providers{?offset}
templated: true
_embedded:
items:
- uuid: 5fa84b25-a269-44bd-a2ae-e76d08ac8245
label: Identity provider label
idp_entity_id: https://idp.example.com/saml
sp_entity_id: https://sp.example.com/saml
sso_url: https://example.com/sso
certificate: '-----BEGIN CERTIFICATE-----...-----END CERTIFICATE-----'
status: enabled
_links:
self:
href: https://cloud.acquia.com/api/identity-providers/5fa84b25-a269-44bd-a2ae-e76d08ac8245
parent:
href: https://cloud.acquia.com/api/identity-providers
acs:
href: https://accounts.acquia.com/api/auth/saml/acs/5fa84b25-a269-44bd-a2ae-e76d08ac8245
- uuid: 908914ec-2354-4fb1-9298-637247eccc3a
label: Identity provider label 2
idp_entity_id: https://idp2.example.com/saml
sp_entity_id: https://sp2.example.com/saml
sso_url: https://example.com/sso
certificate: '-----BEGIN CERTIFICATE-----...-----END CERTIFICATE-----'
status: enabled
_links:
self:
href: https://cloud.acquia.com/api/identity-providers/908914ec-2354-4fb1-9298-637247eccc3a
parent:
href: https://cloud.acquia.com/api/identity-providers
acs:
href: https://accounts.acquia.com/api/auth/saml/acs/908914ec-2354-4fb1-9298-637247eccc3a
/identity-providers/{identityProviderUuid}:
servers:
- url: https://cloud.acquia.com/api
description: Cloud API
get:
tags:
- Identity Providers
summary: Returns a specific identity provider by UUID
description: Returns a specific identity provider.
operationId: getIdentityProvider
x-cli-name: identity-providers:find
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_identity-provider-uuid'
security:
- Acquia_Cloud_API_Documentation_OAuth2: []
responses:
'200':
description: OK
content:
application/hal+json:
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_identity-provider'
example:
uuid: 1bc5dbb4-6d59-403b-afc7-777e520aaa40
label: Test identity provider
idp_entity_id: https://idp.example.com/saml
sp_entity_id: https://sp.example.com/saml
sso_url: https://example.com/sso
certificate: '-----BEGIN CERTIFICATE----- ... -----END CERTIFICATE-----'
status: enabled
_links:
self:
href: https://cloud.acquia.com/api/identity-providers/1bc5dbb4-6d59-403b-afc7-777e520aaa40
parent:
href: https://cloud.acquia.com/api/identity-providers
acs:
href: https://accounts.acquia.com/api/auth/saml/acs/1bc5dbb4-6d59-403b-afc7-777e520aaa40
organization:
href: https://cloud.acquia.com/api/organizations/a81c08c6-a02f-4b57-87e3-c3f395a2bb34
'404':
description: Not Found
content:
application/hal+json:
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
example:
error: not_found
message: The identity provider you are trying to access does not exist, or you do not have permission to access it.
put:
tags:
- Identity Providers
summary: Modifies an identity provider by its UUID
description: Modifies an identity provider.
operationId: putIdentityProvider
x-cli-name: identity-providers:update
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_identity-provider-uuid'
requestBody:
required: true
content:
application/hal+json:
schema:
type: object
properties:
label:
type: string
description: The new identity provider label.
entity_id:
type: string
description: The entity ID of the identity provider
sso_url:
type: string
format: uri
description: The URL of the SSO identity provider.
certificate:
type: string
description: The PEM-encoded X.509 certificate.
example:
label: New label
entity_id: entity-id
sso_url: https://idp.example.com
certificate: '-----BEGIN CERTIFICATE-----...-----END CERTIFICATE-----'
application/x-www-form-urlencoded:
schema:
type: object
properties:
label:
type: string
description: The new identity provider label.
entity_id:
type: string
description: The entity ID of the identity provider
sso_url:
type: string
format: uri
description: The URL of the SSO identity provider.
certificate:
type: string
description: The PEM-encoded certificate.
example:
label: New label
entity_id: entity-id
sso_url: https://idp.example.com
certificate: '-----BEGIN CERTIFICATE-----...-----END CERTIFICATE-----'
security:
- Acquia_Cloud_API_Documentation_OAuth2: []
responses:
'202':
description: Accepted
content:
application/hal+json:
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_message'
example:
message: Identity Provider has been updated.
_links:
self:
href: https://cloud.acquia.com/api/identity-providers/8030f025-47dc-4926-940b-0b04d98d1ea2
parent:
href: https://cloud.acquia.com/api/identity-providers
notification:
href: https://cloud.acquia.com/api/notifications/29dcc1e2-3cfc-447c-9fcb-d51c1c26b4da
'400':
description: Bad Request
content:
application/hal+json:
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_validation-error'
examples:
No Parameters:
value:
error: validation_failed
message:
general: No update executed, as no parameters were provided. Please update at least one property.
Invalid Certificate:
value:
error: validation_failed
message:
credentials: The certificate is invalid.
Inactive Certificate:
value:
error: validation_failed
message:
credentials: The certificate is not yet active.
Expired Certificate:
value:
error: validation_failed
message:
credentials: The certificate is expired.
Expiring Certificate:
value:
error: validation_failed
message:
credentials: The certificate is expiring. Certificates must be valid for at least 90 days.
'403':
description: Forbidden
content:
application/hal+json:
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
example:
error: forbidden
message: You do not have permission to edit the identity provider.
'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 identity provider you are trying to access does not exist, or you do not have permission to access it.
Does Not Exist:
value:
error: not_found
message: An identity provider with UUID idp1234-aaaa-1234-abcd-0123456789ab does not exist.
No Associated Organization:
value:
error: not_found
message: An organization with associated identity provider UUID idp1234-aaaa-1234-abcd-0123456789ab cannot be found.
'409':
description: Conflict
content:
application/hal+json:
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
examples:
Already Enabled and Active:
value:
error: conflict
message: Updates cannot be made to identity providers that are enabled and active.
Not Registered to Organization:
value:
error: conflict
message: The organization does not have an identity provider registered with the UUID idp1234-aaaa-1234-abcd-0123456789ab.
delete:
tags:
- Identity Providers
summary: Deletes a specific identity provider by its UUID
description: Deletes a specific identity provider.
operationId: deleteIdentityProvider
x-cli-name: identity-providers:delete
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_identity-provider-uuid'
security:
- Acquia_Cloud_API_Documentation_OAuth2: []
responses:
'202':
description: Accepted
content:
application/hal+json:
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_message-with-links'
example:
message: Identity provider has been deleted.
_links:
self:
href: https://cloud.acquia.com/api/identity-providers/da1c0a8e-ff69-45db-88fc-acd6d2affbb7
parent:
href: https://cloud.acquia.com/api/identity-providers
notification:
href: https://cloud.acquia.com/api/notifications/29dcc1e2-3cfc-447c-9fcb-d51c1c26b4da
'403':
description: Forbidden
content:
application/hal+json:
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
example:
error: forbidden
message: You do not have permission to delete the identity provider.
'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 identity provider you are trying to access does not exist, or you do not have permission to access it.
No Associated Organization:
value:
error: not_found
message: An organization with associated identity provider UUID da1c0a8e-ff69-45db-88fc-acd6d2affbb7 cannot be found.
/identity-providers/{identityProviderUuid}/actions/enable:
servers:
- url: https://cloud.acquia.com/api
description: Cloud API
post:
tags:
- Identity Providers
summary: Enables an identity provider by its UUID
description: Enables an identity provider.
operationId: postEnableIdentityProvider
x-cli-name: identity-providers:enable
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_identity-provider-uuid'
security:
- Acquia_Cloud_API_Documentation_OAuth2: []
responses:
'200':
description: OK
content:
application/hal+json:
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_message-with-links'
example:
message: Identity Provider has been enabled.
_links:
self:
href: https://cloud.acquia.com/api/identity-providers/e1851cef-aa3c-4153-bb81-1c25fcf7dc77
parent:
href: https://cloud.acquia.com/api/identity-providers
notification:
href: https://cloud.acquia.com/api/notifications/31660dfd-def7-49f0-b1f2-847fa267a021
'403':
description: Forbidden
content:
application/hal+json:
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
example:
error: conflict
message: You do not have permission to enable this identity provider.
'404':
description: Not Found
content:
application/hal+json:
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
example:
error: conflict
message: The identity provider you are trying to access does not exist, or you do not have permission to access it.
'409':
description: Conflict
content:
application/hal+json:
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
examples:
Already enabled:
value:
error: conflict
message: The identity provider is already enabled.
/identity-providers/{identityProviderUuid}/actions/disable:
servers:
- url: https://cloud.acquia.com/api
description: Cloud API
post:
tags:
- Identity Providers
summary: Disables an identity provider by its UUID
description: Disables an identity provider.
operationId: postDisableIdentityProvider
x-cli-name: identity-providers:disable
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_identity-provider-uuid'
security:
- Acquia_Cloud_API_Documentation_OAuth2: []
responses:
'200':
description: OK
content:
application/hal+json:
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_message-with-links'
example:
message: Identity Provider has been disabled.
_links:
self:
href: https://cloud.acquia.com/api/identity-providers/e1851cef-aa3c-4153-bb81-1c25fcf7dc77
parent:
href: https://cloud.acquia.com/api/identity-providers
notification:
href: https://cloud.acquia.com/api/notifications/31660dfd-def7-49f0-b1f2-847fa267a021
'403':
description: Forbidden
content:
application/hal+json:
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
example:
error: conflict
message: You do not have permission to disable this identity provider.
'404':
description: Not Found
content:
application/hal+json:
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
example:
error: conflict
message: The identity provider you are trying to access does not exist, or you do not have permission to access it.
'409':
description: Conflict
content:
application/hal+json:
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
examples:
Already disabled:
value:
error: conflict
message: The identity provider is already disabled.
components:
parameters:
Acquia_Cloud_API_Documentation_sort:
name: sort
in: query
description: 'A comma-delimited string with fields used for sorting. The order of the fields is significant. A leading - in the field indicates the field should be sorted in a descending order. Not all fields are sortable.
'
required: false
schema:
type: string
minimum: 1
example: field1,-field2
Acquia_Cloud_API_Documentation_offset:
name: offset
in: query
description: An integer to signify the offset to paginate from.
required: false
schema:
type: integer
example: 10
Acquia_Cloud_API_Documentation_limit:
name: limit
in: query
description: The maximum number of items to return.
required: false
schema:
type: integer
example: 10
Acquia_Cloud_API_Documentation_identity-provider-uuid:
name: identityProviderUuid
in: path
description: The entity's universally unique identifier.
required: true
schema:
type: string
example: da1c0a8e-ff69-45db-88fc-acd6d2affbb7
Acquia_Cloud_API_Documentation_filter:
name: filter
in: query
description: 'The filters query string parameter restricts the data returned from your request. Filtered queries restrict the rows that do (or do not) get included in the result by testing each row in the result against the filters. Not all fields are filterable.
There are eight filter operators that can be used and they must be URL encoded in order to be included. The operators are:
* Equals: `= (%3D)`
* Does not equal: `!= (!%3D)`
* Greater than: `> (%3E)`
* Less than: `< (%3C)`
* Greater than or equal to: `>= (%3E%3D)`
* Less than or equal to: `<= (%3C%3D)`
* Contains substring: `=@ (%3D@)`
* Does not contain substring: `!@ (!@)`
Filters can be combined using `OR` and `AND` boolean logic. The `OR` operator is defined using a comma (`,`) and the `AND` operator is defined using a semi-colon (`;`).
Some examples:
* `filter=field%3Dvalue` (`field` equals `''value''`)
* `filter=field%3D@*partialmatch` (`field` ends with `''partialmatch''`)
* `filter=field%3D@*partialmatch,field%3Dvalue` (`field` ends with `''partialmatch''` OR `field` equals `''value''`)
* `filter=field%3D@*partialmatch,field%3Dvalue;field2%3C5` (`field` ends with `''partialmatch''` OR `field` equals `''value''` AND `field2` > `5`)
'
required: false
schema:
type: string
minimum: 1
schemas:
Acquia_Cloud_API_Documentation_message:
type: object
required:
- message
properties:
message:
type: string
description: A simple message returned from the response.
Acquia_Cloud_API_Documentation_error:
type: object
required:
- error
- message
properties:
error:
type: string
description: The error summary.
message:
type: string
description: The long description for the returned error.
Acquia_Cloud_API_Documentation_message-with-links:
type: object
required:
- message
- _links
properties:
message:
type: string
description: The human-friendly confirmation of the creation of the resource.
_links:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_links'
Acquia_Cloud_API_Documentation_validation-error:
type: object
required:
- error
- message
description: A validation error.
properties:
error:
type: string
description: The error summary.
message:
type: object
description: The validation error message keyed by its field or group name.
additionalProperties:
type: string
Acquia_Cloud_API_Documentation_identity-providers:
type: object
required:
- total
- _links
- _embedded
properties:
total:
type: integer
description: The number of items returned in the collection.
_links:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_links'
_embedded:
type: object
description: A collection of identity providers matching the request parameters.
properties:
items:
type: array
items:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_identity-provider'
Acquia_Cloud_API_Documentation_identity-provider:
type: object
required:
- uuid
- label
- idp_entity_id
- sp_entity_id
- sso_url
- certificate
- status
- _links
properties:
uuid:
type: string
format: uuid
description: The unique identifier of the identity provider.
label:
type: string
description: The human-friendly label of the identity provider.
idp_entity_id:
type: string
description: The SAML entity ID of the identity provider.
sp_entity_id:
type: string
description: The SAML entity ID of the service provider.
sso_url:
type: string
format: uri
description: The URL of the SAML POST Binding / SP-initiated SSO.
certificate:
type: string
description: The PEM-encoded X.509 certificate used to sign assertions.
status:
type: string
description: The current state of the identity provider.
enum:
- enabled
- incomplete
- disabled
_links:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_links'
Acquia_Cloud_API_Documentation_links:
type: object
required:
- self
description: HAL links about the current resource.
properties:
self:
type: object
description: A link to this page.
required:
- href
properties:
href:
type: string
format: uri
description: The URI for this page.
securitySchemes:
Acquia_Cloud_API_Documentation_OAuth2:
type: oauth2
description: '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 token:
1. Sign in to the [Acquia Cloud](https://cloud.acquia.com/) interface using your email address and Acquia password.
2. Click your user avatar in the upper right corner, and then click **Account Settings**.
3. On the Profile page, click **API Tokens**.
4. Click **Create Token**.
5. In the pop-up that appears, give your token a label so that you can easily find it later. Then click **Create Token**.
6. Copy your API key and API secret. Click **OK**.
'
flows:
clientCredentials:
tokenUrl: https://accounts.acquia.com/api/token
scopes: {}
Codebase_Service_JWT:
type: apiKey
description: Value for the Authorization header parameter.
name: Authorization
in: header
MEO_Environment_Service_JWT:
type: apiKey
description: Value for the Authorization header parameter.
name: Authorization
in: header
Site_Service_JWT:
type: apiKey
description: Value for the Authorization header parameter.
name: Authorization
in: header