[{"label":"Latest (v1.0)","version":"latest"}]
csp

Link Org To IDP

Description

Links 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

Request

URL

URL


post
https://{api_host}/csp/gateway/am/api/orgs/{orgId}/idp
Copy

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

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK returns OrgLinkedIdpResponse of type application/json
{
	"idpDetails": {
		"idpDisplayName": "VMware, Inc",
		"idpDomains": [
			"string"
		],
		"idpId": "string"
	},
	"mappedToIdp": false
}
idpDetails Optional

Basic Idp Registration Details


boolean
mappedToIdp Optional
Errors

Errors

401

The user is not authorized to use the API


403

The user is forbidden to use the API


404

Organization with this identifier is not found.


409

The request could not be processed due to a conflict


429

The user has sent too many requests


500

An unexpected error has occurred while processing the request

Code Samples

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

Vendor Extensions

This operation contains the following vendor extensions defined in the spec:
x-required-roles: org_owner
x-slo-tier: TIER2


Feedback

Was this page helpful?