Skip to content

AWS Single Sign-On Admin API

by amazonaws.com

API keyHTTPSCloud Platforms
Open documentation ↗

Overview

<p>AWS IAM Identity Center (successor to AWS Single Sign-On) helps you securely create, or connect, your workforce identities and manage their access centrally across AWS accounts and applications. IAM Identity Center is the recommended approach for workforce authentication and authorization in AWS, for organizations of any size and type.</p> <note> <p>Although AWS Single Sign-On was renamed, the <code>sso</code> and <code>identitystore</code> API namespaces will continue to retain their original name for backward compatibility purposes. For more information, see <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html#renamed">IAM Identity Center rename</a>.</p> </note> <p>This reference guide provides information on single sign-on operations which could be used for access management of AWS accounts. For information about IAM Identity Center features, see the <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html">IAM Identity Center User Guide</a>.</p> <p>Many operations in the IAM Identity Center APIs 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 <a href="https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/welcome.html">Identity Store API Reference</a>.</p> <note> <p>AWS 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 AWS services. For more information about the AWS SDKs, including how to download and install them, see <a href="http://aws.amazon.com/tools/">Tools for Amazon Web Services</a>.</p> </note>

AWS Single Sign-On Admin is a cloud platforms API from amazonaws.com. Requests are authenticated with an API key. It is served over HTTPS. Its OpenAPI description documents 37 endpoints.

At a glance

Authentication
API key
HTTPS
Yes
CORS
Unknown
Version
2020-07-20
Endpoints
37
Spec updated
2021-01-15

Endpoints

MethodPathWhat it does
POST/#X-Amz-Target=SWBExternalService.AttachCustomerManagedPolicyReferenceToPermissionSetAttaches the specified customer managed policy to the specified <a>PermissionSet</a>.
POST/#X-Amz-Target=SWBExternalService.AttachManagedPolicyToPermissionSet<p>Attaches an AWS managed policy ARN to a permission set.</p> <note> <p>If the permission set is already referenced by one or more account assignments, you wil
POST/#X-Amz-Target=SWBExternalService.CreateAccountAssignment<p>Assigns access to a principal for a specified AWS account using a specified permission set.</p> <note> <p>The term <i>principal</i> here refers to a user or
POST/#X-Amz-Target=SWBExternalService.CreateInstanceAccessControlAttributeConfiguration<p>Enables the attributes-based access control (ABAC) feature for the specified IAM Identity Center instance. You can also specify new attributes to add to your
POST/#X-Amz-Target=SWBExternalService.CreatePermissionSet<p>Creates a permission set within a specified IAM Identity Center instance.</p> <note> <p>To grant users and groups access to AWS account resources, use <code>
POST/#X-Amz-Target=SWBExternalService.DeleteAccountAssignment<p>Deletes a principal's access from a specified AWS account using a specified permission set.</p> <note> <p>After a successful response, call <code>DescribeAcc
POST/#X-Amz-Target=SWBExternalService.DeleteInlinePolicyFromPermissionSetDeletes the inline policy from a specified permission set.
POST/#X-Amz-Target=SWBExternalService.DeleteInstanceAccessControlAttributeConfigurationDisables the attributes-based access control (ABAC) feature for the specified IAM Identity Center instance and deletes all of the attribute mappings that have b
POST/#X-Amz-Target=SWBExternalService.DeletePermissionSetDeletes the specified permission set.
POST/#X-Amz-Target=SWBExternalService.DeletePermissionsBoundaryFromPermissionSetDeletes the permissions boundary from a specified <a>PermissionSet</a>.
POST/#X-Amz-Target=SWBExternalService.DescribeAccountAssignmentCreationStatusDescribes the status of the assignment creation request.
POST/#X-Amz-Target=SWBExternalService.DescribeAccountAssignmentDeletionStatusDescribes the status of the assignment deletion request.
POST/#X-Amz-Target=SWBExternalService.DescribeInstanceAccessControlAttributeConfigurationReturns the list of IAM Identity Center identity store attributes that have been configured to work with attributes-based access control (ABAC) for the specifie
POST/#X-Amz-Target=SWBExternalService.DescribePermissionSetGets the details of the permission set.
POST/#X-Amz-Target=SWBExternalService.DescribePermissionSetProvisioningStatusDescribes the status for the given permission set provisioning request.
POST/#X-Amz-Target=SWBExternalService.DetachCustomerManagedPolicyReferenceFromPermissionSetDetaches the specified customer managed policy from the specified <a>PermissionSet</a>.
POST/#X-Amz-Target=SWBExternalService.DetachManagedPolicyFromPermissionSetDetaches the attached AWS managed policy ARN from the specified permission set.
POST/#X-Amz-Target=SWBExternalService.GetInlinePolicyForPermissionSetObtains the inline policy assigned to the permission set.
POST/#X-Amz-Target=SWBExternalService.GetPermissionsBoundaryForPermissionSetObtains the permissions boundary for a specified <a>PermissionSet</a>.
POST/#X-Amz-Target=SWBExternalService.ListAccountAssignmentCreationStatusLists the status of the AWS account assignment creation requests for a specified IAM Identity Center instance.
POST/#X-Amz-Target=SWBExternalService.ListAccountAssignmentDeletionStatusLists the status of the AWS account assignment deletion requests for a specified IAM Identity Center instance.
POST/#X-Amz-Target=SWBExternalService.ListAccountAssignmentsLists the assignee of the specified AWS account with the specified permission set.
POST/#X-Amz-Target=SWBExternalService.ListAccountsForProvisionedPermissionSetLists all the AWS accounts where the specified permission set is provisioned.
POST/#X-Amz-Target=SWBExternalService.ListCustomerManagedPolicyReferencesInPermissionSetLists all customer managed policies attached to a specified <a>PermissionSet</a>.
POST/#X-Amz-Target=SWBExternalService.ListInstancesLists the IAM Identity Center instances that the caller has access to.
POST/#X-Amz-Target=SWBExternalService.ListManagedPoliciesInPermissionSetLists the AWS managed policy that is attached to a specified permission set.
POST/#X-Amz-Target=SWBExternalService.ListPermissionSetProvisioningStatusLists the status of the permission set provisioning requests for a specified IAM Identity Center instance.
POST/#X-Amz-Target=SWBExternalService.ListPermissionSetsLists the <a>PermissionSet</a>s in an IAM Identity Center instance.
POST/#X-Amz-Target=SWBExternalService.ListPermissionSetsProvisionedToAccountLists all the permission sets that are provisioned to a specified AWS account.
POST/#X-Amz-Target=SWBExternalService.ListTagsForResourceLists the tags that are attached to a specified resource.
POST/#X-Amz-Target=SWBExternalService.ProvisionPermissionSetThe process by which a specified permission set is provisioned to the specified target.
POST/#X-Amz-Target=SWBExternalService.PutInlinePolicyToPermissionSet<p>Attaches an inline policy to a permission set.</p> <note> <p>If the permission set is already referenced by one or more account assignments, you will need to
POST/#X-Amz-Target=SWBExternalService.PutPermissionsBoundaryToPermissionSetAttaches an AWS managed or customer managed policy to the specified <a>PermissionSet</a> as a permissions boundary.
POST/#X-Amz-Target=SWBExternalService.TagResourceAssociates a set of tags with a specified resource.
POST/#X-Amz-Target=SWBExternalService.UntagResourceDisassociates a set of tags from a specified resource.
POST/#X-Amz-Target=SWBExternalService.UpdateInstanceAccessControlAttributeConfigurationUpdates the IAM Identity Center identity store attributes that you can use with the IAM Identity Center instance for attributes-based access control (ABAC). Whe
POST/#X-Amz-Target=SWBExternalService.UpdatePermissionSetUpdates an existing permission set.

