@aws-sdk/client-verifiedpermissions

Description

AWS SDK for JavaScript VerifiedPermissions Client for Node.js, Browser and React Native.

Amazon Verified Permissions is a permissions management service from Amazon Web Services. You can use Verified Permissions to manage permissions for your application, and authorize user access based on those permissions. Using Verified Permissions, application developers can grant access based on information about the users, resources, and requested actions. You can also evaluate additional information like group membership, attributes of the resources, and session context, such as time of request and IP addresses. Verified Permissions manages these permissions by letting you create and store authorization policies for your applications, such as consumer-facing web sites and enterprise business systems.

Verified Permissions uses Cedar as the policy language to express your permission requirements. Cedar supports both role-based access control (RBAC) and attribute-based access control (ABAC) authorization models.

For more information about configuring, administering, and using Amazon Verified Permissions in your applications, see the Amazon Verified Permissions User Guide.

For more information about the Cedar policy language, see the Cedar Policy Language Guide.

When you write Cedar policies that reference principals, resources and actions, you can define the unique identifiers used for each of those elements. We strongly recommend that you follow these best practices:

• Use values like universally unique identifiers (UUIDs) for all principal and resource identifiers.

  For example, if user jane leaves the company, and you later let someone else use the name jane, then that new user automatically gets access to everything granted by policies that still reference User::"jane". Cedar can’t distinguish between the new user and the old. This applies to both principal and resource identifiers. Always use identifiers that are guaranteed unique and never reused to ensure that you don’t unintentionally grant access because of the presence of an old identifier in a policy.

  Where you use a UUID for an entity, we recommend that you follow it with the // comment specifier and the ‘friendly’ name of your entity. This helps to make your policies easier to understand. For example: principal == User::"a1b2c3d4-e5f6-a1b2-c3d4-EXAMPLE11111", // alice

• Do not include personally identifying, confidential, or sensitive information as part of the unique identifier for your principals or resources. These identifiers are included in log entries shared in CloudTrail trails.

Several operations return structures that appear similar, but have different purposes. As new functionality is added to the product, the structure used in a parameter of one operation might need to change in a way that wouldn't make sense for the same parameter in a different operation. To help you understand the purpose of each, the following naming convention is used for the structures:

• Parameter type structures that end in Detail are used in Get operations.

• Parameter type structures that end in Item are used in List operations.

• Parameter type structures that use neither suffix are used in the mutating (create and update) operations.

Installing

To install this package, simply type add or install @aws-sdk/client-verifiedpermissions
using your favorite package manager:
- npm install @aws-sdk/client-verifiedpermissions
- yarn add @aws-sdk/client-verifiedpermissions
- pnpm add @aws-sdk/client-verifiedpermissions

Getting Started

$3

The AWS SDK is modulized by clients and commands.
To send a request, you only need to import the VerifiedPermissionsClient and
the commands you need, for example ListPolicyStoresCommand:

``js
// ES5 example
const { VerifiedPermissionsClient, ListPolicyStoresCommand } = require("@aws-sdk/client-verifiedpermissions");
`

`ts
// ES6+ example
import { VerifiedPermissionsClient, ListPolicyStoresCommand } from "@aws-sdk/client-verifiedpermissions";
`

$3

To send a request, you:

- Initiate client with configuration (e.g. credentials, region).
- Initiate command with input parameters.
- Call send operation on client with command object as input.
- If you are using a custom http handler, you may call destroy() to close open connections.

`js
// a client can be shared by different commands.
const client = new VerifiedPermissionsClient({ region: "REGION" });

