Class: AWS.VerifiedPermissions

var params = {
  policyStoreId: 'STRING_VALUE', /* required */
  requests: [ /* required */
    {
      action: {
        actionId: 'STRING_VALUE', /* required */
        actionType: 'STRING_VALUE' /* required */
      },
      context: {
        contextMap: {
          '<String>': { /* AttributeValue */
            boolean: true || false,
            entityIdentifier: {
              entityId: 'STRING_VALUE', /* required */
              entityType: 'STRING_VALUE' /* required */
            },
            long: 'NUMBER_VALUE',
            record: {
              '<String>': /* recursive AttributeValue */,
              /* '<String>': ... */
            },
            set: [
              /* recursive AttributeValue */,
              /* more items */
            ],
            string: 'STRING_VALUE'
          },
          /* '<String>': ... */
        }
      },
      resource: {
        entityId: 'STRING_VALUE', /* required */
        entityType: 'STRING_VALUE' /* required */
      }
    },
    /* more items */
  ],
  accessToken: 'STRING_VALUE',
  entities: {
    entityList: [
      {
        identifier: { /* required */
          entityId: 'STRING_VALUE', /* required */
          entityType: 'STRING_VALUE' /* required */
        },
        attributes: {
          '<String>': { /* AttributeValue */
            boolean: true || false,
            entityIdentifier: {
              entityId: 'STRING_VALUE', /* required */
              entityType: 'STRING_VALUE' /* required */
            },
            long: 'NUMBER_VALUE',
            record: {
              '<String>': /* recursive AttributeValue */,
              /* '<String>': ... */
            },
            set: [
              /* recursive AttributeValue */,
              /* more items */
            ],
            string: 'STRING_VALUE'
          },
          /* '<String>': ... */
        },
        parents: [
          {
            entityId: 'STRING_VALUE', /* required */
            entityType: 'STRING_VALUE' /* required */
          },
          /* more items */
        ]
      },
      /* more items */
    ]
  },
  identityToken: 'STRING_VALUE'
};
verifiedpermissions.batchIsAuthorizedWithToken(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • policyStoreId — (String)

    Specifies the ID of the policy store. Policies in this policy store will be used to make an authorization decision for the input.

  • identityToken — (String)

    Specifies an identity (ID) token for the principal that you want to authorize in each request. This token is provided to you by the identity provider (IdP) associated with the specified identity source. You must specify either an accessToken, an identityToken, or both.

    Must be an ID token. Verified Permissions returns an error if the token_use claim in the submitted token isn't id.

  • accessToken — (String)

    Specifies an access token for the principal that you want to authorize in each request. This token is provided to you by the identity provider (IdP) associated with the specified identity source. You must specify either an accessToken, an identityToken, or both.

    Must be an access token. Verified Permissions returns an error if the token_use claim in the submitted token isn't access.

  • entities — (map)

    Specifies the list of resources and their associated attributes that Verified Permissions can examine when evaluating the policies.

    You can't include principals in this parameter, only resource and action entities. This parameter can't include any entities of a type that matches the user or group entity types that you defined in your identity source.

    • The BatchIsAuthorizedWithToken operation takes principal attributes from only the identityToken or accessToken passed to the operation.

    • For action entities, you can include only their Identifier and EntityType.

    • entityList — (Array<map>)

      An array of entities that are needed to successfully evaluate an authorization request. Each entity in this array must include an identifier for the entity, the attributes of the entity, and a list of any parent entities.

      • identifier — required — (map)

        The identifier of the entity.

        • entityType — required — (String)

          The type of an entity.

          Example: "entityType":"typeName"

        • entityId — required — (String)

          The identifier of an entity.

          "entityId":"identifier"

      • attributes — (map<map>)

        A list of attributes for the entity.

        • boolean — (Boolean)

          An attribute value of Boolean type.

          Example: {"boolean": true}

        • entityIdentifier — (map)

          An attribute value of type EntityIdentifier.

          Example: "entityIdentifier": { "entityId": "<id>", "entityType": "<entity type>"}

          • entityType — required — (String)

            The type of an entity.

            Example: "entityType":"typeName"

          • entityId — required — (String)

            The identifier of an entity.

            "entityId":"identifier"

        • long — (Integer)

          An attribute value of Long type.

          Example: {"long": 0}

        • string — (String)

          An attribute value of String type.

          Example: {"string": "abc"}

        • set — (Array<map>)

          An attribute value of Set type.

          Example: {"set": [ {} ] }

        • record — (map<map>)

          An attribute value of Record type.

          Example: {"record": { "keyName": {} } }

      • parents — (Array<map>)

        The parent entities in the hierarchy that contains the entity. A principal or resource entity can be defined with at most 99 transitive parents per authorization request.

        A transitive parent is an entity in the hierarchy of entities including all direct parents, and parents of parents. For example, a user can be a member of 91 groups if one of those groups is a member of eight groups, for a total of 100: one entity, 91 entity parents, and eight parents of parents.

        • entityType — required — (String)

          The type of an entity.

          Example: "entityType":"typeName"

        • entityId — required — (String)

          The identifier of an entity.

          "entityId":"identifier"

  • requests — (Array<map>)

    An array of up to 30 requests that you want Verified Permissions to evaluate.

    • action — (map)

      Specifies the requested action to be authorized. For example, PhotoFlash::ReadPhoto.

      • actionType — required — (String)

        The type of an action.

      • actionId — required — (String)

        The ID of an action.

    • resource — (map)

      Specifies the resource that you want an authorization decision for. For example, PhotoFlash::Photo.

      • entityType — required — (String)

        The type of an entity.

        Example: "entityType":"typeName"

      • entityId — required — (String)

        The identifier of an entity.

        "entityId":"identifier"

    • context — (map)

      Specifies additional context that can be used to make more granular authorization decisions.

      • contextMap — (map<map>)

        An list of attributes that are needed to successfully evaluate an authorization request. Each attribute in this array must include a map of a data type and its value.

        Example: "contextMap":{"<KeyName1>":{"boolean":true},"<KeyName2>":{"long":1234}}

        • boolean — (Boolean)

          An attribute value of Boolean type.

          Example: {"boolean": true}

        • entityIdentifier — (map)

          An attribute value of type EntityIdentifier.

          Example: "entityIdentifier": { "entityId": "<id>", "entityType": "<entity type>"}

          • entityType — required — (String)

            The type of an entity.

            Example: "entityType":"typeName"

          • entityId — required — (String)

            The identifier of an entity.

            "entityId":"identifier"

        • long — (Integer)

          An attribute value of Long type.

          Example: {"long": 0}

        • string — (String)

          An attribute value of String type.

          Example: {"string": "abc"}

        • set — (Array<map>)

          An attribute value of Set type.

          Example: {"set": [ {} ] }

        • record — (map<map>)

          An attribute value of Record type.

          Example: {"record": { "keyName": {} } }

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • principal — (map)

      The identifier of the principal in the ID or access token.

      • entityType — required — (String)

        The type of an entity.

        Example: "entityType":"typeName"

      • entityId — required — (String)

        The identifier of an entity.

        "entityId":"identifier"

    • results — (Array<map>)

      A series of Allow or Deny decisions for each request, and the policies that produced them.

      • request — required — (map)

        The authorization request that initiated the decision.

        • action — (map)

          Specifies the requested action to be authorized. For example, PhotoFlash::ReadPhoto.

          • actionType — required — (String)

            The type of an action.

          • actionId — required — (String)

            The ID of an action.

        • resource — (map)

          Specifies the resource that you want an authorization decision for. For example, PhotoFlash::Photo.

          • entityType — required — (String)

            The type of an entity.

            Example: "entityType":"typeName"

          • entityId — required — (String)

            The identifier of an entity.

            "entityId":"identifier"

        • context — (map)

          Specifies additional context that can be used to make more granular authorization decisions.

          • contextMap — (map<map>)

            An list of attributes that are needed to successfully evaluate an authorization request. Each attribute in this array must include a map of a data type and its value.

            Example: "contextMap":{"<KeyName1>":{"boolean":true},"<KeyName2>":{"long":1234}}

            • boolean — (Boolean)

              An attribute value of Boolean type.

              Example: {"boolean": true}

            • entityIdentifier — (map)

              An attribute value of type EntityIdentifier.

              Example: "entityIdentifier": { "entityId": "<id>", "entityType": "<entity type>"}

              • entityType — required — (String)

                The type of an entity.

                Example: "entityType":"typeName"

              • entityId — required — (String)

                The identifier of an entity.

                "entityId":"identifier"

            • long — (Integer)

              An attribute value of Long type.

              Example: {"long": 0}

            • string — (String)

              An attribute value of String type.

              Example: {"string": "abc"}

            • set — (Array<map>)

              An attribute value of Set type.

              Example: {"set": [ {} ] }

            • record — (map<map>)

              An attribute value of Record type.

              Example: {"record": { "keyName": {} } }

      • decision — required — (String)

        An authorization decision that indicates if the authorization request should be allowed or denied.

        Possible values include:
        • "ALLOW"
        • "DENY"
      • determiningPolicies — required — (Array<map>)

        The list of determining policies used to make the authorization decision. For example, if there are two matching policies, where one is a forbid and the other is a permit, then the forbid policy will be the determining policy. In the case of multiple matching permit policies then there would be multiple determining policies. In the case that no policies match, and hence the response is DENY, there would be no determining policies.

        • policyId — required — (String)

          The Id of a policy that determined to an authorization decision.

          Example: "policyId":"SPEXAMPLEabcdefg111111"

      • errors — required — (Array<map>)

        Errors that occurred while making an authorization decision. For example, a policy might reference an entity or attribute that doesn't exist in the request.

        • errorDescription — required — (String)

          The error description.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  configuration: { /* required */
    cognitoUserPoolConfiguration: {
      userPoolArn: 'STRING_VALUE', /* required */
      clientIds: [
        'STRING_VALUE',
        /* more items */
      ],
      groupConfiguration: {
        groupEntityType: 'STRING_VALUE' /* required */
      }
    },
    openIdConnectConfiguration: {
      issuer: 'STRING_VALUE', /* required */
      tokenSelection: { /* required */
        accessTokenOnly: {
          audiences: [
            'STRING_VALUE',
            /* more items */
          ],
          principalIdClaim: 'STRING_VALUE'
        },
        identityTokenOnly: {
          clientIds: [
            'STRING_VALUE',
            /* more items */
          ],
          principalIdClaim: 'STRING_VALUE'
        }
      },
      entityIdPrefix: 'STRING_VALUE',
      groupConfiguration: {
        groupClaim: 'STRING_VALUE', /* required */
        groupEntityType: 'STRING_VALUE' /* required */
      }
    }
  },
  policyStoreId: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE',
  principalEntityType: 'STRING_VALUE'
};
verifiedpermissions.createIdentitySource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • clientToken — (String)

    Specifies a unique, case-sensitive ID that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value..

    If you don't provide this value, then Amazon Web Services generates a random one for you.

    If you retry the operation with the same ClientToken, but with different parameters, the retry fails with an ConflictException error.

    Verified Permissions recognizes a ClientToken for eight hours. After eight hours, the next request with the same parameters performs the operation again regardless of the value of ClientToken.

    If a token is not provided, the SDK will use a version 4 UUID.
  • policyStoreId — (String)

    Specifies the ID of the policy store in which you want to store this identity source. Only policies and requests made using this policy store can reference identities from the identity provider configured in the new identity source.

  • configuration — (map)

    Specifies the details required to communicate with the identity provider (IdP) associated with this identity source.

    • cognitoUserPoolConfiguration — (map)

      Contains configuration details of a Amazon Cognito user pool that Verified Permissions can use as a source of authenticated identities as entities. It specifies the Amazon Resource Name (ARN) of a Amazon Cognito user pool and one or more application client IDs.

      Example: "configuration":{"cognitoUserPoolConfiguration":{"userPoolArn":"arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5","clientIds": ["a1b2c3d4e5f6g7h8i9j0kalbmc"],"groupConfiguration": {"groupEntityType": "MyCorp::Group"}}}

      • userPoolArn — required — (String)

        The Amazon Resource Name (ARN) of the Amazon Cognito user pool that contains the identities to be authorized.

        Example: "UserPoolArn": "arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5"

      • clientIds — (Array<String>)

        The unique application client IDs that are associated with the specified Amazon Cognito user pool.

        Example: "ClientIds": ["&ExampleCogClientId;"]

      • groupConfiguration — (map)

        The type of entity that a policy store maps to groups from an Amazon Cognito user pool identity source.

        • groupEntityType — required — (String)

          The name of the schema entity type that's mapped to the user pool group. Defaults to AWS::CognitoGroup.

    • openIdConnectConfiguration — (map)

      Contains configuration details of an OpenID Connect (OIDC) identity provider, or identity source, that Verified Permissions can use to generate entities from authenticated identities. It specifies the issuer URL, token type that you want to use, and policy store entity details.

      Example:"configuration":{"openIdConnectConfiguration":{"issuer":"https://auth.example.com","tokenSelection":{"accessTokenOnly":{"audiences":["https://myapp.example.com","https://myapp2.example.com"],"principalIdClaim":"sub"}},"entityIdPrefix":"MyOIDCProvider","groupConfiguration":{"groupClaim":"groups","groupEntityType":"MyCorp::UserGroup"}}}

      • issuer — required — (String)

        The issuer URL of an OIDC identity provider. This URL must have an OIDC discovery endpoint at the path .well-known/openid-configuration.

      • entityIdPrefix — (String)

        A descriptive string that you want to prefix to user entities from your OIDC identity provider. For example, if you set an entityIdPrefix of MyOIDCProvider, you can reference principals in your policies in the format MyCorp::User::MyOIDCProvider|Carlos.

      • groupConfiguration — (map)

        The claim in OIDC identity provider tokens that indicates a user's group membership, and the entity type that you want to map it to. For example, this object can map the contents of a groups claim to MyCorp::UserGroup.

        • groupClaim — required — (String)

          The token claim that you want Verified Permissions to interpret as group membership. For example, groups.

        • groupEntityType — required — (String)

          The policy store entity type that you want to map your users' group claim to. For example, MyCorp::UserGroup. A group entity type is an entity that can have a user entity type as a member.

      • tokenSelection — required — (map)

        The token type that you want to process from your OIDC identity provider. Your policy store can process either identity (ID) or access tokens from a given OIDC identity source.

        • accessTokenOnly — (map)

          The OIDC configuration for processing access tokens. Contains allowed audience claims, for example https://auth.example.com, and the claim that you want to map to the principal, for example sub.

          • principalIdClaim — (String)

            The claim that determines the principal in OIDC access tokens. For example, sub.

          • audiences — (Array<String>)

            The access token aud claim values that you want to accept in your policy store. For example, https://myapp.example.com, https://myapp2.example.com.

        • identityTokenOnly — (map)

          The OIDC configuration for processing identity (ID) tokens. Contains allowed client ID claims, for example 1example23456789, and the claim that you want to map to the principal, for example sub.

          • principalIdClaim — (String)

            The claim that determines the principal in OIDC access tokens. For example, sub.

          • clientIds — (Array<String>)

            The ID token audience, or client ID, claim values that you want to accept in your policy store from an OIDC identity provider. For example, 1example23456789, 2example10111213.

  • principalEntityType — (String)

    Specifies the namespace and data type of the principals generated for identities authenticated by the new identity source.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • createdDate — (Date)

      The date and time the identity source was originally created.

    • identitySourceId — (String)

      The unique ID of the new identity source.

    • lastUpdatedDate — (Date)

      The date and time the identity source was most recently updated.

    • policyStoreId — (String)

      The ID of the policy store that contains the identity source.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  definition: { /* required */
    static: {
      statement: 'STRING_VALUE', /* required */
      description: 'STRING_VALUE'
    },
    templateLinked: {
      policyTemplateId: 'STRING_VALUE', /* required */
      principal: {
        entityId: 'STRING_VALUE', /* required */
        entityType: 'STRING_VALUE' /* required */
      },
      resource: {
        entityId: 'STRING_VALUE', /* required */
        entityType: 'STRING_VALUE' /* required */
      }
    }
  },
  policyStoreId: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE'
};
verifiedpermissions.createPolicy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • clientToken — (String)

    Specifies a unique, case-sensitive ID that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value..

    If you don't provide this value, then Amazon Web Services generates a random one for you.

    If you retry the operation with the same ClientToken, but with different parameters, the retry fails with an ConflictException error.

    Verified Permissions recognizes a ClientToken for eight hours. After eight hours, the next request with the same parameters performs the operation again regardless of the value of ClientToken.

    If a token is not provided, the SDK will use a version 4 UUID.
  • policyStoreId — (String)

    Specifies the PolicyStoreId of the policy store you want to store the policy in.

  • definition — (map)

    A structure that specifies the policy type and content to use for the new policy. You must include either a static or a templateLinked element. The policy content must be written in the Cedar policy language.

    • static — (map)

      A structure that describes a static policy. An static policy doesn't use a template or allow placeholders for entities.

      • description — (String)

        The description of the static policy.

      • statement — required — (String)

        The policy content of the static policy, written in the Cedar policy language.

    • templateLinked — (map)

      A structure that describes a policy that was instantiated from a template. The template can specify placeholders for principal and resource. When you use CreatePolicy to create a policy from a template, you specify the exact principal and resource to use for the instantiated policy.

      • policyTemplateId — required — (String)

        The unique identifier of the policy template used to create this policy.

      • principal — (map)

        The principal associated with this template-linked policy. Verified Permissions substitutes this principal for the ?principal placeholder in the policy template when it evaluates an authorization request.

        • entityType — required — (String)

          The type of an entity.

          Example: "entityType":"typeName"

        • entityId — required — (String)

          The identifier of an entity.

          "entityId":"identifier"

      • resource — (map)

        The resource associated with this template-linked policy. Verified Permissions substitutes this resource for the ?resource placeholder in the policy template when it evaluates an authorization request.

        • entityType — required — (String)

          The type of an entity.

          Example: "entityType":"typeName"

        • entityId — required — (String)

          The identifier of an entity.

          "entityId":"identifier"

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • policyStoreId — (String)

      The ID of the policy store that contains the new policy.

    • policyId — (String)

      The unique ID of the new policy.

    • policyType — (String)

      The policy type of the new policy.

      Possible values include:
      • "STATIC"
      • "TEMPLATE_LINKED"
    • principal — (map)

      The principal specified in the new policy's scope. This response element isn't present when principal isn't specified in the policy content.

      • entityType — required — (String)

        The type of an entity.

        Example: "entityType":"typeName"

      • entityId — required — (String)

        The identifier of an entity.

        "entityId":"identifier"

    • resource — (map)

      The resource specified in the new policy's scope. This response element isn't present when the resource isn't specified in the policy content.

      • entityType — required — (String)

        The type of an entity.

        Example: "entityType":"typeName"

      • entityId — required — (String)

        The identifier of an entity.

        "entityId":"identifier"

    • actions — (Array<map>)

      The action that a policy permits or forbids. For example, {"actions": [{"actionId": "ViewPhoto", "actionType": "PhotoFlash::Action"}, {"entityID": "SharePhoto", "entityType": "PhotoFlash::Action"}]}.

      • actionType — required — (String)

        The type of an action.

      • actionId — required — (String)

        The ID of an action.

    • createdDate — (Date)

      The date and time the policy was originally created.

    • lastUpdatedDate — (Date)

      The date and time the policy was last updated.

    • effect — (String)

      The effect of the decision that a policy returns to an authorization request. For example, "effect": "Permit".

      Possible values include:
      • "Permit"
      • "Forbid"

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  validationSettings: { /* required */
    mode: OFF | STRICT /* required */
  },
  clientToken: 'STRING_VALUE',
  description: 'STRING_VALUE'
};
verifiedpermissions.createPolicyStore(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • clientToken — (String)

    Specifies a unique, case-sensitive ID that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value..

    If you don't provide this value, then Amazon Web Services generates a random one for you.

    If you retry the operation with the same ClientToken, but with different parameters, the retry fails with an ConflictException error.

    Verified Permissions recognizes a ClientToken for eight hours. After eight hours, the next request with the same parameters performs the operation again regardless of the value of ClientToken.

    If a token is not provided, the SDK will use a version 4 UUID.
  • validationSettings — (map)

    Specifies the validation setting for this policy store.

    Currently, the only valid and required value is Mode.

    We recommend that you turn on STRICT mode only after you define a schema. If a schema doesn't exist, then STRICT mode causes any policy to fail validation, and Verified Permissions rejects the policy. You can turn off validation by using the UpdatePolicyStore. Then, when you have a schema defined, use UpdatePolicyStore again to turn validation back on.

    • mode — required — (String)

      The validation mode currently configured for this policy store. The valid values are:

      • OFF – Neither Verified Permissions nor Cedar perform any validation on policies. No validation errors are reported by either service.

      • STRICT – Requires a schema to be present in the policy store. Cedar performs validation on all submitted new or updated static policies and policy templates. Any that fail validation are rejected and Cedar doesn't store them in the policy store.

      If Mode=STRICT and the policy store doesn't contain a schema, Verified Permissions rejects all static policies and policy templates because there is no schema to validate against.

      To submit a static policy or policy template without a schema, you must turn off validation.

      Possible values include:
      • "OFF"
      • "STRICT"
  • description — (String)

    Descriptive text that you can provide to help with identification of the current policy store.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • policyStoreId — (String)

      The unique ID of the new policy store.

    • arn — (String)

      The Amazon Resource Name (ARN) of the new policy store.

    • createdDate — (Date)

      The date and time the policy store was originally created.

    • lastUpdatedDate — (Date)

      The date and time the policy store was last updated.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  policyStoreId: 'STRING_VALUE', /* required */
  statement: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE',
  description: 'STRING_VALUE'
};
verifiedpermissions.createPolicyTemplate(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • clientToken — (String)

    Specifies a unique, case-sensitive ID that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value..

    If you don't provide this value, then Amazon Web Services generates a random one for you.

    If you retry the operation with the same ClientToken, but with different parameters, the retry fails with an ConflictException error.

    Verified Permissions recognizes a ClientToken for eight hours. After eight hours, the next request with the same parameters performs the operation again regardless of the value of ClientToken.

    If a token is not provided, the SDK will use a version 4 UUID.
  • policyStoreId — (String)

    The ID of the policy store in which to create the policy template.

  • description — (String)

    Specifies a description for the policy template.

  • statement — (String)

    Specifies the content that you want to use for the new policy template, written in the Cedar policy language.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • policyStoreId — (String)

      The ID of the policy store that contains the policy template.

    • policyTemplateId — (String)

      The unique ID of the new policy template.

    • createdDate — (Date)

      The date and time the policy template was originally created.

    • lastUpdatedDate — (Date)

      The date and time the policy template was most recently updated.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  identitySourceId: 'STRING_VALUE', /* required */
  policyStoreId: 'STRING_VALUE' /* required */
};
verifiedpermissions.deleteIdentitySource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • policyStoreId — (String)

    Specifies the ID of the policy store that contains the identity source that you want to delete.

  • identitySourceId — (String)

    Specifies the ID of the identity source that you want to delete.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  policyId: 'STRING_VALUE', /* required */
  policyStoreId: 'STRING_VALUE' /* required */
};
verifiedpermissions.deletePolicy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • policyStoreId — (String)

    Specifies the ID of the policy store that contains the policy that you want to delete.

  • policyId — (String)

    Specifies the ID of the policy that you want to delete.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  policyStoreId: 'STRING_VALUE' /* required */
};
verifiedpermissions.deletePolicyStore(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • policyStoreId — (String)

    Specifies the ID of the policy store that you want to delete.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  policyStoreId: 'STRING_VALUE', /* required */
  policyTemplateId: 'STRING_VALUE' /* required */
};
verifiedpermissions.deletePolicyTemplate(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • policyStoreId — (String)

    Specifies the ID of the policy store that contains the policy template that you want to delete.

  • policyTemplateId — (String)

    Specifies the ID of the policy template that you want to delete.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  identitySourceId: 'STRING_VALUE', /* required */
  policyStoreId: 'STRING_VALUE' /* required */
};
verifiedpermissions.getIdentitySource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • policyStoreId — (String)

    Specifies the ID of the policy store that contains the identity source you want information about.

  • identitySourceId — (String)

    Specifies the ID of the identity source you want information about.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • createdDate — (Date)

      The date and time that the identity source was originally created.

    • details — (map)

      A structure that describes the configuration of the identity source.

      • clientIds — (Array<String>)

        The application client IDs associated with the specified Amazon Cognito user pool that are enabled for this identity source.

      • userPoolArn — (String)

        The Amazon Resource Name (ARN) of the Amazon Cognito user pool whose identities are accessible to this Verified Permissions policy store.

      • discoveryUrl — (String)

        The well-known URL that points to this user pool's OIDC discovery endpoint. This is a URL string in the following format. This URL replaces the placeholders for both the Amazon Web Services Region and the user pool identifier with those appropriate for this user pool.

        https://cognito-idp.<region>.amazonaws.com/<user-pool-id>/.well-known/openid-configuration

      • openIdIssuer — (String)

        A string that identifies the type of OIDC service represented by this identity source.

        At this time, the only valid value is cognito.

        Possible values include:
        • "COGNITO"
    • identitySourceId — (String)

      The ID of the identity source.

    • lastUpdatedDate — (Date)

      The date and time that the identity source was most recently updated.

    • policyStoreId — (String)

      The ID of the policy store that contains the identity source.

    • principalEntityType — (String)

      The data type of principals generated for identities authenticated by this identity source.

    • configuration — (map)

      Contains configuration information about an identity source.

      • cognitoUserPoolConfiguration — (map)

        Contains configuration details of a Amazon Cognito user pool that Verified Permissions can use as a source of authenticated identities as entities. It specifies the Amazon Resource Name (ARN) of a Amazon Cognito user pool, the policy store entity that you want to assign to user groups, and one or more application client IDs.

        Example: "configuration":{"cognitoUserPoolConfiguration":{"userPoolArn":"arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5","clientIds": ["a1b2c3d4e5f6g7h8i9j0kalbmc"],"groupConfiguration": {"groupEntityType": "MyCorp::Group"}}}

        • userPoolArn — required — (String)

          The Amazon Resource Name (ARN) of the Amazon Cognito user pool that contains the identities to be authorized.

          Example: "userPoolArn": "arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5"

        • clientIds — required — (Array<String>)

          The unique application client IDs that are associated with the specified Amazon Cognito user pool.

          Example: "clientIds": ["&ExampleCogClientId;"]

        • issuer — required — (String)

          The OpenID Connect (OIDC) issuer ID of the Amazon Cognito user pool that contains the identities to be authorized.

          Example: "issuer": "https://cognito-idp.us-east-1.amazonaws.com/us-east-1_1a2b3c4d5"

        • groupConfiguration — (map)

          The type of entity that a policy store maps to groups from an Amazon Cognito user pool identity source.

          • groupEntityType — (String)

            The name of the schema entity type that's mapped to the user pool group. Defaults to AWS::CognitoGroup.

      • openIdConnectConfiguration — (map)

        Contains configuration details of an OpenID Connect (OIDC) identity provider, or identity source, that Verified Permissions can use to generate entities from authenticated identities. It specifies the issuer URL, token type that you want to use, and policy store entity details.

        Example:"configuration":{"openIdConnectConfiguration":{"issuer":"https://auth.example.com","tokenSelection":{"accessTokenOnly":{"audiences":["https://myapp.example.com","https://myapp2.example.com"],"principalIdClaim":"sub"}},"entityIdPrefix":"MyOIDCProvider","groupConfiguration":{"groupClaim":"groups","groupEntityType":"MyCorp::UserGroup"}}}

        • issuer — required — (String)

          The issuer URL of an OIDC identity provider. This URL must have an OIDC discovery endpoint at the path .well-known/openid-configuration.

        • entityIdPrefix — (String)

          A descriptive string that you want to prefix to user entities from your OIDC identity provider. For example, if you set an entityIdPrefix of MyOIDCProvider, you can reference principals in your policies in the format MyCorp::User::MyOIDCProvider|Carlos.

        • groupConfiguration — (map)

          The claim in OIDC identity provider tokens that indicates a user's group membership, and the entity type that you want to map it to. For example, this object can map the contents of a groups claim to MyCorp::UserGroup.

          • groupClaim — required — (String)

            The token claim that you want Verified Permissions to interpret as group membership. For example, groups.

          • groupEntityType — required — (String)

            The policy store entity type that you want to map your users' group claim to. For example, MyCorp::UserGroup. A group entity type is an entity that can have a user entity type as a member.

        • tokenSelection — required — (map)

          The token type that you want to process from your OIDC identity provider. Your policy store can process either identity (ID) or access tokens from a given OIDC identity source.

          • accessTokenOnly — (map)

            The OIDC configuration for processing access tokens. Contains allowed audience claims, for example https://auth.example.com, and the claim that you want to map to the principal, for example sub.

            • principalIdClaim — (String)

              The claim that determines the principal in OIDC access tokens. For example, sub.

            • audiences — (Array<String>)

              The access token aud claim values that you want to accept in your policy store. For example, https://myapp.example.com, https://myapp2.example.com.

          • identityTokenOnly — (map)

            The OIDC configuration for processing identity (ID) tokens. Contains allowed client ID claims, for example 1example23456789, and the claim that you want to map to the principal, for example sub.

            • principalIdClaim — (String)

              The claim that determines the principal in OIDC access tokens. For example, sub.

            • clientIds — (Array<String>)

              The ID token audience, or client ID, claim values that you want to accept in your policy store from an OIDC identity provider. For example, 1example23456789, 2example10111213.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  policyId: 'STRING_VALUE', /* required */
  policyStoreId: 'STRING_VALUE' /* required */
};
verifiedpermissions.getPolicy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • policyStoreId — (String)

    Specifies the ID of the policy store that contains the policy that you want information about.

  • policyId — (String)

    Specifies the ID of the policy you want information about.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • policyStoreId — (String)

      The ID of the policy store that contains the policy that you want information about.

    • policyId — (String)

      The unique ID of the policy that you want information about.

    • policyType — (String)

      The type of the policy.

      Possible values include:
      • "STATIC"
      • "TEMPLATE_LINKED"
    • principal — (map)

      The principal specified in the policy's scope. This element isn't included in the response when Principal isn't present in the policy content.

      • entityType — required — (String)

        The type of an entity.

        Example: "entityType":"typeName"

      • entityId — required — (String)

        The identifier of an entity.

        "entityId":"identifier"

    • resource — (map)

      The resource specified in the policy's scope. This element isn't included in the response when Resource isn't present in the policy content.

      • entityType — required — (String)

        The type of an entity.

        Example: "entityType":"typeName"

      • entityId — required — (String)

        The identifier of an entity.

        "entityId":"identifier"

    • actions — (Array<map>)

      The action that a policy permits or forbids. For example, {"actions": [{"actionId": "ViewPhoto", "actionType": "PhotoFlash::Action"}, {"entityID": "SharePhoto", "entityType": "PhotoFlash::Action"}]}.

      • actionType — required — (String)

        The type of an action.

      • actionId — required — (String)

        The ID of an action.

    • definition — (map)

      The definition of the requested policy.

      • static — (map)

        Information about a static policy that wasn't created with a policy template.

        • description — (String)

          A description of the static policy.

        • statement — required — (String)

          The content of the static policy written in the Cedar policy language.

      • templateLinked — (map)

        Information about a template-linked policy that was created by instantiating a policy template.

        • policyTemplateId — required — (String)

          The unique identifier of the policy template used to create this policy.

        • principal — (map)

          The principal associated with this template-linked policy. Verified Permissions substitutes this principal for the ?principal placeholder in the policy template when it evaluates an authorization request.

          • entityType — required — (String)

            The type of an entity.

            Example: "entityType":"typeName"

          • entityId — required — (String)

            The identifier of an entity.

            "entityId":"identifier"

        • resource — (map)

          The resource associated with this template-linked policy. Verified Permissions substitutes this resource for the ?resource placeholder in the policy template when it evaluates an authorization request.

          • entityType — required — (String)

            The type of an entity.

            Example: "entityType":"typeName"

          • entityId — required — (String)

            The identifier of an entity.

            "entityId":"identifier"

    • createdDate — (Date)

      The date and time that the policy was originally created.

    • lastUpdatedDate — (Date)

      The date and time that the policy was last updated.

    • effect — (String)

      The effect of the decision that a policy returns to an authorization request. For example, "effect": "Permit".

      Possible values include:
      • "Permit"
      • "Forbid"

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  policyStoreId: 'STRING_VALUE' /* required */
};
verifiedpermissions.getPolicyStore(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • policyStoreId — (String)

    Specifies the ID of the policy store that you want information about.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • policyStoreId — (String)

      The ID of the policy store;

    • arn — (String)

      The Amazon Resource Name (ARN) of the policy store.

    • validationSettings — (map)

      The current validation settings for the policy store.

      • mode — required — (String)

        The validation mode currently configured for this policy store. The valid values are:

        • OFF – Neither Verified Permissions nor Cedar perform any validation on policies. No validation errors are reported by either service.

        • STRICT – Requires a schema to be present in the policy store. Cedar performs validation on all submitted new or updated static policies and policy templates. Any that fail validation are rejected and Cedar doesn't store them in the policy store.

        If Mode=STRICT and the policy store doesn't contain a schema, Verified Permissions rejects all static policies and policy templates because there is no schema to validate against.

        To submit a static policy or policy template without a schema, you must turn off validation.

        Possible values include:
        • "OFF"
        • "STRICT"
    • createdDate — (Date)

      The date and time that the policy store was originally created.

    • lastUpdatedDate — (Date)

      The date and time that the policy store was last updated.

    • description — (String)

      Descriptive text that you can provide to help with identification of the current policy store.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  policyStoreId: 'STRING_VALUE', /* required */
  policyTemplateId: 'STRING_VALUE' /* required */
};
verifiedpermissions.getPolicyTemplate(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • policyStoreId — (String)

    Specifies the ID of the policy store that contains the policy template that you want information about.

  • policyTemplateId — (String)

    Specifies the ID of the policy template that you want information about.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • policyStoreId — (String)

      The ID of the policy store that contains the policy template.

    • policyTemplateId — (String)

      The ID of the policy template.

    • description — (String)

      The description of the policy template.

    • statement — (String)

      The content of the body of the policy template written in the Cedar policy language.

    • createdDate — (Date)

      The date and time that the policy template was originally created.

    • lastUpdatedDate — (Date)

      The date and time that the policy template was most recently updated.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  policyStoreId: 'STRING_VALUE' /* required */
};
verifiedpermissions.getSchema(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • policyStoreId — (String)

    Specifies the ID of the policy store that contains the schema.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • policyStoreId — (String)

      The ID of the policy store that contains the schema.

    • schema — (String)

      The body of the schema, written in Cedar schema JSON.

    • createdDate — (Date)

      The date and time that the schema was originally created.

    • lastUpdatedDate — (Date)

      The date and time that the schema was most recently updated.

    • namespaces — (Array<String>)

      The namespaces of the entities referenced by this schema.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  policyStoreId: 'STRING_VALUE', /* required */
  action: {
    actionId: 'STRING_VALUE', /* required */
    actionType: 'STRING_VALUE' /* required */
  },
  context: {
    contextMap: {
      '<String>': { /* AttributeValue */
        boolean: true || false,
        entityIdentifier: {
          entityId: 'STRING_VALUE', /* required */
          entityType: 'STRING_VALUE' /* required */
        },
        long: 'NUMBER_VALUE',
        record: {
          '<String>': /* recursive AttributeValue */,
          /* '<String>': ... */
        },
        set: [
          /* recursive AttributeValue */,
          /* more items */
        ],
        string: 'STRING_VALUE'
      },
      /* '<String>': ... */
    }
  },
  entities: {
    entityList: [
      {
        identifier: { /* required */
          entityId: 'STRING_VALUE', /* required */
          entityType: 'STRING_VALUE' /* required */
        },
        attributes: {
          '<String>': { /* AttributeValue */
            boolean: true || false,
            entityIdentifier: {
              entityId: 'STRING_VALUE', /* required */
              entityType: 'STRING_VALUE' /* required */
            },
            long: 'NUMBER_VALUE',
            record: {
              '<String>': /* recursive AttributeValue */,
              /* '<String>': ... */
            },
            set: [
              /* recursive AttributeValue */,
              /* more items */
            ],
            string: 'STRING_VALUE'
          },
          /* '<String>': ... */
        },
        parents: [
          {
            entityId: 'STRING_VALUE', /* required */
            entityType: 'STRING_VALUE' /* required */
          },
          /* more items */
        ]
      },
      /* more items */
    ]
  },
  principal: {
    entityId: 'STRING_VALUE', /* required */
    entityType: 'STRING_VALUE' /* required */
  },
  resource: {
    entityId: 'STRING_VALUE', /* required */
    entityType: 'STRING_VALUE' /* required */
  }
};
verifiedpermissions.isAuthorized(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • policyStoreId — (String)

    Specifies the ID of the policy store. Policies in this policy store will be used to make an authorization decision for the input.

  • principal — (map)

    Specifies the principal for which the authorization decision is to be made.

    • entityType — required — (String)

      The type of an entity.

      Example: "entityType":"typeName"

    • entityId — required — (String)

      The identifier of an entity.

      "entityId":"identifier"

  • action — (map)

    Specifies the requested action to be authorized. For example, is the principal authorized to perform this action on the resource?

    • actionType — required — (String)

      The type of an action.

    • actionId — required — (String)

      The ID of an action.

  • resource — (map)

    Specifies the resource for which the authorization decision is to be made.

    • entityType — required — (String)

      The type of an entity.

      Example: "entityType":"typeName"

    • entityId — required — (String)

      The identifier of an entity.

      "entityId":"identifier"

  • context — (map)

    Specifies additional context that can be used to make more granular authorization decisions.

    • contextMap — (map<map>)

      An list of attributes that are needed to successfully evaluate an authorization request. Each attribute in this array must include a map of a data type and its value.

      Example: "contextMap":{"<KeyName1>":{"boolean":true},"<KeyName2>":{"long":1234}}

      • boolean — (Boolean)

        An attribute value of Boolean type.

        Example: {"boolean": true}

      • entityIdentifier — (map)

        An attribute value of type EntityIdentifier.

        Example: "entityIdentifier": { "entityId": "<id>", "entityType": "<entity type>"}

        • entityType — required — (String)

          The type of an entity.

          Example: "entityType":"typeName"

        • entityId — required — (String)

          The identifier of an entity.

          "entityId":"identifier"

      • long — (Integer)

        An attribute value of Long type.

        Example: {"long": 0}

      • string — (String)

        An attribute value of String type.

        Example: {"string": "abc"}

      • set — (Array<map>)

        An attribute value of Set type.

        Example: {"set": [ {} ] }

      • record — (map<map>)

        An attribute value of Record type.

        Example: {"record": { "keyName": {} } }

  • entities — (map)

    Specifies the list of resources and principals and their associated attributes that Verified Permissions can examine when evaluating the policies.

    Note: You can include only principal and resource entities in this parameter; you can't include actions. You must specify actions in the schema.
    • entityList — (Array<map>)

      An array of entities that are needed to successfully evaluate an authorization request. Each entity in this array must include an identifier for the entity, the attributes of the entity, and a list of any parent entities.

      • identifier — required — (map)

        The identifier of the entity.

        • entityType — required — (String)

          The type of an entity.

          Example: "entityType":"typeName"

        • entityId — required — (String)

          The identifier of an entity.

          "entityId":"identifier"

      • attributes — (map<map>)

        A list of attributes for the entity.

        • boolean — (Boolean)

          An attribute value of Boolean type.

          Example: {"boolean": true}

        • entityIdentifier — (map)

          An attribute value of type EntityIdentifier.

          Example: "entityIdentifier": { "entityId": "<id>", "entityType": "<entity type>"}

          • entityType — required — (String)

            The type of an entity.

            Example: "entityType":"typeName"

          • entityId — required — (String)

            The identifier of an entity.

            "entityId":"identifier"

        • long — (Integer)

          An attribute value of Long type.

          Example: {"long": 0}

        • string — (String)

          An attribute value of String type.

          Example: {"string": "abc"}

        • set — (Array<map>)

          An attribute value of Set type.

          Example: {"set": [ {} ] }

        • record — (map<map>)

          An attribute value of Record type.

          Example: {"record": { "keyName": {} } }

      • parents — (Array<map>)

        The parent entities in the hierarchy that contains the entity. A principal or resource entity can be defined with at most 99 transitive parents per authorization request.

        A transitive parent is an entity in the hierarchy of entities including all direct parents, and parents of parents. For example, a user can be a member of 91 groups if one of those groups is a member of eight groups, for a total of 100: one entity, 91 entity parents, and eight parents of parents.

        • entityType — required — (String)

          The type of an entity.

          Example: "entityType":"typeName"

        • entityId — required — (String)

          The identifier of an entity.

          "entityId":"identifier"

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • decision — (String)

      An authorization decision that indicates if the authorization request should be allowed or denied.

      Possible values include:
      • "ALLOW"
      • "DENY"
    • determiningPolicies — (Array<map>)

      The list of determining policies used to make the authorization decision. For example, if there are two matching policies, where one is a forbid and the other is a permit, then the forbid policy will be the determining policy. In the case of multiple matching permit policies then there would be multiple determining policies. In the case that no policies match, and hence the response is DENY, there would be no determining policies.

      • policyId — required — (String)

        The Id of a policy that determined to an authorization decision.

        Example: "policyId":"SPEXAMPLEabcdefg111111"

    • errors — (Array<map>)

      Errors that occurred while making an authorization decision, for example, a policy references an Entity or entity Attribute that does not exist in the slice.

      • errorDescription — required — (String)

        The error description.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  policyStoreId: 'STRING_VALUE', /* required */
  accessToken: 'STRING_VALUE',
  action: {
    actionId: 'STRING_VALUE', /* required */
    actionType: 'STRING_VALUE' /* required */
  },
  context: {
    contextMap: {
      '<String>': { /* AttributeValue */
        boolean: true || false,
        entityIdentifier: {
          entityId: 'STRING_VALUE', /* required */
          entityType: 'STRING_VALUE' /* required */
        },
        long: 'NUMBER_VALUE',
        record: {
          '<String>': /* recursive AttributeValue */,
          /* '<String>': ... */
        },
        set: [
          /* recursive AttributeValue */,
          /* more items */
        ],
        string: 'STRING_VALUE'
      },
      /* '<String>': ... */
    }
  },
  entities: {
    entityList: [
      {
        identifier: { /* required */
          entityId: 'STRING_VALUE', /* required */
          entityType: 'STRING_VALUE' /* required */
        },
        attributes: {
          '<String>': { /* AttributeValue */
            boolean: true || false,
            entityIdentifier: {
              entityId: 'STRING_VALUE', /* required */
              entityType: 'STRING_VALUE' /* required */
            },
            long: 'NUMBER_VALUE',
            record: {
              '<String>': /* recursive AttributeValue */,
              /* '<String>': ... */
            },
            set: [
              /* recursive AttributeValue */,
              /* more items */
            ],
            string: 'STRING_VALUE'
          },
          /* '<String>': ... */
        },
        parents: [
          {
            entityId: 'STRING_VALUE', /* required */
            entityType: 'STRING_VALUE' /* required */
          },
          /* more items */
        ]
      },
      /* more items */
    ]
  },
  identityToken: 'STRING_VALUE',
  resource: {
    entityId: 'STRING_VALUE', /* required */
    entityType: 'STRING_VALUE' /* required */
  }
};
verifiedpermissions.isAuthorizedWithToken(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • policyStoreId — (String)

    Specifies the ID of the policy store. Policies in this policy store will be used to make an authorization decision for the input.

  • identityToken — (String)

    Specifies an identity token for the principal to be authorized. This token is provided to you by the identity provider (IdP) associated with the specified identity source. You must specify either an accessToken, an identityToken, or both.

    Must be an ID token. Verified Permissions returns an error if the token_use claim in the submitted token isn't id.

  • accessToken — (String)

    Specifies an access token for the principal to be authorized. This token is provided to you by the identity provider (IdP) associated with the specified identity source. You must specify either an accessToken, an identityToken, or both.

    Must be an access token. Verified Permissions returns an error if the token_use claim in the submitted token isn't access.

  • action — (map)

    Specifies the requested action to be authorized. Is the specified principal authorized to perform this action on the specified resource.

    • actionType — required — (String)

      The type of an action.

    • actionId — required — (String)

      The ID of an action.

  • resource — (map)

    Specifies the resource for which the authorization decision is made. For example, is the principal allowed to perform the action on the resource?

    • entityType — required — (String)

      The type of an entity.

      Example: "entityType":"typeName"

    • entityId — required — (String)

      The identifier of an entity.

      "entityId":"identifier"

  • context — (map)

    Specifies additional context that can be used to make more granular authorization decisions.

    • contextMap — (map<map>)

      An list of attributes that are needed to successfully evaluate an authorization request. Each attribute in this array must include a map of a data type and its value.

      Example: "contextMap":{"<KeyName1>":{"boolean":true},"<KeyName2>":{"long":1234}}

      • boolean — (Boolean)

        An attribute value of Boolean type.

        Example: {"boolean": true}

      • entityIdentifier — (map)

        An attribute value of type EntityIdentifier.

        Example: "entityIdentifier": { "entityId": "<id>", "entityType": "<entity type>"}

        • entityType — required — (String)

          The type of an entity.

          Example: "entityType":"typeName"

        • entityId — required — (String)

          The identifier of an entity.

          "entityId":"identifier"

      • long — (Integer)

        An attribute value of Long type.

        Example: {"long": 0}

      • string — (String)

        An attribute value of String type.

        Example: {"string": "abc"}

      • set — (Array<map>)

        An attribute value of Set type.

        Example: {"set": [ {} ] }

      • record — (map<map>)

        An attribute value of Record type.

        Example: {"record": { "keyName": {} } }

  • entities — (map)

    Specifies the list of resources and their associated attributes that Verified Permissions can examine when evaluating the policies.

    You can't include principals in this parameter, only resource and action entities. This parameter can't include any entities of a type that matches the user or group entity types that you defined in your identity source.

    • The IsAuthorizedWithToken operation takes principal attributes from only the identityToken or accessToken passed to the operation.

    • For action entities, you can include only their Identifier and EntityType.

    • entityList — (Array<map>)

      An array of entities that are needed to successfully evaluate an authorization request. Each entity in this array must include an identifier for the entity, the attributes of the entity, and a list of any parent entities.

      • identifier — required — (map)

        The identifier of the entity.

        • entityType — required — (String)

          The type of an entity.

          Example: "entityType":"typeName"

        • entityId — required — (String)

          The identifier of an entity.

          "entityId":"identifier"

      • attributes — (map<map>)

        A list of attributes for the entity.

        • boolean — (Boolean)

          An attribute value of Boolean type.

          Example: {"boolean": true}

        • entityIdentifier — (map)

          An attribute value of type EntityIdentifier.

          Example: "entityIdentifier": { "entityId": "<id>", "entityType": "<entity type>"}

          • entityType — required — (String)

            The type of an entity.

            Example: "entityType":"typeName"

          • entityId — required — (String)

            The identifier of an entity.

            "entityId":"identifier"

        • long — (Integer)

          An attribute value of Long type.

          Example: {"long": 0}

        • string — (String)

          An attribute value of String type.

          Example: {"string": "abc"}

        • set — (Array<map>)

          An attribute value of Set type.

          Example: {"set": [ {} ] }

        • record — (map<map>)

          An attribute value of Record type.

          Example: {"record": { "keyName": {} } }

      • parents — (Array<map>)

        The parent entities in the hierarchy that contains the entity. A principal or resource entity can be defined with at most 99 transitive parents per authorization request.

        A transitive parent is an entity in the hierarchy of entities including all direct parents, and parents of parents. For example, a user can be a member of 91 groups if one of those groups is a member of eight groups, for a total of 100: one entity, 91 entity parents, and eight parents of parents.

        • entityType — required — (String)

          The type of an entity.

          Example: "entityType":"typeName"

        • entityId — required — (String)

          The identifier of an entity.

          "entityId":"identifier"

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • decision — (String)

      An authorization decision that indicates if the authorization request should be allowed or denied.

      Possible values include:
      • "ALLOW"
      • "DENY"
    • determiningPolicies — (Array<map>)

      The list of determining policies used to make the authorization decision. For example, if there are multiple matching policies, where at least one is a forbid policy, then because forbid always overrides permit the forbid policies are the determining policies. If all matching policies are permit policies, then those policies are the determining policies. When no policies match and the response is the default DENY, there are no determining policies.

      • policyId — required — (String)

        The Id of a policy that determined to an authorization decision.

        Example: "policyId":"SPEXAMPLEabcdefg111111"

    • errors — (Array<map>)

      Errors that occurred while making an authorization decision. For example, a policy references an entity or entity attribute that does not exist in the slice.

      • errorDescription — required — (String)

        The error description.

    • principal — (map)

      The identifier of the principal in the ID or access token.

      • entityType — required — (String)

        The type of an entity.

        Example: "entityType":"typeName"

      • entityId — required — (String)

        The identifier of an entity.

        "entityId":"identifier"

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  policyStoreId: 'STRING_VALUE', /* required */
  filters: [
    {
      principalEntityType: 'STRING_VALUE'
    },
    /* more items */
  ],
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
verifiedpermissions.listIdentitySources(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • policyStoreId — (String)

    Specifies the ID of the policy store that contains the identity sources that you want to list.

  • nextToken — (String)

    Specifies that you want to receive the next page of results. Valid only if you received a NextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's NextToken response to request the next page of results.

  • maxResults — (Integer)

    Specifies the total number of results that you want included in each response. If additional items exist beyond the number you specify, the NextToken response element is returned with a value (not null). Include the specified value as the NextToken request parameter in the next call to the operation to get the next set of results. Note that the service might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

    If you do not specify this parameter, the operation defaults to 10 identity sources per response. You can specify a maximum of 50 identity sources per response.

  • filters — (Array<map>)

    Specifies characteristics of an identity source that you can use to limit the output to matching identity sources.

    • principalEntityType — (String)

      The Cedar entity type of the principals returned by the identity provider (IdP) associated with this identity source.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • nextToken — (String)

      If present, this value indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null. This indicates that this is the last page of results.

    • identitySources — (Array<map>)

      The list of identity sources stored in the specified policy store.

      • createdDate — required — (Date)

        The date and time the identity source was originally created.

      • details — (map)

        A structure that contains the details of the associated identity provider (IdP).

        • clientIds — (Array<String>)

          The application client IDs associated with the specified Amazon Cognito user pool that are enabled for this identity source.

        • userPoolArn — (String)

          The Amazon Cognito user pool whose identities are accessible to this Verified Permissions policy store.

        • discoveryUrl — (String)

          The well-known URL that points to this user pool's OIDC discovery endpoint. This is a URL string in the following format. This URL replaces the placeholders for both the Amazon Web Services Region and the user pool identifier with those appropriate for this user pool.

          https://cognito-idp.<region>.amazonaws.com/<user-pool-id>/.well-known/openid-configuration

        • openIdIssuer — (String)

          A string that identifies the type of OIDC service represented by this identity source.

          At this time, the only valid value is cognito.

          Possible values include:
          • "COGNITO"
      • identitySourceId — required — (String)

        The unique identifier of the identity source.

      • lastUpdatedDate — required — (Date)

        The date and time the identity source was most recently updated.

      • policyStoreId — required — (String)

        The identifier of the policy store that contains the identity source.

      • principalEntityType — required — (String)

        The Cedar entity type of the principals returned from the IdP associated with this identity source.

      • configuration — (map)

        Contains configuration information about an identity source.

        • cognitoUserPoolConfiguration — (map)

          Contains configuration details of a Amazon Cognito user pool that Verified Permissions can use as a source of authenticated identities as entities. It specifies the Amazon Resource Name (ARN) of a Amazon Cognito user pool, the policy store entity that you want to assign to user groups, and one or more application client IDs.

          Example: "configuration":{"cognitoUserPoolConfiguration":{"userPoolArn":"arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5","clientIds": ["a1b2c3d4e5f6g7h8i9j0kalbmc"],"groupConfiguration": {"groupEntityType": "MyCorp::Group"}}}

          • userPoolArn — required — (String)

            The Amazon Resource Name (ARN) of the Amazon Cognito user pool that contains the identities to be authorized.

            Example: "userPoolArn": "arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5"

          • clientIds — required — (Array<String>)

            The unique application client IDs that are associated with the specified Amazon Cognito user pool.

            Example: "clientIds": ["&ExampleCogClientId;"]

          • issuer — required — (String)

            The OpenID Connect (OIDC) issuer ID of the Amazon Cognito user pool that contains the identities to be authorized.

            Example: "issuer": "https://cognito-idp.us-east-1.amazonaws.com/us-east-1_1a2b3c4d5"

          • groupConfiguration — (map)

            The type of entity that a policy store maps to groups from an Amazon Cognito user pool identity source.

            • groupEntityType — (String)

              The name of the schema entity type that's mapped to the user pool group. Defaults to AWS::CognitoGroup.

        • openIdConnectConfiguration — (map)

          Contains configuration details of an OpenID Connect (OIDC) identity provider, or identity source, that Verified Permissions can use to generate entities from authenticated identities. It specifies the issuer URL, token type that you want to use, and policy store entity details.

          Example:"configuration":{"openIdConnectConfiguration":{"issuer":"https://auth.example.com","tokenSelection":{"accessTokenOnly":{"audiences":["https://myapp.example.com","https://myapp2.example.com"],"principalIdClaim":"sub"}},"entityIdPrefix":"MyOIDCProvider","groupConfiguration":{"groupClaim":"groups","groupEntityType":"MyCorp::UserGroup"}}}

          • issuer — required — (String)

            The issuer URL of an OIDC identity provider. This URL must have an OIDC discovery endpoint at the path .well-known/openid-configuration.

          • entityIdPrefix — (String)

            A descriptive string that you want to prefix to user entities from your OIDC identity provider. For example, if you set an entityIdPrefix of MyOIDCProvider, you can reference principals in your policies in the format MyCorp::User::MyOIDCProvider|Carlos.

          • groupConfiguration — (map)

            The claim in OIDC identity provider tokens that indicates a user's group membership, and the entity type that you want to map it to. For example, this object can map the contents of a groups claim to MyCorp::UserGroup.

            • groupClaim — required — (String)

              The token claim that you want Verified Permissions to interpret as group membership. For example, groups.

            • groupEntityType — required — (String)

              The policy store entity type that you want to map your users' group claim to. For example, MyCorp::UserGroup. A group entity type is an entity that can have a user entity type as a member.

          • tokenSelection — required — (map)

            The token type that you want to process from your OIDC identity provider. Your policy store can process either identity (ID) or access tokens from a given OIDC identity source.

            • accessTokenOnly — (map)

              The OIDC configuration for processing access tokens. Contains allowed audience claims, for example https://auth.example.com, and the claim that you want to map to the principal, for example sub.

              • principalIdClaim — (String)

                The claim that determines the principal in OIDC access tokens. For example, sub.

              • audiences — (Array<String>)

                The access token aud claim values that you want to accept in your policy store. For example, https://myapp.example.com, https://myapp2.example.com.

            • identityTokenOnly — (map)

              The OIDC configuration for processing identity (ID) tokens. Contains allowed client ID claims, for example 1example23456789, and the claim that you want to map to the principal, for example sub.

              • principalIdClaim — (String)

                The claim that determines the principal in OIDC access tokens. For example, sub.

              • clientIds — (Array<String>)

                The ID token audience, or client ID, claim values that you want to accept in your policy store from an OIDC identity provider. For example, 1example23456789, 2example10111213.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  policyStoreId: 'STRING_VALUE', /* required */
  filter: {
    policyTemplateId: 'STRING_VALUE',
    policyType: STATIC | TEMPLATE_LINKED,
    principal: {
      identifier: {
        entityId: 'STRING_VALUE', /* required */
        entityType: 'STRING_VALUE' /* required */
      },
      unspecified: true || false
    },
    resource: {
      identifier: {
        entityId: 'STRING_VALUE', /* required */
        entityType: 'STRING_VALUE' /* required */
      },
      unspecified: true || false
    }
  },
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
verifiedpermissions.listPolicies(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • policyStoreId — (String)

    Specifies the ID of the policy store you want to list policies from.

  • nextToken — (String)

    Specifies that you want to receive the next page of results. Valid only if you received a NextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's NextToken response to request the next page of results.

  • maxResults — (Integer)

    Specifies the total number of results that you want included in each response. If additional items exist beyond the number you specify, the NextToken response element is returned with a value (not null). Include the specified value as the NextToken request parameter in the next call to the operation to get the next set of results. Note that the service might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

    If you do not specify this parameter, the operation defaults to 10 policies per response. You can specify a maximum of 50 policies per response.

  • filter — (map)

    Specifies a filter that limits the response to only policies that match the specified criteria. For example, you list only the policies that reference a specified principal.

    • principal — (map)

      Filters the output to only policies that reference the specified principal.

      • unspecified — (Boolean)

        Used to indicate that a principal or resource is not specified. This can be used to search for policies that are not associated with a specific principal or resource.

      • identifier — (map)

        The identifier of the entity. It can consist of either an EntityType and EntityId, a principal, or a resource.

        • entityType — required — (String)

          The type of an entity.

          Example: "entityType":"typeName"

        • entityId — required — (String)

          The identifier of an entity.

          "entityId":"identifier"

    • resource — (map)

      Filters the output to only policies that reference the specified resource.

      • unspecified — (Boolean)

        Used to indicate that a principal or resource is not specified. This can be used to search for policies that are not associated with a specific principal or resource.

      • identifier — (map)

        The identifier of the entity. It can consist of either an EntityType and EntityId, a principal, or a resource.

        • entityType — required — (String)

          The type of an entity.

          Example: "entityType":"typeName"

        • entityId — required — (String)

          The identifier of an entity.

          "entityId":"identifier"

    • policyType — (String)

      Filters the output to only policies of the specified type.

      Possible values include:
      • "STATIC"
      • "TEMPLATE_LINKED"
    • policyTemplateId — (String)

      Filters the output to only template-linked policies that were instantiated from the specified policy template.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • nextToken — (String)

      If present, this value indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null. This indicates that this is the last page of results.

    • policies — (Array<map>)

      Lists all policies that are available in the specified policy store.

      • policyStoreId — required — (String)

        The identifier of the PolicyStore where the policy you want information about is stored.

      • policyId — required — (String)

        The identifier of the policy you want information about.

      • policyType — required — (String)

        The type of the policy. This is one of the following values:

        • static

        • templateLinked

        Possible values include:
        • "STATIC"
        • "TEMPLATE_LINKED"
      • principal — (map)

        The principal associated with the policy.

        • entityType — required — (String)

          The type of an entity.

          Example: "entityType":"typeName"

        • entityId — required — (String)

          The identifier of an entity.

          "entityId":"identifier"

      • resource — (map)

        The resource associated with the policy.

        • entityType — required — (String)

          The type of an entity.

          Example: "entityType":"typeName"

        • entityId — required — (String)

          The identifier of an entity.

          "entityId":"identifier"

      • actions — (Array<map>)

        The action that a policy permits or forbids. For example, {"actions": [{"actionId": "ViewPhoto", "actionType": "PhotoFlash::Action"}, {"entityID": "SharePhoto", "entityType": "PhotoFlash::Action"}]}.

        • actionType — required — (String)

          The type of an action.

        • actionId — required — (String)

          The ID of an action.

      • definition — required — (map)

        The policy definition of an item in the list of policies returned.

        • static — (map)

          Information about a static policy that wasn't created with a policy template.

          • description — (String)

            A description of the static policy.

        • templateLinked — (map)

          Information about a template-linked policy that was created by instantiating a policy template.

          • policyTemplateId — required — (String)

            The unique identifier of the policy template used to create this policy.

          • principal — (map)

            The principal associated with this template-linked policy. Verified Permissions substitutes this principal for the ?principal placeholder in the policy template when it evaluates an authorization request.

            • entityType — required — (String)

              The type of an entity.

              Example: "entityType":"typeName"

            • entityId — required — (String)

              The identifier of an entity.

              "entityId":"identifier"

          • resource — (map)

            The resource associated with this template-linked policy. Verified Permissions substitutes this resource for the ?resource placeholder in the policy template when it evaluates an authorization request.

            • entityType — required — (String)

              The type of an entity.

              Example: "entityType":"typeName"

            • entityId — required — (String)

              The identifier of an entity.

              "entityId":"identifier"

      • createdDate — required — (Date)

        The date and time the policy was created.

      • lastUpdatedDate — required — (Date)

        The date and time the policy was most recently updated.

      • effect — (String)

        The effect of the decision that a policy returns to an authorization request. For example, "effect": "Permit".

        Possible values include:
        • "Permit"
        • "Forbid"

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
verifiedpermissions.listPolicyStores(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • nextToken — (String)

    Specifies that you want to receive the next page of results. Valid only if you received a NextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's NextToken response to request the next page of results.

  • maxResults — (Integer)

    Specifies the total number of results that you want included in each response. If additional items exist beyond the number you specify, the NextToken response element is returned with a value (not null). Include the specified value as the NextToken request parameter in the next call to the operation to get the next set of results. Note that the service might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

    If you do not specify this parameter, the operation defaults to 10 policy stores per response. You can specify a maximum of 50 policy stores per response.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • nextToken — (String)

      If present, this value indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null. This indicates that this is the last page of results.

    • policyStores — (Array<map>)

      The list of policy stores in the account.

      • policyStoreId — required — (String)

        The unique identifier of the policy store.

      • arn — required — (String)

        The Amazon Resource Name (ARN) of the policy store.

      • createdDate — required — (Date)

        The date and time the policy was created.

      • lastUpdatedDate — (Date)

        The date and time the policy store was most recently updated.

      • description — (String)

        Descriptive text that you can provide to help with identification of the current policy store.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  policyStoreId: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
verifiedpermissions.listPolicyTemplates(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • policyStoreId — (String)

    Specifies the ID of the policy store that contains the policy templates you want to list.

  • nextToken — (String)

    Specifies that you want to receive the next page of results. Valid only if you received a NextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's NextToken response to request the next page of results.

  • maxResults — (Integer)

    Specifies the total number of results that you want included in each response. If additional items exist beyond the number you specify, the NextToken response element is returned with a value (not null). Include the specified value as the NextToken request parameter in the next call to the operation to get the next set of results. Note that the service might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

    If you do not specify this parameter, the operation defaults to 10 policy templates per response. You can specify a maximum of 50 policy templates per response.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • nextToken — (String)

      If present, this value indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null. This indicates that this is the last page of results.

    • policyTemplates — (Array<map>)

      The list of the policy templates in the specified policy store.

      • policyStoreId — required — (String)

        The unique identifier of the policy store that contains the template.

      • policyTemplateId — required — (String)

        The unique identifier of the policy template.

      • description — (String)

        The description attached to the policy template.

      • createdDate — required — (Date)

        The date and time that the policy template was created.

      • lastUpdatedDate — required — (Date)

        The date and time that the policy template was most recently updated.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  definition: { /* required */
    cedarJson: 'STRING_VALUE'
  },
  policyStoreId: 'STRING_VALUE' /* required */
};
verifiedpermissions.putSchema(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • policyStoreId — (String)

    Specifies the ID of the policy store in which to place the schema.

  • definition — (map)

    Specifies the definition of the schema to be stored. The schema definition must be written in Cedar schema JSON.

    • cedarJson — (String)

      A JSON string representation of the schema supported by applications that use this policy store. For more information, see Policy store schema in the Amazon Verified Permissions User Guide.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • policyStoreId — (String)

      The unique ID of the policy store that contains the schema.

    • namespaces — (Array<String>)

      Identifies the namespaces of the entities referenced by this schema.

    • createdDate — (Date)

      The date and time that the schema was originally created.

    • lastUpdatedDate — (Date)

      The date and time that the schema was last updated.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  identitySourceId: 'STRING_VALUE', /* required */
  policyStoreId: 'STRING_VALUE', /* required */
  updateConfiguration: { /* required */
    cognitoUserPoolConfiguration: {
      userPoolArn: 'STRING_VALUE', /* required */
      clientIds: [
        'STRING_VALUE',
        /* more items */
      ],
      groupConfiguration: {
        groupEntityType: 'STRING_VALUE' /* required */
      }
    },
    openIdConnectConfiguration: {
      issuer: 'STRING_VALUE', /* required */
      tokenSelection: { /* required */
        accessTokenOnly: {
          audiences: [
            'STRING_VALUE',
            /* more items */
          ],
          principalIdClaim: 'STRING_VALUE'
        },
        identityTokenOnly: {
          clientIds: [
            'STRING_VALUE',
            /* more items */
          ],
          principalIdClaim: 'STRING_VALUE'
        }
      },
      entityIdPrefix: 'STRING_VALUE',
      groupConfiguration: {
        groupClaim: 'STRING_VALUE', /* required */
        groupEntityType: 'STRING_VALUE' /* required */
      }
    }
  },
  principalEntityType: 'STRING_VALUE'
};
verifiedpermissions.updateIdentitySource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • policyStoreId — (String)

    Specifies the ID of the policy store that contains the identity source that you want to update.

  • identitySourceId — (String)

    Specifies the ID of the identity source that you want to update.

  • updateConfiguration — (map)

    Specifies the details required to communicate with the identity provider (IdP) associated with this identity source.

    Note: At this time, the only valid member of this structure is a Amazon Cognito user pool configuration. You must specify a userPoolArn, and optionally, a ClientId.
    • cognitoUserPoolConfiguration — (map)

      Contains configuration details of a Amazon Cognito user pool.

      • userPoolArn — required — (String)

        The Amazon Resource Name (ARN) of the Amazon Cognito user pool associated with this identity source.

      • clientIds — (Array<String>)

        The client ID of an app client that is configured for the specified Amazon Cognito user pool.

      • groupConfiguration — (map)

        The configuration of the user groups from an Amazon Cognito user pool identity source.

        • groupEntityType — required — (String)

          The name of the schema entity type that's mapped to the user pool group. Defaults to AWS::CognitoGroup.

    • openIdConnectConfiguration — (map)

      Contains configuration details of an OpenID Connect (OIDC) identity provider, or identity source, that Verified Permissions can use to generate entities from authenticated identities. It specifies the issuer URL, token type that you want to use, and policy store entity details.

      • issuer — required — (String)

        The issuer URL of an OIDC identity provider. This URL must have an OIDC discovery endpoint at the path .well-known/openid-configuration.

      • entityIdPrefix — (String)

        A descriptive string that you want to prefix to user entities from your OIDC identity provider. For example, if you set an entityIdPrefix of MyOIDCProvider, you can reference principals in your policies in the format MyCorp::User::MyOIDCProvider|Carlos.

      • groupConfiguration — (map)

        The claim in OIDC identity provider tokens that indicates a user's group membership, and the entity type that you want to map it to. For example, this object can map the contents of a groups claim to MyCorp::UserGroup.

        • groupClaim — required — (String)

          The token claim that you want Verified Permissions to interpret as group membership. For example, groups.

        • groupEntityType — required — (String)

          The policy store entity type that you want to map your users' group claim to. For example, MyCorp::UserGroup. A group entity type is an entity that can have a user entity type as a member.

      • tokenSelection — required — (map)

        The token type that you want to process from your OIDC identity provider. Your policy store can process either identity (ID) or access tokens from a given OIDC identity source.

        • accessTokenOnly — (map)

          The OIDC configuration for processing access tokens. Contains allowed audience claims, for example https://auth.example.com, and the claim that you want to map to the principal, for example sub.

          • principalIdClaim — (String)

            The claim that determines the principal in OIDC access tokens. For example, sub.

          • audiences — (Array<String>)

            The access token aud claim values that you want to accept in your policy store. For example, https://myapp.example.com, https://myapp2.example.com.

        • identityTokenOnly — (map)

          The OIDC configuration for processing identity (ID) tokens. Contains allowed client ID claims, for example 1example23456789, and the claim that you want to map to the principal, for example sub.

          • principalIdClaim — (String)

            The claim that determines the principal in OIDC access tokens. For example, sub.

          • clientIds — (Array<String>)

            The ID token audience, or client ID, claim values that you want to accept in your policy store from an OIDC identity provider. For example, 1example23456789, 2example10111213.

  • principalEntityType — (String)

    Specifies the data type of principals generated for identities authenticated by the identity source.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • createdDate — (Date)

      The date and time that the updated identity source was originally created.

    • identitySourceId — (String)

      The ID of the updated identity source.

    • lastUpdatedDate — (Date)

      The date and time that the identity source was most recently updated.

    • policyStoreId — (String)

      The ID of the policy store that contains the updated identity source.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  definition: { /* required */
    static: {
      statement: 'STRING_VALUE', /* required */
      description: 'STRING_VALUE'
    }
  },
  policyId: 'STRING_VALUE', /* required */
  policyStoreId: 'STRING_VALUE' /* required */
};
verifiedpermissions.updatePolicy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • policyStoreId — (String)

    Specifies the ID of the policy store that contains the policy that you want to update.

  • policyId — (String)

    Specifies the ID of the policy that you want to update. To find this value, you can use ListPolicies.

  • definition — (map)

    Specifies the updated policy content that you want to replace on the specified policy. The content must be valid Cedar policy language text.

    You can change only the following elements from the policy definition:

    • The action referenced by the policy.

    • Any conditional clauses, such as when or unless clauses.

    You can't change the following elements:

    • Changing from static to templateLinked.

    • Changing the effect of the policy from permit or forbid.

    • The principal referenced by the policy.

    • The resource referenced by the policy.

    • static — (map)

      Contains details about the updates to be applied to a static policy.

      • description — (String)

        Specifies the description to be added to or replaced on the static policy.

      • statement — required — (String)

        Specifies the Cedar policy language text to be added to or replaced on the static policy.

        You can change only the following elements from the original content:

        • The action referenced by the policy.

        • Any conditional clauses, such as when or unless clauses.

        You can't change the following elements:

        • Changing from StaticPolicy to TemplateLinkedPolicy.

        • The effect (permit or forbid) of the policy.

        • The principal referenced by the policy.

        • The resource referenced by the policy.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • policyStoreId — (String)

      The ID of the policy store that contains the policy that was updated.

    • policyId — (String)

      The ID of the policy that was updated.

    • policyType — (String)

      The type of the policy that was updated.

      Possible values include:
      • "STATIC"
      • "TEMPLATE_LINKED"
    • principal — (map)

      The principal specified in the policy's scope. This element isn't included in the response when Principal isn't present in the policy content.

      • entityType — required — (String)

        The type of an entity.

        Example: "entityType":"typeName"

      • entityId — required — (String)

        The identifier of an entity.

        "entityId":"identifier"

    • resource — (map)

      The resource specified in the policy's scope. This element isn't included in the response when Resource isn't present in the policy content.

      • entityType — required — (String)

        The type of an entity.

        Example: "entityType":"typeName"

      • entityId — required — (String)

        The identifier of an entity.

        "entityId":"identifier"

    • actions — (Array<map>)

      The action that a policy permits or forbids. For example, {"actions": [{"actionId": "ViewPhoto", "actionType": "PhotoFlash::Action"}, {"entityID": "SharePhoto", "entityType": "PhotoFlash::Action"}]}.

      • actionType — required — (String)

        The type of an action.

      • actionId — required — (String)

        The ID of an action.

    • createdDate — (Date)

      The date and time that the policy was originally created.

    • lastUpdatedDate — (Date)

      The date and time that the policy was most recently updated.

    • effect — (String)

      The effect of the decision that a policy returns to an authorization request. For example, "effect": "Permit".

      Possible values include:
      • "Permit"
      • "Forbid"

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  policyStoreId: 'STRING_VALUE', /* required */
  validationSettings: { /* required */
    mode: OFF | STRICT /* required */
  },
  description: 'STRING_VALUE'
};
verifiedpermissions.updatePolicyStore(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • policyStoreId — (String)

    Specifies the ID of the policy store that you want to update

  • validationSettings — (map)

    A structure that defines the validation settings that want to enable for the policy store.

    • mode — required — (String)

      The validation mode currently configured for this policy store. The valid values are:

      • OFF – Neither Verified Permissions nor Cedar perform any validation on policies. No validation errors are reported by either service.

      • STRICT – Requires a schema to be present in the policy store. Cedar performs validation on all submitted new or updated static policies and policy templates. Any that fail validation are rejected and Cedar doesn't store them in the policy store.

      If Mode=STRICT and the policy store doesn't contain a schema, Verified Permissions rejects all static policies and policy templates because there is no schema to validate against.

      To submit a static policy or policy template without a schema, you must turn off validation.

      Possible values include:
      • "OFF"
      • "STRICT"
  • description — (String)

    Descriptive text that you can provide to help with identification of the current policy store.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • policyStoreId — (String)

      The ID of the updated policy store.

    • arn — (String)

      The Amazon Resource Name (ARN) of the updated policy store.

    • createdDate — (Date)

      The date and time that the policy store was originally created.

    • lastUpdatedDate — (Date)

      The date and time that the policy store was most recently updated.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  policyStoreId: 'STRING_VALUE', /* required */
  policyTemplateId: 'STRING_VALUE', /* required */
  statement: 'STRING_VALUE', /* required */
  description: 'STRING_VALUE'
};
verifiedpermissions.updatePolicyTemplate(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • policyStoreId — (String)

    Specifies the ID of the policy store that contains the policy template that you want to update.

  • policyTemplateId — (String)

    Specifies the ID of the policy template that you want to update.

  • description — (String)

    Specifies a new description to apply to the policy template.

  • statement — (String)

    Specifies new statement content written in Cedar policy language to replace the current body of the policy template.

    You can change only the following elements of the policy body:

    • The action referenced by the policy template.

    • Any conditional clauses, such as when or unless clauses.

    You can't change the following elements:

    • The effect (permit or forbid) of the policy template.

    • The principal referenced by the policy template.

    • The resource referenced by the policy template.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • policyStoreId — (String)

      The ID of the policy store that contains the updated policy template.

    • policyTemplateId — (String)

      The ID of the updated policy template.

    • createdDate — (Date)

      The date and time that the policy template was originally created.

    • lastUpdatedDate — (Date)

      The date and time that the policy template was most recently updated.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

Parameters:

• state (String) —

  the resource state to wait for. Available states for this service are listed in "Waiter Resource States" below.

• params (map) (defaults to: {}) —

  a list of parameters for the given state. See each waiter resource state for required parameters.

Callback (callback):

• function(err, data) { ... }

  Callback containing error and data information. See the respective resource state for the expected error or data information.

  If the waiter times out its requests, it will return a ResourceNotReady error.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.