Questions

Does the AWS Single Sign-On Admin API need an API key?

Yes. The AWS Single Sign-On Admin API uses API key authentication; the documentation explains how to get credentials.

Does the AWS Single Sign-On Admin API support HTTPS?

Yes, the AWS Single Sign-On Admin API is served over HTTPS.

How many endpoints does the AWS Single Sign-On Admin API have?

Its OpenAPI description lists 37 endpoints in version 2020-07-20. All of them are shown on this page.

What are alternatives to the AWS Single Sign-On Admin API?

Other Cloud Platforms APIs include Remote Settings PROD, Linode API, DigitalOcean API, Vercel API, Platform API.

Compare alternatives →

Remote Settings PROD

Cloud Platforms

Firefox is a free web browser backed by Mozilla, a non-profit dedicated to internet health and privacy.

No auth19 endpoints

Linode API

Cloud Platforms

## Introduction The Linode API provides the ability to programmatically manage the full range of Linode products and services. This reference is designed to assist application developers and system administrators. Each endpoint includes descriptions, request syntax, and examples using standard HTTP requests. Response data is returned in JSON format. This document was generated from our OpenAPI Specification. See the <a target="_top" href="https://www.openapis.org">OpenAPI website</a> for more information. <a target="_top" href="/docs/api/openapi.yaml">Download the Linode OpenAPI Specification</a>. ## Changelog <a target="_top" href="/docs/products/tools/api/release-notes/">View our Changelog</a> to see release notes on all changes made to our API. ## Access and Authentication Some endpoints are publicly accessible without requiring authentication. All endpoints affecting your Account, however, require either a Personal Access Token or OAuth authentication (when using third-party applications). ### Personal Access Token The easiest way to access the API is with a Personal Access Token (PAT) generated from the <a target="_top" href="https://cloud.linode.com/profile/tokens">Linode Cloud Manager</a> or the [Create Personal Access Token](/docs/api/profile/#personal-access-token-create) endpoint. All scopes for the OAuth security model ([defined below](/docs/api/profile/#oauth)) apply to this security model as well. #### Authentication | Security Scheme Type: | HTTP | |-----------------------|------| | **HTTP Authorization Scheme** | bearer | ### OAuth If you only need to access the Linode API for personal use, we recommend that you create a [personal access token](/docs/api/#personal-access-token). If you're designing an application that can authenticate with an arbitrary Linode user, then you should use the OAuth 2.0 workflows presented in this section. For a more detailed example of an OAuth 2.0 implementation, see our guide on [How to Create an OAuth App with the Linode Python API Library](/docs/products/tools/api/guides/create-an-oauth-app-with-the-python-api-library/#oauth-2-authentication-exchange). Before you implement OAuth in your application, you first need to create an OAuth client. You can do this [with the Linode API](/docs/api/account/#oauth-client-create) or [via the Cloud Manager](https://cloud.linode.com/profile/clients): - When creating the client, you'll supply a `label` and a `redirect_uri` (referred to as the Callback URL in the Cloud Manager). - The response from this endpoint will give you a `client_id` and a `secret`. - Clients can be public or private, and are private by default. You can choose to make the client public when it is created. - A private client is used with applications which can securely store the client secret (that is, the secret returned to you when you first created the client). For example, an application running on a secured server that only the developer has access to would use a private OAuth client. This is also called a confidential client in some OAuth documentation. - A public client is used with applications where the client secret is not guaranteed to be secure. For example, a native app running on a user's computer may not be able to keep the client secret safe, as a user could potentially inspect the source of the application. So, native apps or apps that run in a user's browser should use a public client. - Public and private clients follow different workflows, as described below. #### OAuth Workflow The OAuth workflow is a series of exchanges between your third-party app and Linode. The workflow is used to authenticate a user before an application can start making API calls on the user's behalf. Notes: - With respect to the diagram in [section 1.2 of RFC 6749](https://tools.ietf.org/html/rfc6749#section-1.2), login.linode.com (referred to in this section as the *login server*) is the Resource Owner and the Authorization Server; api.linode.com (referred to here as the *api se

