AWS SDK for JavaScript Sso Admin Client for Node.js, Browser and React Native
npm install @aws-sdk/client-sso-adminAWS SDK for JavaScript SSOAdmin Client for Node.js, Browser and React Native.
IAM Identity Center is the Amazon Web Services solution for connecting your workforce users to Amazon Web Services managed applications and other Amazon Web Services resources. You can connect your existing identity provider and synchronize users and groups from your directory, or create and manage your users directly in IAM Identity Center. You can then use IAM Identity Center for either or both of the following:
User access to applications
User access to Amazon Web Services accounts
This guide provides information about single sign-on operations that you can use for access to applications and Amazon Web Services accounts. For information about IAM Identity Center features, see the IAM Identity Center User Guide.
IAM Identity Center uses the sso and identitystore API namespaces.
Many API operations for IAM Identity Center rely on identifiers for users and groups, known as principals. For more information about how to work with principals and principal IDs in IAM Identity Center, see the Identity Store API Reference.
Amazon Web Services provides SDKs that consist of libraries and sample code for various programming languages and platforms (Java, Ruby, .Net, iOS, Android, and more). The SDKs provide a convenient way to create programmatic access to IAM Identity Center and other Amazon Web Services services. For more information about the Amazon Web Services SDKs, including how to download and install them, see Tools for Amazon Web Services.
npm install @aws-sdk/client-sso-adminyarn add @aws-sdk/client-sso-adminpnpm add @aws-sdk/client-sso-adminThe AWS SDK is modulized by clients and commands.
To send a request, you only need to import the SSOAdminClient and
the commands you need, for example ListInstancesCommand:
``js`
// ES5 example
const { SSOAdminClient, ListInstancesCommand } = require("@aws-sdk/client-sso-admin");
`ts`
// ES6+ example
import { SSOAdminClient, ListInstancesCommand } from "@aws-sdk/client-sso-admin";
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.destroy()
- If you are using a custom http handler, you may call to close open connections.
`js
// a client can be shared by different commands.
const client = new SSOAdminClient({ region: "REGION" });
const params = { /* input parameters / };
const command = new ListInstancesCommand(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-sso-admin";
const client = new AWS.SSOAdmin({ region: "REGION" });
// async/await.
try {
const data = await client.listInstances(params);
// process data.
} catch (error) {
// error handling.
}
// Promises.
client
.listInstances(params)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
});
// callbacks.
client.listInstances(params, (err, data) => {
// process err and data.
});
`
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;
* }
*/
}
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.
This client code is generated automatically. Any modifications will be overwritten the next time the @aws-sdk/client-sso-admin` package is updated.
To contribute to client you can check our generate clients scripts.
This SDK is distributed under the
Apache License, Version 2.0,
see LICENSE for more information.
AddRegion
Command API Reference / Input / Output
AttachCustomerManagedPolicyReferenceToPermissionSet
Command API Reference / Input / Output
AttachManagedPolicyToPermissionSet
Command API Reference / Input / Output
CreateAccountAssignment
Command API Reference / Input / Output
CreateApplication
Command API Reference / Input / Output
CreateApplicationAssignment
Command API Reference / Input / Output
CreateInstance
Command API Reference / Input / Output
CreateInstanceAccessControlAttributeConfiguration
Command API Reference / Input / Output
CreatePermissionSet
Command API Reference / Input / Output
CreateTrustedTokenIssuer
Command API Reference / Input / Output
DeleteAccountAssignment
Command API Reference / Input / Output
DeleteApplication
Command API Reference / Input / Output
DeleteApplicationAccessScope
Command API Reference / Input / Output
DeleteApplicationAssignment
Command API Reference / Input / Output
DeleteApplicationAuthenticationMethod
Command API Reference / Input / Output
DeleteApplicationGrant
Command API Reference / Input / Output
DeleteInlinePolicyFromPermissionSet
Command API Reference / Input / Output
DeleteInstance
Command API Reference / Input / Output
DeleteInstanceAccessControlAttributeConfiguration
Command API Reference / Input / Output
DeletePermissionsBoundaryFromPermissionSet
Command API Reference / Input / Output
DeletePermissionSet
Command API Reference / Input / Output
DeleteTrustedTokenIssuer
Command API Reference / Input / Output
DescribeAccountAssignmentCreationStatus
Command API Reference / Input / Output
DescribeAccountAssignmentDeletionStatus
Command API Reference / Input / Output
DescribeApplication
Command API Reference / Input / Output
DescribeApplicationAssignment
Command API Reference / Input / Output
DescribeApplicationProvider
Command API Reference / Input / Output
DescribeInstance
Command API Reference / Input / Output
DescribeInstanceAccessControlAttributeConfiguration
Command API Reference / Input / Output
DescribePermissionSet
Command API Reference / Input / Output
DescribePermissionSetProvisioningStatus
Command API Reference / Input / Output
DescribeRegion
Command API Reference / Input / Output
DescribeTrustedTokenIssuer
Command API Reference / Input / Output
DetachCustomerManagedPolicyReferenceFromPermissionSet
Command API Reference / Input / Output
DetachManagedPolicyFromPermissionSet
Command API Reference / Input / Output
GetApplicationAccessScope
Command API Reference / Input / Output
GetApplicationAssignmentConfiguration
Command API Reference / Input / Output
GetApplicationAuthenticationMethod
Command API Reference / Input / Output
GetApplicationGrant
Command API Reference / Input / Output
GetApplicationSessionConfiguration
Command API Reference / Input / Output
GetInlinePolicyForPermissionSet
Command API Reference / Input / Output
GetPermissionsBoundaryForPermissionSet
Command API Reference / Input / Output
ListAccountAssignmentCreationStatus
Command API Reference / Input / Output
ListAccountAssignmentDeletionStatus
Command API Reference / Input / Output
ListAccountAssignments
Command API Reference / Input / Output
ListAccountAssignmentsForPrincipal
Command API Reference / Input / Output
ListAccountsForProvisionedPermissionSet
Command API Reference / Input / Output
ListApplicationAccessScopes
Command API Reference / Input / Output
ListApplicationAssignments
Command API Reference / Input / Output
ListApplicationAssignmentsForPrincipal
Command API Reference / Input / Output
ListApplicationAuthenticationMethods
Command API Reference / Input / Output
ListApplicationGrants
Command API Reference / Input / Output
ListApplicationProviders
Command API Reference / Input / Output
ListApplications
Command API Reference / Input / Output
ListCustomerManagedPolicyReferencesInPermissionSet
Command API Reference / Input / Output
ListInstances
Command API Reference / Input / Output
ListManagedPoliciesInPermissionSet
Command API Reference / Input / Output
ListPermissionSetProvisioningStatus
Command API Reference / Input / Output
ListPermissionSets
Command API Reference / Input / Output
ListPermissionSetsProvisionedToAccount
Command API Reference / Input / Output
ListRegions
Command API Reference / Input / Output
ListTagsForResource
Command API Reference / Input / Output
ListTrustedTokenIssuers
Command API Reference / Input / Output
ProvisionPermissionSet
Command API Reference / Input / Output
PutApplicationAccessScope
Command API Reference / Input / Output
PutApplicationAssignmentConfiguration
Command API Reference / Input / Output
PutApplicationAuthenticationMethod
Command API Reference / Input / Output
PutApplicationGrant
Command API Reference / Input / Output
PutApplicationSessionConfiguration
Command API Reference / Input / Output
PutInlinePolicyToPermissionSet
Command API Reference / Input / Output
PutPermissionsBoundaryToPermissionSet
Command API Reference / Input / Output
RemoveRegion
Command API Reference / Input / Output
TagResource
Command API Reference / Input / Output
UntagResource
Command API Reference / Input / Output
UpdateApplication
Command API Reference / Input / Output
UpdateInstance
Command API Reference / Input / Output
UpdateInstanceAccessControlAttributeConfiguration
Command API Reference / Input / Output
UpdatePermissionSet
Command API Reference / Input / Output
UpdateTrustedTokenIssuer