All Products
Search
Document Center

WUYING Workspace:SetIdpMetadata

Last Updated:Apr 03, 2024

Uploads the metadata of a Security Assertion Markup Language (SAML) 2.0-based identity provider (IdP).

Operation description

You can call this operation only for workspaces of the Active Directory (AD) and convenience account types.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID.

cn-hangzhou
DirectoryIdstringNo

The workspace ID. This parameter is the same as OfficeSiteId. We recommend that you use OfficeSiteId to replace DirectoryId. You can specify only DirectoryId or OfficeSiteId.

cn-hangzhou+dir-400695****
OfficeSiteIdstringNo

The workspace ID.

cn-hangzhou+dir-400695****
IdpMetadatastringYes

The metadata of the IdP.

<EntityDescriptor ID********Descriptor>

Response parameters

ParameterTypeDescriptionExample
object

The information that is returned.

IdpEntityIdstring

The entity ID obtained after the IdP metadata file is parsed.

http://test****.cn/adfs/services/trust
RequestIdstring

The request ID.

1CBAFFAB-B697-4049-A9B1-67E1FC5F****

Examples

Sample success responses

JSONformat

{
  "IdpEntityId": "http://test****.cn/adfs/services/trust",
  "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****"
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history