Bearer token350 endpoints

DigitalOcean API

Cloud Platforms

# Introduction The DigitalOcean API allows you to manage Droplets and resources within the DigitalOcean cloud in a simple, programmatic way using conventional HTTP requests. All of the functionality that you are familiar with in the DigitalOcean control panel is also available through the API, allowing you to script the complex actions that your situation requires. The API documentation will start with a general overview about the design and technology that has been implemented, followed by reference information about specific endpoints. ## Requests Any tool that is fluent in HTTP can communicate with the API simply by requesting the correct URI. Requests should be made using the HTTPS protocol so that traffic is encrypted. The interface responds to different methods depending on the action required. |Method|Usage| |--- |--- | |GET|For simple retrieval of information about your account, Droplets, or environment, you should use the GET method. The information you request will be returned to you as a JSON object. The attributes defined by the JSON object can be used to form additional requests. Any request using the GET method is read-only and will not affect any of the objects you are querying.| |DELETE|To destroy a resource and remove it from your account and environment, the DELETE method should be used. This will remove the specified object if it is found. If it is not found, the operation will return a response indicating that the object was not found. This idempotency means that you do not have to check for a resource's availability prior to issuing a delete command, the final state will be the same regardless of its existence.| |PUT|To update the information about a resource in your account, the PUT method is available. Like the DELETE Method, the PUT method is idempotent. It sets the state of the target using the provided values, regardless of their current values. Requests using the PUT method do not need to check the current attributes of the object.| |PATCH|Some resources support partial modification. In these cases, the PATCH method is available. Unlike PUT which generally requires a complete representation of a resource, a PATCH request is is a set of instructions on how to modify a resource updating only specific attributes.| |POST|To create a new object, your request should specify the POST method. The POST request includes all of the attributes necessary to create a new object. When you wish to create a new object, send a POST request to the target endpoint.| |HEAD|Finally, to retrieve metadata information, you should use the HEAD method to get the headers. This returns only the header of what would be returned with an associated GET request. Response headers contain some useful information about your API access and the results that are available for your request. For instance, the headers contain your current rate-limit value and the amount of time available until the limit resets. It also contains metrics about the total number of objects found, pagination information, and the total content length.| ## HTTP Statuses Along with the HTTP methods that the API responds to, it will also return standard HTTP statuses, including error codes. In the event of a problem, the status will contain the error code, while the body of the response will usually contain additional information about the problem that was encountered. In general, if the status returned is in the 200 range, it indicates that the request was fulfilled successfully and that no error was encountered. Return codes in the 400 range typically indicate that there was an issue with the request that was sent. Among other things, this could mean that you did not authenticate correctly, that you are requesting an action that you do not have authorization for, that the object you are requesting does not exist, or that your request is malformed. If you receive a status in the 500 range, this generally indicates a server-side problem. This means that we are having

Bearer token290 endpoints

Vercel API

Cloud Platforms

Vercel combines the best developer experience with an obsessive focus on end-user performance. Our platform enables frontend teams to do their best work.

Bearer token112 endpoints

Platform API

Cloud Platforms

The [REST API specification](https://www.ably.io/documentation/rest-api) for Ably.

HTTP Basic22 endpoints

Azure Data Lake Storage

Cloud Platforms

Azure Data Lake Storage provides storage for Hadoop and other big data workloads.

No auth10 endpoints

Listed from APIs.guru (CC0).