@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAWSSSOAdmin extends Object implements AWSSSOAdmin
AWSSSOAdmin. Convenient method forms pass through to the corresponding overload
that takes a request object, which throws an UnsupportedOperationException.ENDPOINT_PREFIXpublic AttachCustomerManagedPolicyReferenceToPermissionSetResult attachCustomerManagedPolicyReferenceToPermissionSet(AttachCustomerManagedPolicyReferenceToPermissionSetRequest request)
AWSSSOAdminAttaches the specified customer managed policy to the specified PermissionSet.
attachCustomerManagedPolicyReferenceToPermissionSet in interface AWSSSOAdminpublic AttachManagedPolicyToPermissionSetResult attachManagedPolicyToPermissionSet(AttachManagedPolicyToPermissionSetRequest request)
AWSSSOAdminAttaches an Amazon Web Services 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 after this operation. Calling ProvisionPermissionSet
applies the corresponding IAM policy updates to all assigned accounts.
attachManagedPolicyToPermissionSet in interface AWSSSOAdminpublic CreateAccountAssignmentResult createAccountAssignment(CreateAccountAssignmentRequest request)
AWSSSOAdminAssigns access to a principal for a specified Amazon Web Services 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 CreateAccountAssignment call, 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 call
ProvisionPermissionSet to make these updates.
After a successful response, call DescribeAccountAssignmentCreationStatus to describe the status of
an assignment creation request.
createAccountAssignment in interface AWSSSOAdminpublic CreateApplicationResult createApplication(CreateApplicationRequest request)
AWSSSOAdminCreates an application in IAM Identity Center for the given application provider.
createApplication in interface AWSSSOAdminpublic CreateApplicationAssignmentResult createApplicationAssignment(CreateApplicationAssignmentRequest request)
AWSSSOAdminGrant application access to a user or group.
createApplicationAssignment in interface AWSSSOAdminpublic CreateInstanceResult createInstance(CreateInstanceRequest request)
AWSSSOAdminCreates an instance of IAM Identity Center for a standalone Amazon Web Services account that is not managed by Organizations or a member Amazon Web Services account in an organization. You can create only one instance per account and across all Amazon Web Services Regions.
The CreateInstance request is rejected if the following apply:
The instance is created within the organization management account.
An instance already exists in the same account.
createInstance in interface AWSSSOAdminpublic CreateInstanceAccessControlAttributeConfigurationResult createInstanceAccessControlAttributeConfiguration(CreateInstanceAccessControlAttributeConfigurationRequest request)
AWSSSOAdminEnables 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 Attribute-Based Access Control in the IAM Identity Center User Guide.
After a successful response, call DescribeInstanceAccessControlAttributeConfiguration to validate
that InstanceAccessControlAttributeConfiguration was created.
createInstanceAccessControlAttributeConfiguration in interface AWSSSOAdminpublic CreatePermissionSetResult createPermissionSet(CreatePermissionSetRequest request)
AWSSSOAdminCreates a permission set within a specified IAM Identity Center instance.
To grant users and groups access to Amazon Web Services account resources, use
CreateAccountAssignment .
createPermissionSet in interface AWSSSOAdminpublic CreateTrustedTokenIssuerResult createTrustedTokenIssuer(CreateTrustedTokenIssuerRequest request)
AWSSSOAdminCreates a connection to a trusted token issuer in an instance of IAM Identity Center. A trusted token issuer enables trusted identity propagation to be used with applications that authenticate outside of Amazon Web Services.
This trusted token issuer describes an external identity provider (IdP) that can generate claims or assertions in the form of access tokens for a user. Applications enabled for IAM Identity Center can use these tokens for authentication.
createTrustedTokenIssuer in interface AWSSSOAdminpublic DeleteAccountAssignmentResult deleteAccountAssignment(DeleteAccountAssignmentRequest request)
AWSSSOAdminDeletes a principal's access from a specified Amazon Web Services account using a specified permission set.
After a successful response, call DescribeAccountAssignmentDeletionStatus to describe the status of
an assignment deletion request.
deleteAccountAssignment in interface AWSSSOAdminpublic DeleteApplicationResult deleteApplication(DeleteApplicationRequest request)
AWSSSOAdminDeletes the association with the application. The connected service resource still exists.
deleteApplication in interface AWSSSOAdminpublic DeleteApplicationAccessScopeResult deleteApplicationAccessScope(DeleteApplicationAccessScopeRequest request)
AWSSSOAdminDeletes an IAM Identity Center access scope from an application.
deleteApplicationAccessScope in interface AWSSSOAdminpublic DeleteApplicationAssignmentResult deleteApplicationAssignment(DeleteApplicationAssignmentRequest request)
AWSSSOAdminRevoke application access to an application by deleting application assignments for a user or group.
deleteApplicationAssignment in interface AWSSSOAdminpublic DeleteApplicationAuthenticationMethodResult deleteApplicationAuthenticationMethod(DeleteApplicationAuthenticationMethodRequest request)
AWSSSOAdminDeletes an authentication method from an application.
deleteApplicationAuthenticationMethod in interface AWSSSOAdminpublic DeleteApplicationGrantResult deleteApplicationGrant(DeleteApplicationGrantRequest request)
AWSSSOAdminDeletes a grant from an application.
deleteApplicationGrant in interface AWSSSOAdminpublic DeleteInlinePolicyFromPermissionSetResult deleteInlinePolicyFromPermissionSet(DeleteInlinePolicyFromPermissionSetRequest request)
AWSSSOAdminDeletes the inline policy from a specified permission set.
deleteInlinePolicyFromPermissionSet in interface AWSSSOAdminpublic DeleteInstanceResult deleteInstance(DeleteInstanceRequest request)
AWSSSOAdminDeletes the instance of IAM Identity Center. Only the account that owns the instance can call this API. Neither the delegated administrator nor member account can delete the organization instance, but those roles can delete their own instance.
deleteInstance in interface AWSSSOAdminpublic DeleteInstanceAccessControlAttributeConfigurationResult deleteInstanceAccessControlAttributeConfiguration(DeleteInstanceAccessControlAttributeConfigurationRequest request)
AWSSSOAdminDisables 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 Attribute-Based Access Control in the IAM Identity Center User Guide.
deleteInstanceAccessControlAttributeConfiguration in interface AWSSSOAdminpublic DeletePermissionSetResult deletePermissionSet(DeletePermissionSetRequest request)
AWSSSOAdminDeletes the specified permission set.
deletePermissionSet in interface AWSSSOAdminpublic DeletePermissionsBoundaryFromPermissionSetResult deletePermissionsBoundaryFromPermissionSet(DeletePermissionsBoundaryFromPermissionSetRequest request)
AWSSSOAdminDeletes the permissions boundary from a specified PermissionSet.
deletePermissionsBoundaryFromPermissionSet in interface AWSSSOAdminpublic DeleteTrustedTokenIssuerResult deleteTrustedTokenIssuer(DeleteTrustedTokenIssuerRequest request)
AWSSSOAdminDeletes a trusted token issuer configuration from an instance of IAM Identity Center.
Deleting this trusted token issuer configuration will cause users to lose access to any applications that are configured to use the trusted token issuer.
deleteTrustedTokenIssuer in interface AWSSSOAdminpublic DescribeAccountAssignmentCreationStatusResult describeAccountAssignmentCreationStatus(DescribeAccountAssignmentCreationStatusRequest request)
AWSSSOAdminDescribes the status of the assignment creation request.
describeAccountAssignmentCreationStatus in interface AWSSSOAdminpublic DescribeAccountAssignmentDeletionStatusResult describeAccountAssignmentDeletionStatus(DescribeAccountAssignmentDeletionStatusRequest request)
AWSSSOAdminDescribes the status of the assignment deletion request.
describeAccountAssignmentDeletionStatus in interface AWSSSOAdminpublic DescribeApplicationResult describeApplication(DescribeApplicationRequest request)
AWSSSOAdminRetrieves the details of an application associated with an instance of IAM Identity Center.
describeApplication in interface AWSSSOAdminpublic DescribeApplicationAssignmentResult describeApplicationAssignment(DescribeApplicationAssignmentRequest request)
AWSSSOAdminRetrieves a direct assignment of a user or group to an application. If the user doesn’t have a direct assignment to the application, the user may still have access to the application through a group. Therefore, don’t use this API to test access to an application for a user. Instead use ListApplicationAssignmentsForPrincipal.
describeApplicationAssignment in interface AWSSSOAdminpublic DescribeApplicationProviderResult describeApplicationProvider(DescribeApplicationProviderRequest request)
AWSSSOAdminRetrieves details about a provider that can be used to connect an Amazon Web Services managed application or customer managed application to IAM Identity Center.
describeApplicationProvider in interface AWSSSOAdminpublic DescribeInstanceResult describeInstance(DescribeInstanceRequest request)
AWSSSOAdminReturns the details of an instance of IAM Identity Center. The status can be one of the following:
CREATE_IN_PROGRESS - The instance is in the process of being created. When the instance is ready for
use, DescribeInstance returns the status of ACTIVE. While the instance is in the
CREATE_IN_PROGRESS state, you can call only DescribeInstance and DeleteInstance operations.
DELETE_IN_PROGRESS - The instance is being deleted. Returns AccessDeniedException after
the delete operation completes.
ACTIVE - The instance is active.
describeInstance in interface AWSSSOAdminpublic DescribeInstanceAccessControlAttributeConfigurationResult describeInstanceAccessControlAttributeConfiguration(DescribeInstanceAccessControlAttributeConfigurationRequest request)
AWSSSOAdminReturns 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 Attribute-Based Access Control in the IAM Identity Center User Guide.
describeInstanceAccessControlAttributeConfiguration in interface AWSSSOAdminpublic DescribePermissionSetResult describePermissionSet(DescribePermissionSetRequest request)
AWSSSOAdminGets the details of the permission set.
describePermissionSet in interface AWSSSOAdminpublic DescribePermissionSetProvisioningStatusResult describePermissionSetProvisioningStatus(DescribePermissionSetProvisioningStatusRequest request)
AWSSSOAdminDescribes the status for the given permission set provisioning request.
describePermissionSetProvisioningStatus in interface AWSSSOAdminpublic DescribeTrustedTokenIssuerResult describeTrustedTokenIssuer(DescribeTrustedTokenIssuerRequest request)
AWSSSOAdminRetrieves details about a trusted token issuer configuration stored in an instance of IAM Identity Center. Details include the name of the trusted token issuer, the issuer URL, and the path of the source attribute and the destination attribute for a trusted token issuer configuration.
describeTrustedTokenIssuer in interface AWSSSOAdminpublic DetachCustomerManagedPolicyReferenceFromPermissionSetResult detachCustomerManagedPolicyReferenceFromPermissionSet(DetachCustomerManagedPolicyReferenceFromPermissionSetRequest request)
AWSSSOAdminDetaches the specified customer managed policy from the specified PermissionSet.
detachCustomerManagedPolicyReferenceFromPermissionSet in interface AWSSSOAdminpublic DetachManagedPolicyFromPermissionSetResult detachManagedPolicyFromPermissionSet(DetachManagedPolicyFromPermissionSetRequest request)
AWSSSOAdminDetaches the attached Amazon Web Services managed policy ARN from the specified permission set.
detachManagedPolicyFromPermissionSet in interface AWSSSOAdminpublic GetApplicationAccessScopeResult getApplicationAccessScope(GetApplicationAccessScopeRequest request)
AWSSSOAdminRetrieves the authorized targets for an IAM Identity Center access scope for an application.
getApplicationAccessScope in interface AWSSSOAdminpublic GetApplicationAssignmentConfigurationResult getApplicationAssignmentConfiguration(GetApplicationAssignmentConfigurationRequest request)
AWSSSOAdminRetrieves the configuration of PutApplicationAssignmentConfiguration.
getApplicationAssignmentConfiguration in interface AWSSSOAdminpublic GetApplicationAuthenticationMethodResult getApplicationAuthenticationMethod(GetApplicationAuthenticationMethodRequest request)
AWSSSOAdminRetrieves details about an authentication method used by an application.
getApplicationAuthenticationMethod in interface AWSSSOAdminpublic GetApplicationGrantResult getApplicationGrant(GetApplicationGrantRequest request)
AWSSSOAdminRetrieves details about an application grant.
getApplicationGrant in interface AWSSSOAdminpublic GetInlinePolicyForPermissionSetResult getInlinePolicyForPermissionSet(GetInlinePolicyForPermissionSetRequest request)
AWSSSOAdminObtains the inline policy assigned to the permission set.
getInlinePolicyForPermissionSet in interface AWSSSOAdminpublic GetPermissionsBoundaryForPermissionSetResult getPermissionsBoundaryForPermissionSet(GetPermissionsBoundaryForPermissionSetRequest request)
AWSSSOAdminObtains the permissions boundary for a specified PermissionSet.
getPermissionsBoundaryForPermissionSet in interface AWSSSOAdminpublic ListAccountAssignmentCreationStatusResult listAccountAssignmentCreationStatus(ListAccountAssignmentCreationStatusRequest request)
AWSSSOAdminLists the status of the Amazon Web Services account assignment creation requests for a specified IAM Identity Center instance.
listAccountAssignmentCreationStatus in interface AWSSSOAdminpublic ListAccountAssignmentDeletionStatusResult listAccountAssignmentDeletionStatus(ListAccountAssignmentDeletionStatusRequest request)
AWSSSOAdminLists the status of the Amazon Web Services account assignment deletion requests for a specified IAM Identity Center instance.
listAccountAssignmentDeletionStatus in interface AWSSSOAdminpublic ListAccountAssignmentsResult listAccountAssignments(ListAccountAssignmentsRequest request)
AWSSSOAdminLists the assignee of the specified Amazon Web Services account with the specified permission set.
listAccountAssignments in interface AWSSSOAdminpublic ListAccountAssignmentsForPrincipalResult listAccountAssignmentsForPrincipal(ListAccountAssignmentsForPrincipalRequest request)
AWSSSOAdminRetrieves a list of the IAM Identity Center associated Amazon Web Services accounts that the principal has access to.
listAccountAssignmentsForPrincipal in interface AWSSSOAdminpublic ListAccountsForProvisionedPermissionSetResult listAccountsForProvisionedPermissionSet(ListAccountsForProvisionedPermissionSetRequest request)
AWSSSOAdminLists all the Amazon Web Services accounts where the specified permission set is provisioned.
listAccountsForProvisionedPermissionSet in interface AWSSSOAdminpublic ListApplicationAccessScopesResult listApplicationAccessScopes(ListApplicationAccessScopesRequest request)
AWSSSOAdminLists the access scopes and authorized targets associated with an application.
listApplicationAccessScopes in interface AWSSSOAdminpublic ListApplicationAssignmentsResult listApplicationAssignments(ListApplicationAssignmentsRequest request)
AWSSSOAdminLists Amazon Web Services account users that are assigned to an application.
listApplicationAssignments in interface AWSSSOAdminpublic ListApplicationAssignmentsForPrincipalResult listApplicationAssignmentsForPrincipal(ListApplicationAssignmentsForPrincipalRequest request)
AWSSSOAdminLists the applications to which a specified principal is assigned.
listApplicationAssignmentsForPrincipal in interface AWSSSOAdminpublic ListApplicationAuthenticationMethodsResult listApplicationAuthenticationMethods(ListApplicationAuthenticationMethodsRequest request)
AWSSSOAdminLists all of the authentication methods supported by the specified application.
listApplicationAuthenticationMethods in interface AWSSSOAdminpublic ListApplicationGrantsResult listApplicationGrants(ListApplicationGrantsRequest request)
AWSSSOAdminList the grants associated with an application.
listApplicationGrants in interface AWSSSOAdminpublic ListApplicationProvidersResult listApplicationProviders(ListApplicationProvidersRequest request)
AWSSSOAdminLists the application providers configured in the IAM Identity Center identity store.
listApplicationProviders in interface AWSSSOAdminpublic ListApplicationsResult listApplications(ListApplicationsRequest request)
AWSSSOAdmin
Lists all applications associated with the instance of IAM Identity Center. When listing applications for an
instance in the management account, member accounts must use the applicationAccount parameter to
filter the list to only applications created from that account.
listApplications in interface AWSSSOAdminpublic ListCustomerManagedPolicyReferencesInPermissionSetResult listCustomerManagedPolicyReferencesInPermissionSet(ListCustomerManagedPolicyReferencesInPermissionSetRequest request)
AWSSSOAdminLists all customer managed policies attached to a specified PermissionSet.
listCustomerManagedPolicyReferencesInPermissionSet in interface AWSSSOAdminpublic ListInstancesResult listInstances(ListInstancesRequest request)
AWSSSOAdminLists the details of the organization and account instances of IAM Identity Center that were created in or visible to the account calling this API.
listInstances in interface AWSSSOAdminpublic ListManagedPoliciesInPermissionSetResult listManagedPoliciesInPermissionSet(ListManagedPoliciesInPermissionSetRequest request)
AWSSSOAdminLists the Amazon Web Services managed policy that is attached to a specified permission set.
listManagedPoliciesInPermissionSet in interface AWSSSOAdminpublic ListPermissionSetProvisioningStatusResult listPermissionSetProvisioningStatus(ListPermissionSetProvisioningStatusRequest request)
AWSSSOAdminLists the status of the permission set provisioning requests for a specified IAM Identity Center instance.
listPermissionSetProvisioningStatus in interface AWSSSOAdminpublic ListPermissionSetsResult listPermissionSets(ListPermissionSetsRequest request)
AWSSSOAdminLists the PermissionSets in an IAM Identity Center instance.
listPermissionSets in interface AWSSSOAdminpublic ListPermissionSetsProvisionedToAccountResult listPermissionSetsProvisionedToAccount(ListPermissionSetsProvisionedToAccountRequest request)
AWSSSOAdminLists all the permission sets that are provisioned to a specified Amazon Web Services account.
listPermissionSetsProvisionedToAccount in interface AWSSSOAdminpublic ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
AWSSSOAdminLists the tags that are attached to a specified resource.
listTagsForResource in interface AWSSSOAdminpublic ListTrustedTokenIssuersResult listTrustedTokenIssuers(ListTrustedTokenIssuersRequest request)
AWSSSOAdminLists all the trusted token issuers configured in an instance of IAM Identity Center.
listTrustedTokenIssuers in interface AWSSSOAdminpublic ProvisionPermissionSetResult provisionPermissionSet(ProvisionPermissionSetRequest request)
AWSSSOAdminThe process by which a specified permission set is provisioned to the specified target.
provisionPermissionSet in interface AWSSSOAdminpublic PutApplicationAccessScopeResult putApplicationAccessScope(PutApplicationAccessScopeRequest request)
AWSSSOAdminAdds or updates the list of authorized targets for an IAM Identity Center access scope for an application.
putApplicationAccessScope in interface AWSSSOAdminpublic PutApplicationAssignmentConfigurationResult putApplicationAssignmentConfiguration(PutApplicationAssignmentConfigurationRequest request)
AWSSSOAdmin
Configure how users gain access to an application. If AssignmentsRequired is true
(default value), users don’t have access to the application unless an assignment is created using the CreateApplicationAssignment API. If false, all users have access to the application. If an
assignment is created using CreateApplicationAssignment., the user retains access if AssignmentsRequired is set to
true.
putApplicationAssignmentConfiguration in interface AWSSSOAdminpublic PutApplicationAuthenticationMethodResult putApplicationAuthenticationMethod(PutApplicationAuthenticationMethodRequest request)
AWSSSOAdminAdds or updates an authentication method for an application.
putApplicationAuthenticationMethod in interface AWSSSOAdminpublic PutApplicationGrantResult putApplicationGrant(PutApplicationGrantRequest request)
AWSSSOAdminAdds a grant to an application.
putApplicationGrant in interface AWSSSOAdminpublic PutInlinePolicyToPermissionSetResult putInlinePolicyToPermissionSet(PutInlinePolicyToPermissionSetRequest request)
AWSSSOAdminAttaches 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 after this action to apply the corresponding IAM policy updates to
all assigned accounts.
putInlinePolicyToPermissionSet in interface AWSSSOAdminpublic PutPermissionsBoundaryToPermissionSetResult putPermissionsBoundaryToPermissionSet(PutPermissionsBoundaryToPermissionSetRequest request)
AWSSSOAdminAttaches an Amazon Web Services managed or customer managed policy to the specified PermissionSet as a permissions boundary.
putPermissionsBoundaryToPermissionSet in interface AWSSSOAdminpublic TagResourceResult tagResource(TagResourceRequest request)
AWSSSOAdminAssociates a set of tags with a specified resource.
tagResource in interface AWSSSOAdminpublic UntagResourceResult untagResource(UntagResourceRequest request)
AWSSSOAdminDisassociates a set of tags from a specified resource.
untagResource in interface AWSSSOAdminpublic UpdateApplicationResult updateApplication(UpdateApplicationRequest request)
AWSSSOAdminUpdates application properties.
updateApplication in interface AWSSSOAdminpublic UpdateInstanceResult updateInstance(UpdateInstanceRequest request)
AWSSSOAdminUpdate the details for the instance of IAM Identity Center that is owned by the Amazon Web Services account.
updateInstance in interface AWSSSOAdminpublic UpdateInstanceAccessControlAttributeConfigurationResult updateInstanceAccessControlAttributeConfiguration(UpdateInstanceAccessControlAttributeConfigurationRequest request)
AWSSSOAdminUpdates 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 Attribute-Based Access Control in the IAM Identity Center User Guide.
updateInstanceAccessControlAttributeConfiguration in interface AWSSSOAdminpublic UpdatePermissionSetResult updatePermissionSet(UpdatePermissionSetRequest request)
AWSSSOAdminUpdates an existing permission set.
updatePermissionSet in interface AWSSSOAdminpublic UpdateTrustedTokenIssuerResult updateTrustedTokenIssuer(UpdateTrustedTokenIssuerRequest request)
AWSSSOAdminUpdates the name of the trusted token issuer, or the path of a source attribute or destination attribute for a trusted token issuer configuration.
Updating this trusted token issuer configuration might cause users to lose access to any applications that are configured to use the trusted token issuer.
updateTrustedTokenIssuer in interface AWSSSOAdminpublic void shutdown()
AWSSSOAdminshutdown in interface AWSSSOAdminpublic ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AWSSSOAdminResponse metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
getCachedResponseMetadata in interface AWSSSOAdminrequest - The originally executed request.