[{"label":"Latest (v1.0)","version":"latest"}]
csp
Link Org To IDP
DescriptionLinks the organization to the IdP Registration of the given domain.
Validation: Caller must be organization owner and their IdP should be linked to domain in request.
Access Policy
| Role | User Accounts | Service Accounts (Client Credentials Applications) |
|---|---|---|
| Organization Owner | ✔️ | ❌ |
Request
URLURL
https://{api_host}/csp/gateway/am/api/orgs/{orgId}/idp
Path Parameters
Path Parameters
string
orgId
Required
Unique identifier (GUID) of the organization.
Parameter Serialization Style:
simple Explode:false
Request Body
Request Body
OrgLinkIdpRequest
of mimetype application/json
Required
{
"idpId": "string"
}
string
idpId
Optional
IdpId to be linked
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK
Returns
OrgLinkedIdpResponse
of type application/json
{
"idpDetails": {
"idpDisplayName": "VMware, Inc",
"idpDomains": [
"string"
],
"idpId": "string"
},
"mappedToIdp": false
}
boolean
mappedToIdp
Optional
If organization is mapped to identity provider
Errors
CspErrorResponse
401
The user is not authorized to use the API
CspErrorResponse
403
The user is forbidden to use the API
CspErrorResponse
404
Organization with this identifier is not found.
CspErrorResponse
409
The request could not be processed due to a conflict
CspErrorResponse
429
The user has sent too many requests
CspErrorResponse
500
An unexpected error has occurred while processing the request
Code Samples
cURL Command
curl -X POST -H "Content-Type: application/json" -d '{"idpId":"string"}' https://{api_host}/csp/gateway/am/api/orgs/{orgId}/idp
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-required-roles: org_owner
x-slo-tier: TIER2
[{"label":"Latest (v1.0)","version":"latest"}]
csp
On This Page
Organization Operations
post
post
delete
