Update an organization identity connection
PATCH
/v1/identity-connections/{connectionId}How to call this endpoint
Every ACP API request uses bearer authentication. The examples here show the actual request path, auth header, and body shape that the platform expects.
Path, query, and header parameters
These parameters control which ACP object the endpoint acts on and how the request is processed.
Path parameters
| Name | Location | Type | Required | Description |
|---|---|---|---|---|
| connectionId | path | string | Yes | Organization identity connection ID |
Query parameters
None.
Header parameters
| Name | Location | Type | Required | Description |
|---|---|---|---|---|
| X-Computer-Agents-Organization | header | string | No | Active organization context. If omitted, the authenticated user's personal organization is used. |
Body schema
Content type: application/json · Required
| Field | Type | Required | Description |
|---|---|---|---|
| displayName | string | No | — |
| issuer | string | No | — |
| tenantId | string | No | — |
| clientId | string | No | — |
| discoveryUrl | string | No | — |
| status | active | disabled | No | Current lifecycle status. |
| defaultMemberRole | viewer | member | developer | No | — |
| claimMappings | object | No | — |
| claimMappings.subject | string | Yes | — |
| claimMappings.email | string | Yes | — |
| claimMappings.displayName | string | Yes | — |
| claimMappings.groups | string | Yes | — |
| metadata | object | No | Free-form metadata object. |
What the API returns
Each response code below includes the documented payload shape for the ACP API.
200Updated identity connectionapplication/json
| Field | Type | Required | Description |
|---|---|---|---|
| data | object | Yes | — |
| data.id | string | Yes | Unique identifier. |
| data.organizationId | string | Yes | — |
| data.provider | entra | oidc | Yes | — |
| data.displayName | string | Yes | — |
| data.issuer | string | Yes | — |
| data.tenantId | string | No | — |
| data.clientId | string | Yes | — |
| data.discoveryUrl | string | Yes | — |
| data.status | active | disabled | Yes | Current lifecycle status. |
| data.scimTokenPrefix | string | No | — |
| data.scimTokenCreatedAt | string | No | — |
| data.defaultMemberRole | viewer | member | developer | Yes | — |
| data.claimMappings | object | Yes | — |
| data.claimMappings.subject | string | Yes | — |
| data.claimMappings.email | string | Yes | — |
| data.claimMappings.displayName | string | Yes | — |
| data.claimMappings.groups | string | Yes | — |
| data.metadata | object | No | Free-form metadata object. |
| data.createdByUserId | string | No | — |
| data.createdAt | string | Yes | ISO 8601 timestamp. |
| data.updatedAt | string | Yes | ISO 8601 timestamp. |
Update an organization identity connection
Loading...
Response 200
Loading...