const params = { /* input parameters / };
const command = new ListPolicyStoresCommand(params);
`

#### Async/await

We recommend using await
operator to wait for the promise returned by send operation as follows:

`js
// async/await.
try {
const data = await client.send(command);
// process data.
} catch (error) {
// error handling.
} finally {
// finally.
}
`

Async-await is clean, concise, intuitive, easy to debug and has better error handling
as compared to using Promise chains or callbacks.

#### Promises

You can also use Promise chaining
to execute send operation.

`js
client.send(command).then(
(data) => {
// process data.
},
(error) => {
// error handling.
}
);
`

Promises can also be called using .catch() and .finally() as follows:

`js
client
.send(command)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
})
.finally(() => {
// finally.
});
`

#### Callbacks

We do not recommend using callbacks because of callback hell,
but they are supported by the send operation.

`js
// callbacks.
client.send(command, (err, data) => {
// process err and data.
});
`

#### v2 compatible style

The client can also send requests using v2 compatible style.
However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post
on modular packages in AWS SDK for JavaScript

`ts
import * as AWS from "@aws-sdk/client-verifiedpermissions";
const client = new AWS.VerifiedPermissions({ region: "REGION" });

// async/await.
try {
const data = await client.listPolicyStores(params);
// process data.
} catch (error) {
// error handling.
}

// Promises.
client
.listPolicyStores(params)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
});

// callbacks.
client.listPolicyStores(params, (err, data) => {
// process err and data.
});
`

$3

When the service returns an exception, the error will include the exception information,
as well as response metadata (e.g. request id).

`js
try {
const data = await client.send(command);
// process data.
} catch (error) {
const { requestId, cfId, extendedRequestId } = error.$metadata;
console.log({ requestId, cfId, extendedRequestId });
/**
* The keys within exceptions are also parsed.
* You can access them by specifying exception names:
* if (error.name === 'SomeServiceException') {
* const value = error.specialKeyInException;
* }
*/
}
`

Getting Help

Please use these community resources for getting help.
We use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.

- Visit Developer Guide
or API Reference.
- Check out the blog posts tagged with aws-sdk-js
on AWS Developer Blog.
- Ask a question on StackOverflow and tag it with aws-sdk-js.
- Join the AWS JavaScript community on gitter.
- If it turns out that you may have found a bug, please open an issue.

To test your universal JavaScript code in Node.js, browser and react-native environments,
visit our code samples repo.

Contributing

This client code is generated automatically. Any modifications will be overwritten the next time the @aws-sdk/client-verifiedpermissions` package is updated.
To contribute to client you can check our generate clients scripts.

License

This SDK is distributed under the
Apache License, Version 2.0,
see LICENSE for more information.

Client Commands (Operations List)

BatchGetPolicy

Command API Reference / Input / Output

BatchIsAuthorized

Command API Reference / Input / Output

BatchIsAuthorizedWithToken

Command API Reference / Input / Output

CreateIdentitySource

Command API Reference / Input / Output

CreatePolicy

Command API Reference / Input / Output

CreatePolicyStore

Command API Reference / Input / Output

CreatePolicyTemplate

Command API Reference / Input / Output

DeleteIdentitySource

Command API Reference / Input / Output

DeletePolicy

Command API Reference / Input / Output

DeletePolicyStore

Command API Reference / Input / Output

DeletePolicyTemplate

Command API Reference / Input / Output

GetIdentitySource

Command API Reference / Input / Output

GetPolicy

Command API Reference / Input / Output

GetPolicyStore

Command API Reference / Input / Output

GetPolicyTemplate

Command API Reference / Input / Output

GetSchema

Command API Reference / Input / Output

IsAuthorized

Command API Reference / Input / Output

IsAuthorizedWithToken

Command API Reference / Input / Output

ListIdentitySources

Command API Reference / Input / Output

ListPolicies

Command API Reference / Input / Output

ListPolicyStores

Command API Reference / Input / Output

ListPolicyTemplates

Command API Reference / Input / Output

ListTagsForResource

Command API Reference / Input / Output

PutSchema

Command API Reference / Input / Output

TagResource

Command API Reference / Input / Output

UntagResource

Command API Reference / Input / Output

UpdateIdentitySource

Command API Reference / Input / Output

UpdatePolicy

Command API Reference / Input / Output

UpdatePolicyStore

Command API Reference / Input / Output

UpdatePolicyTemplate

Command API Reference / Input / Output