Navigation Guide
You are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.

IsAuthorizedCommand

Makes an authorization decision about a service request described in the parameters. The information in the parameters can also define additional context that Verified Permissions can include in the evaluation. The request is evaluated against all matching policies in the specified policy store. The result of the decision is either Allow or Deny, along with a list of the policies that resulted in the decision.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { VerifiedPermissionsClient, IsAuthorizedCommand } from "@aws-sdk/client-verifiedpermissions"; // ES Modules import
// const { VerifiedPermissionsClient, IsAuthorizedCommand } = require("@aws-sdk/client-verifiedpermissions"); // CommonJS import
const client = new VerifiedPermissionsClient(config);
const input = { // IsAuthorizedInput
  policyStoreId: "STRING_VALUE", // required
  principal: { // EntityIdentifier
    entityType: "STRING_VALUE", // required
    entityId: "STRING_VALUE", // required
  },
  action: { // ActionIdentifier
    actionType: "STRING_VALUE", // required
    actionId: "STRING_VALUE", // required
  },
  resource: {
    entityType: "STRING_VALUE", // required
    entityId: "STRING_VALUE", // required
  },
  context: { // ContextDefinition Union: only one key present
    contextMap: { // ContextMap
      "<keys>": { // AttributeValue Union: only one key present
        boolean: true || false,
        entityIdentifier: {
          entityType: "STRING_VALUE", // required
          entityId: "STRING_VALUE", // required
        },
        long: Number("long"),
        string: "STRING_VALUE",
        set: [ // SetAttribute
          {//  Union: only one key present
            boolean: true || false,
            entityIdentifier: "<EntityIdentifier>",
            long: Number("long"),
            string: "STRING_VALUE",
            set: [
              "<AttributeValue>",
            ],
            record: { // RecordAttribute
              "<keys>": "<AttributeValue>",
            },
            ipaddr: "STRING_VALUE",
            decimal: "STRING_VALUE",
          },
        ],
        record: {
          "<keys>": "<AttributeValue>",
        },
        ipaddr: "STRING_VALUE",
        decimal: "STRING_VALUE",
      },
    },
    cedarJson: "STRING_VALUE",
  },
  entities: { // EntitiesDefinition Union: only one key present
    entityList: [ // EntityList
      { // EntityItem
        identifier: "<EntityIdentifier>", // required
        attributes: { // EntityAttributes
          "<keys>": "<AttributeValue>",
        },
        parents: [ // ParentList
          "<EntityIdentifier>",
        ],
      },
    ],
    cedarJson: "STRING_VALUE",
  },
};
const command = new IsAuthorizedCommand(input);
const response = await client.send(command);
// { // IsAuthorizedOutput
//   decision: "ALLOW" || "DENY", // required
//   determiningPolicies: [ // DeterminingPolicyList // required
//     { // DeterminingPolicyItem
//       policyId: "STRING_VALUE", // required
//     },
//   ],
//   errors: [ // EvaluationErrorList // required
//     { // EvaluationErrorItem
//       errorDescription: "STRING_VALUE", // required
//     },
//   ],
// };

Example Usage

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
// The following example requests an authorization decision for a principal of type User named Alice, who wants 
    to perform the updatePhoto operation, on a resource of type Photo named VacationPhoto94.jpg.
//
// The response shows that the request was allowed by one policy.
const input = {
  "action": {
    "actionId": "view",
    "actionType": "Action"
  },
  "policyStoreId": "C7v5xMplfFH3i3e4Jrzb1a",
  "principal": {
    "entityId": "alice",
    "entityType": "User"
  },
  "resource": {
    "entityId": "VacationPhoto94.jpg",
    "entityType": "Photo"
  }
};
const command = new IsAuthorizedCommand(input);
const response = await client.send(command);
/* response ==
{
  "errors": [],
  "decision": "ALLOW",
  "determiningPolicies": [
    {
      "policyId": "9wYxMpljbbZQb5fcZHyJhY"
    }
  ]
}
*\/
// example id: example-1
 
 
הההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההה
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

JavaScriptLn 1, Col 1

Errors: 0 Warnings: 0