DescribeTrustedTokenIssuer
Retrieves details about a trusted token issuer configuration stored in an instance of IAM Identity Center. Details include the name of the trusted token issuer, the issuer URL, and the path of the source attribute and the destination attribute for a trusted token issuer configuration.
Request Syntax
{
"TrustedTokenIssuerArn": "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.
- TrustedTokenIssuerArn
-
Specifies the ARN of the trusted token issuer configuration that you want details about.
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::\d{12}:trustedTokenIssuer/(sso)?ins-[a-zA-Z0-9-.]{16}/tti-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}
Required: Yes
Response Syntax
{
"Name": "string",
"TrustedTokenIssuerArn": "string",
"TrustedTokenIssuerConfiguration": { ... },
"TrustedTokenIssuerType": "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.
- Name
-
The name of the trusted token issuer configuration.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
[\w+=,.@-]+
- TrustedTokenIssuerArn
-
The ARN of the trusted token issuer configuration.
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::\d{12}:trustedTokenIssuer/(sso)?ins-[a-zA-Z0-9-.]{16}/tti-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}
- TrustedTokenIssuerConfiguration
-
A structure the describes the settings that apply of this trusted token issuer.
Type: TrustedTokenIssuerConfiguration object
Note: This object is a Union. Only one member of this object can be specified or returned.
- TrustedTokenIssuerType
-
The type of the trusted token issuer.
Type: String
Valid Values:
OIDC_JWT
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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: