Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

DescribeApplicationProvider

Retrieves details about a provider that can be used to connect an Amazon managed application or customer managed application to IAM Identity Center.

Request Syntax


{
   "ApplicationProviderArn": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

ApplicationProviderArn

Specifies the ARN of the application provider for which you want details.

Type: String

Length Constraints: Minimum length of 10. Maximum length of 1224.

Pattern: arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso::aws:applicationProvider/[a-zA-Z0-9-/]+

Required: Yes

Response Syntax


{
   "ApplicationProviderArn": "string",
   "DisplayData": { 
      "Description": "string",
      "DisplayName": "string",
      "IconUrl": "string"
   },
   "FederationProtocol": "string",
   "ResourceServerConfig": { 
      "Scopes": { 
         "string" : { 
            "DetailedTitle": "string",
            "LongDescription": "string"
         }
      }
   }
}

Response Elements

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

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

ApplicationProviderArn

The ARN of the application provider.

Type: String

Length Constraints: Minimum length of 10. Maximum length of 1224.

Pattern: arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso::aws:applicationProvider/[a-zA-Z0-9-/]+

DisplayData

A structure with details about the display data for the application provider.

Type: DisplayData object

FederationProtocol

The protocol used to federate to the application provider.

Type: String

Valid Values: SAML | OAUTH

ResourceServerConfig

A structure with details about the receiving application.

Type: ResourceServerConfig object

Errors

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

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 400

InternalServerException

The request processing has failed because of an unknown error, exception, or failure with an internal server.

HTTP Status Code: 500

ResourceNotFoundException

Indicates that a requested resource is not found.

HTTP Status Code: 400

ThrottlingException

Indicates that the principal has crossed the throttling limits of the API operations.

HTTP Status Code: 400

ValidationException

The request failed because it contains a syntax error.

HTTP Status Code: 400