GetPortalServiceProviderMetadata

Gets the service provider metadata.

Request Syntax


GET /portalIdp/portalArn+ HTTP/1.1

The request uses the following URI parameters.

The ARN of the web portal.

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9]{1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+

Required: Yes

The request does not have a request body.


HTTP/1.1 200
Content-type: application/json

{
   "portalArn": "string",
   "serviceProviderSamlMetadata": "string"
}

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

The ARN of the web portal.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9]{1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+

The service provider SAML metadata.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 204800.

Pattern: .+

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

Access is denied.

HTTP Status Code: 403

InternalServerException

There is an internal server error.

retryAfterSeconds: Advice to clients on when the call can be safely retried.

HTTP Status Code: 500

ResourceNotFoundException

The resource cannot be found.

HTTP Status Code: 404

ThrottlingException

There is a throttling error.

quotaCode: The originating quota.
retryAfterSeconds: Advice to clients on when the call can be safely retried.
serviceCode: The originating service.

HTTP Status Code: 429

ValidationException

There is a validation error.

HTTP Status Code: 400