Create an organization identity connection

POST/v1/identity-connections

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
None.
Query parameters
None.
Header parameters
NameLocationTypeRequiredDescription
X-Computer-Agents-OrganizationheaderstringNoActive organization context. If omitted, the authenticated user's personal organization is used.

Body schema

Content type: application/json · Required

FieldTypeRequiredDescription
providerentra | oidcYes
displayNamestringYes
issuerstringNo
tenantIdstringNo
clientIdstringYes
discoveryUrlstringNo
defaultMemberRoleviewer | member | developerNo
claimMappingsobjectNo
claimMappings.subjectstringYes
claimMappings.emailstringYes
claimMappings.displayNamestringYes
claimMappings.groupsstringYes
metadataobjectNoFree-form metadata object.

What the API returns

Each response code below includes the documented payload shape for the ACP API.

201Identity connection createdapplication/json
FieldTypeRequiredDescription
dataobjectYes
data.idstringYesUnique identifier.
data.organizationIdstringYes
data.providerentra | oidcYes
data.displayNamestringYes
data.issuerstringYes
data.tenantIdstringNo
data.clientIdstringYes
data.discoveryUrlstringYes
data.statusactive | disabledYesCurrent lifecycle status.
data.scimTokenPrefixstringNo
data.scimTokenCreatedAtstringNo
data.defaultMemberRoleviewer | member | developerYes
data.claimMappingsobjectYes
data.claimMappings.subjectstringYes
data.claimMappings.emailstringYes
data.claimMappings.displayNamestringYes
data.claimMappings.groupsstringYes
data.metadataobjectNoFree-form metadata object.
data.createdByUserIdstringNo
data.createdAtstringYesISO 8601 timestamp.
data.updatedAtstringYesISO 8601 timestamp.
Create an organization identity connection
Loading...
Response 201
Loading...
See the ACP quickstart and SDK flow