Decodes additional information about the authorization status of a request from an
encoded message returned in response to an Amazon Web Services request.
For example, if a user is not authorized to perform an operation that he or she has
requested, the request returns a Client.UnauthorizedOperation response (an
HTTP 403 response). Some Amazon Web Services operations additionally return an encoded message that can
provide details about this authorization failure.
Only certain Amazon Web Services operations return an encoded authorization message. The
documentation for an individual operation indicates whether that operation returns an
encoded message in addition to returning an HTTP code.
The message is encoded because the details of the authorization status can contain
privileged information that the user who requested the operation should not see. To decode
an authorization status message, a user must be granted permissions through an IAM policy to
request the DecodeAuthorizationMessage
(sts:DecodeAuthorizationMessage) action.
The decoded message includes the following type of information:
The error returned if the message passed to DecodeAuthorizationMessage
was invalid. This can happen if the token contains invalid characters, such as
linebreaks.
example
To decode information about an authorization status of a request
Decodes additional information about the authorization status of a request from an encoded message returned in response to an Amazon Web Services request.
For example, if a user is not authorized to perform an operation that he or she has requested, the request returns a
Client.UnauthorizedOperationresponse (an HTTP 403 response). Some Amazon Web Services operations additionally return an encoded message that can provide details about this authorization failure.Only certain Amazon Web Services operations return an encoded authorization message. The documentation for an individual operation indicates whether that operation returns an encoded message in addition to returning an HTTP code.
The message is encoded because the details of the authorization status can contain privileged information that the user who requested the operation should not see. To decode an authorization status message, a user must be granted permissions through an IAM policy to request the
DecodeAuthorizationMessage(sts:DecodeAuthorizationMessage) action.The decoded message includes the following type of information:
Whether the request was denied due to an explicit deny or due to the absence of an explicit allow. For more information, see Determining Whether a Request is Allowed or Denied in the IAM User Guide.
The principal who made the request.
The requested action.
The requested resource.
The values of condition keys in the context of the user's request.
Use a bare-bones client and the command you need to make an API call.
import { STSClient, DecodeAuthorizationMessageCommand } from "@aws-sdk/client-sts"; // ES Modules import // const { STSClient, DecodeAuthorizationMessageCommand } = require("@aws-sdk/client-sts"); // CommonJS import const client = new STSClient(config); const command = new DecodeAuthorizationMessageCommand(input); const response = await client.send(command);DecodeAuthorizationMessageCommandInput for command's
inputshape.DecodeAuthorizationMessageCommandOutput for command's
responseshape.config for STSClient's
configshape.InvalidAuthorizationMessageException (client fault)
The error returned if the message passed to
DecodeAuthorizationMessagewas invalid. This can happen if the token contains invalid characters, such as linebreaks.To decode information about an authorization status of a request
// const input = { "EncodedMessage": "<encoded-message>" }; const command = new DecodeAuthorizationMessageCommand(input); const response = await client.send(command); /* response == { "DecodedMessage": "{\"allowed\": \"false\",\"explicitDeny\": \"false\",\"matchedStatements\": \"\",\"failures\": \"\",\"context\": {\"principal\": {\"id\": \"AIDACKCEVSQ6C2EXAMPLE\",\"name\": \"Bob\",\"arn\": \"arn:aws:iam::123456789012:user/Bob\"},\"action\": \"ec2:StopInstances\",\"resource\": \"arn:aws:ec2:us-east-1:123456789012:instance/i-dd01c9bd\",\"conditions\": [{\"item\": {\"key\": \"ec2:Tenancy\",\"values\": [\"default\"]},{\"item\": {\"key\": \"ec2:ResourceTag/elasticbeanstalk:environment-name\",\"values\": [\"Default-Environment\"]}},(Additional items ...)]}}" } *\/ // example id: to-decode-information-about-an-authorization-status-of-a-request-1480533854499