Link Org To Idp Using POST

Link Org To Idp Using POST

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
URI
POST
https://{api_host}/csp/gateway/am/api/orgs/{orgId}/idp
COPY
Path Parameters
string
orgId
Required

Unique identifier (GUID) of the organization.

Request Body
OrgLinkIdpRequest of type(s) application/json
Required 
"OrgLinkIdpRequest Object"
string
idpId
Optional

IdpId to be linked

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns OrgLinkedIdpResponse of type(s) application/json 
{
    "idpDetails": {
        "idpId": "string",
        "idpDisplayName": "VMware, Inc",
        "idpDomains": [
            "string"
        ]
    },
    "mappedToIdp": false
}
object
idpDetails
Optional

Basic Idp Registration Details

boolean
mappedToIdp
Optional

If organization is mapped to identity provider


401

The user is not authorized to use the API

Returns CspErrorResponse of type(s) application/json 
"CspErrorResponse Object"
string
cspErrorCode
Optional

cspErrorCode

string
message
Optional

message

string
errorCode
Optional

errorCode

string
requestId
Optional

requestId

integer As int32 As int32
moduleCode
Optional

moduleCode

integer As int32 As int32
statusCode
Optional

statusCode


403

The user is forbidden to use the API

Returns CspErrorResponse of type(s) application/json 
"CspErrorResponse Object"
string
cspErrorCode
Optional

cspErrorCode

string
message
Optional

message

string
errorCode
Optional

errorCode

string
requestId
Optional

requestId

integer As int32 As int32
moduleCode
Optional

moduleCode

integer As int32 As int32
statusCode
Optional

statusCode


404

Organization with this identifier is not found.

Returns CspErrorResponse of type(s) application/json 
"CspErrorResponse Object"
string
cspErrorCode
Optional

cspErrorCode

string
message
Optional

message

string
errorCode
Optional

errorCode

string
requestId
Optional

requestId

integer As int32 As int32
moduleCode
Optional

moduleCode

integer As int32 As int32
statusCode
Optional

statusCode


409

The request could not be processed due to a conflict

Returns CspErrorResponse of type(s) application/json 
"CspErrorResponse Object"
string
cspErrorCode
Optional

cspErrorCode

string
message
Optional

message

string
errorCode
Optional

errorCode

string
requestId
Optional

requestId

integer As int32 As int32
moduleCode
Optional

moduleCode

integer As int32 As int32
statusCode
Optional

statusCode


429

The user has sent too many requests

Returns CspErrorResponse of type(s) application/json 
"CspErrorResponse Object"
string
cspErrorCode
Optional

cspErrorCode

string
message
Optional

message

string
errorCode
Optional

errorCode

string
requestId
Optional

requestId

integer As int32 As int32
moduleCode
Optional

moduleCode

integer As int32 As int32
statusCode
Optional

statusCode


500

An unexpected error has occurred while processing the request

Returns CspErrorResponse of type(s) application/json 
"CspErrorResponse Object"
string
cspErrorCode
Optional

cspErrorCode

string
message
Optional

message

string
errorCode
Optional

errorCode

string
requestId
Optional

requestId

integer As int32 As int32
moduleCode
Optional

moduleCode

integer As int32 As int32
statusCode
Optional

statusCode


Code Samples
COPY 
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '[{}]' https://{api_host}/csp/gateway/am/api/orgs/{orgId}/idp
On This Page
Organization Operations
GET
Get Sub Organizations By Organization Id Using GET
POST
Activate Organization Refresh Tokens Using POST
Deprecated
GET
Get Organization Roles By Organization Id Using GET
POST
Search Organization Users By Organization Id And Roles Search Term Using POST
GET
Get Users In Organization By Organization Id And User Search Term Using GET
Deprecated
DELETE
Revoke User Invitation By Organization Id And User Invitation Id Using DELETE
GET
Get User Invitation By Organization Id And User Invitation Id Using GET
POST
Deactivate Organization Refresh Tokens With Api Token Path Using POST
POST
Assign Roles To Clients On Organization Using POST
DELETE
Remove Clients From Organization By Organization Id Using DELETE
GET
Get Organization Clients By Organization Id Using GET
POST
Deactivate Organization Refresh Tokens Using POST
Deprecated
PATCH
Update Organization By Organization Id Using PATCH
GET
Get Organization By Id Using GET
DELETE
Remove Users From Organization By Organization Id Using DELETE
GET
Get Organization Users By Organization Id Using GET
POST
Activate Organization Refresh Tokens With Api Token Path Using POST
POST
Invite Users Using POST
GET
Get Organization Invitations By Organization Id Using GET
POST
Link Org To Idp Using POST
DELETE
Delete Organization Idp Registration Using DELETE
GET
Get Org Linked Idp Details Using GET
GET
Get Groups In Organizations By Organization Id And Group Search Term Using GET