---
title: "Updates an Identity Provider."
method: PUT
path: "/identity-providers/{identityProviderId}"
tags: ["Identity Providers"]
---

# Updates an Identity Provider.

`PUT /identity-providers/{identityProviderId}`

## Request

- Base URL: `https://api.acquia.com/v3`
- URL: `https://api.acquia.com/v3/identity-providers/{identityProviderId}`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/acquia/apis/acquia-cloud-platform-api/docs/identity-providers/:identityProviderId/put.ts> (a function with typed inputs; its response is checked against the schema)

## Path parameters

- `identityProviderId` string, required

## Request body

- object
  - `label` string: The name of the Identity Provider.
  - `certificate` string: The X.509 certificate used for SAML authentication.
  - `sso_url` string, uri: The Single Sign-On URL for the Identity Provider.
  - `idp_entity_id` string, uri: The Identity Provider Entity ID.

## Response `202`

Identity Provider update initiated. The Identity Provider configuration changes are being applied. Poll the Identity Provider resource to verify the changes.

- object
  - `_links` object, required: HAL links for the resource
    - `self` FederatedAuthenticationAPIHalLink, required: HAL link object
      - `href` union, required: The target URI of the link (can be a URI or URI template)
        - string, uri
        - string, uri-template
      - `templated` boolean: Whether the link is a URI template
      - `type` string: Hint about the media type expected when dereferencing the target resource
      - `deprecation` string: A URL to a resource that provides deprecation information
      - `name` string: A secondary key for selecting links
      - `profile` string: A URI that hints about the profile of the target resource
      - `title` string: A human-readable identifier for the link
      - `hreflang` string: The language of the target resource
  - `_embedded` object: Embedded resources (optional)
  - `message` 'Identity Provider update has been accepted.', required: The message content

## Other responses

- `400`: Validation Error
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not Found
- `409`: Conflict
- `500`: Internal Server Error

---

[API](https://skmtc.dev/acquia/apis/acquia-cloud-platform-api.md) - [All operations](https://skmtc.dev/acquia/apis/acquia-cloud-platform-api/llms.txt) - [OpenAPI document](https://skmtc.dev/acquia/apis/acquia-cloud-platform-api/revisions/508f8f94456d?raw)
