amazonaws.com – sso-admin
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.
Although AWS Single Sign-On was renamed, the sso and identitystore API namespaces will continue to retain their original name for backward compatibility purposes. For more information, see .
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 .
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 .
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 .
- Homepage
- https://api.apis.guru/v2/specs/amazonaws.com:sso-admin/2020-07-20.json
- Provider
- amazonaws.com:sso-admin / sso-admin
- OpenAPI version
- 3.0.0
- Spec (JSON)
- https://api.apis.guru/v2/specs/amazonaws.com/sso-admin/2020-07-20/openapi.json
- Spec (YAML)
- https://api.apis.guru/v2/specs/amazonaws.com/sso-admin/2020-07-20/openapi.yaml
Tools (39)
Extracted live via the executor SDK.
-
xAmzTargetSwbExternalServiceAttachCustomerManagedPolicyReferenceToPermissionSet.attachCustomerManagedPolicyReferenceToPermissionSetAttaches the specified customer managed policy to the specified PermissionSet [blocked].
-
xAmzTargetSwbExternalServiceAttachManagedPolicyToPermissionSet.attachManagedPolicyToPermissionSetAttaches an AWS managed policy ARN to a permission set.
If the permission set is already referenced by one or more account assignments, you will need to call
ProvisionPermissionSet [blocked]after this operation. CallingProvisionPermissionSetapplies the corresponding IAM policy updates to all assigned accounts. -
xAmzTargetSwbExternalServiceCreateAccountAssignment.createAccountAssignmentAssigns access to a principal for a specified AWS account using a specified permission set.
The term principal here refers to a user or group that is defined in IAM Identity Center.
As part of a successful
CreateAccountAssignmentcall, the specified permission set will automatically be provisioned to the account in the form of an IAM policy. That policy is attached to the IAM role created in IAM Identity Center. If the permission set is subsequently updated, the corresponding IAM policies attached to roles in your accounts will not be updated automatically. In this case, you must callProvisionPermissionSet [blocked]to make these updates.After a successful response, call
DescribeAccountAssignmentCreationStatusto describe the status of an assignment creation request. -
xAmzTargetSwbExternalServiceCreateInstanceAccessControlAttributeConfiguration.createInstanceAccessControlAttributeConfigurationEnables the attributes-based access control (ABAC) feature for the specified IAM Identity Center instance. You can also specify new attributes to add to your ABAC configuration during the enabling process. For more information about ABAC, see in the IAM Identity Center User Guide.
After a successful response, call
DescribeInstanceAccessControlAttributeConfigurationto validate thatInstanceAccessControlAttributeConfigurationwas created. -
xAmzTargetSwbExternalServiceCreatePermissionSet.createPermissionSetCreates a permission set within a specified IAM Identity Center instance.
To grant users and groups access to AWS account resources, use
CreateAccountAssignment [blocked]. -
xAmzTargetSwbExternalServiceDeleteAccountAssignment.deleteAccountAssignmentDeletes a principal's access from a specified AWS account using a specified permission set.
After a successful response, call
DescribeAccountAssignmentCreationStatusto describe the status of an assignment deletion request. -
xAmzTargetSwbExternalServiceDeleteInlinePolicyFromPermissionSet.deleteInlinePolicyFromPermissionSetDeletes the inline policy from a specified permission set.
-
xAmzTargetSwbExternalServiceDeleteInstanceAccessControlAttributeConfiguration.deleteInstanceAccessControlAttributeConfigurationDisables the attributes-based access control (ABAC) feature for the specified IAM Identity Center instance and deletes all of the attribute mappings that have been configured. Once deleted, any attributes that are received from an identity source and any custom attributes you have previously configured will not be passed. For more information about ABAC, see in the IAM Identity Center User Guide.
-
xAmzTargetSwbExternalServiceDeletePermissionsBoundaryFromPermissionSet.deletePermissionsBoundaryFromPermissionSetDeletes the permissions boundary from a specified PermissionSet [blocked].
-
xAmzTargetSwbExternalServiceDeletePermissionSet.deletePermissionSetDeletes the specified permission set.
-
xAmzTargetSwbExternalServiceDescribeAccountAssignmentCreationStatus.describeAccountAssignmentCreationStatusDescribes the status of the assignment creation request.
-
xAmzTargetSwbExternalServiceDescribeAccountAssignmentDeletionStatus.describeAccountAssignmentDeletionStatusDescribes the status of the assignment deletion request.
-
xAmzTargetSwbExternalServiceDescribeInstanceAccessControlAttributeConfiguration.describeInstanceAccessControlAttributeConfigurationReturns the list of IAM Identity Center identity store attributes that have been configured to work with attributes-based access control (ABAC) for the specified IAM Identity Center instance. This will not return attributes configured and sent by an external identity provider. For more information about ABAC, see in the IAM Identity Center User Guide.
-
xAmzTargetSwbExternalServiceDescribePermissionSet.describePermissionSetGets the details of the permission set.
-
xAmzTargetSwbExternalServiceDescribePermissionSetProvisioningStatus.describePermissionSetProvisioningStatusDescribes the status for the given permission set provisioning request.
-
xAmzTargetSwbExternalServiceDetachCustomerManagedPolicyReferenceFromPermissionSet.detachCustomerManagedPolicyReferenceFromPermissionSetDetaches the specified customer managed policy from the specified PermissionSet [blocked].
-
xAmzTargetSwbExternalServiceDetachManagedPolicyFromPermissionSet.detachManagedPolicyFromPermissionSetDetaches the attached AWS managed policy ARN from the specified permission set.
-
xAmzTargetSwbExternalServiceGetInlinePolicyForPermissionSet.getInlinePolicyForPermissionSetObtains the inline policy assigned to the permission set.
-
xAmzTargetSwbExternalServiceGetPermissionsBoundaryForPermissionSet.getPermissionsBoundaryForPermissionSetObtains the permissions boundary for a specified PermissionSet [blocked].
-
xAmzTargetSwbExternalServiceListAccountAssignmentCreationStatus.listAccountAssignmentCreationStatusLists the status of the AWS account assignment creation requests for a specified IAM Identity Center instance.
-
xAmzTargetSwbExternalServiceListAccountAssignmentDeletionStatus.listAccountAssignmentDeletionStatusLists the status of the AWS account assignment deletion requests for a specified IAM Identity Center instance.
-
xAmzTargetSwbExternalServiceListAccountAssignments.listAccountAssignmentsLists the assignee of the specified AWS account with the specified permission set.
-
xAmzTargetSwbExternalServiceListAccountsForProvisionedPermissionSet.listAccountsForProvisionedPermissionSetLists all the AWS accounts where the specified permission set is provisioned.
-
xAmzTargetSwbExternalServiceListCustomerManagedPolicyReferencesInPermissionSet.listCustomerManagedPolicyReferencesInPermissionSetLists all customer managed policies attached to a specified PermissionSet [blocked].
-
xAmzTargetSwbExternalServiceListInstances.listInstancesLists the IAM Identity Center instances that the caller has access to.
-
xAmzTargetSwbExternalServiceListManagedPoliciesInPermissionSet.listManagedPoliciesInPermissionSetLists the AWS managed policy that is attached to a specified permission set.
-
xAmzTargetSwbExternalServiceListPermissionSetProvisioningStatus.listPermissionSetProvisioningStatusLists the status of the permission set provisioning requests for a specified IAM Identity Center instance.
-
xAmzTargetSwbExternalServiceListPermissionSets.listPermissionSetsLists the PermissionSet [blocked]s in an IAM Identity Center instance.
-
xAmzTargetSwbExternalServiceListPermissionSetsProvisionedToAccount.listPermissionSetsProvisionedToAccountLists all the permission sets that are provisioned to a specified AWS account.
-
xAmzTargetSwbExternalServiceListTagsForResource.listTagsForResourceLists the tags that are attached to a specified resource.
-
xAmzTargetSwbExternalServiceProvisionPermissionSet.provisionPermissionSetThe process by which a specified permission set is provisioned to the specified target.
-
xAmzTargetSwbExternalServicePutInlinePolicyToPermissionSet.putInlinePolicyToPermissionSetAttaches an inline policy to a permission set.
If the permission set is already referenced by one or more account assignments, you will need to call
ProvisionPermissionSet [blocked]after this action to apply the corresponding IAM policy updates to all assigned accounts. -
xAmzTargetSwbExternalServicePutPermissionsBoundaryToPermissionSet.putPermissionsBoundaryToPermissionSetAttaches an AWS managed or customer managed policy to the specified PermissionSet [blocked] as a permissions boundary.
-
xAmzTargetSwbExternalServiceTagResource.tagResourceAssociates a set of tags with a specified resource.
-
xAmzTargetSwbExternalServiceUntagResource.untagResourceDisassociates a set of tags from a specified resource.
-
xAmzTargetSwbExternalServiceUpdateInstanceAccessControlAttributeConfiguration.updateInstanceAccessControlAttributeConfigurationUpdates the IAM Identity Center identity store attributes that you can use with the IAM Identity Center instance for attributes-based access control (ABAC). When using an external identity provider as an identity source, you can pass attributes through the SAML assertion as an alternative to configuring attributes from the IAM Identity Center identity store. If a SAML assertion passes any of these attributes, IAM Identity Center replaces the attribute value with the value from the IAM Identity Center identity store. For more information about ABAC, see in the IAM Identity Center User Guide.
-
xAmzTargetSwbExternalServiceUpdatePermissionSet.updatePermissionSetUpdates an existing permission set.
-
openapi.previewSpecPreview an OpenAPI document before adding it as a source
-
openapi.addSourceAdd an OpenAPI source and register its operations as tools