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

Get Org Linked IDP Details

Description

Gets IDP Details linked to the organization
Validation: Only Organization Owner with same IdP can retrieve the details.

Access Policy

Role User Accounts Service Accounts (Client Credentials Applications)
Organization Owner ✔️

Request

Request

URL

URL


get
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

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.


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 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?