@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_PREFIX
public AttachCustomerManagedPolicyReferenceToPermissionSetResult attachCustomerManagedPolicyReferenceToPermissionSet(AttachCustomerManagedPolicyReferenceToPermissionSetRequest request)
AWSSSOAdmin
Attaches the specified customer managed policy to the specified PermissionSet.
attachCustomerManagedPolicyReferenceToPermissionSet
in interface AWSSSOAdmin
public AttachManagedPolicyToPermissionSetResult attachManagedPolicyToPermissionSet(AttachManagedPolicyToPermissionSetRequest request)
AWSSSOAdmin
Attaches 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 AWSSSOAdmin
public CreateAccountAssignmentResult createAccountAssignment(CreateAccountAssignmentRequest request)
AWSSSOAdmin
Assigns 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 AWSSSOAdmin
public CreateApplicationResult createApplication(CreateApplicationRequest request)
AWSSSOAdmin
Creates an application in IAM Identity Center for the given application provider.
createApplication
in interface AWSSSOAdmin
public CreateApplicationAssignmentResult createApplicationAssignment(CreateApplicationAssignmentRequest request)
AWSSSOAdmin
Grant application access to a user or group.
createApplicationAssignment
in interface AWSSSOAdmin
public CreateInstanceResult createInstance(CreateInstanceRequest request)
AWSSSOAdmin
Creates 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 AWSSSOAdmin
public CreateInstanceAccessControlAttributeConfigurationResult createInstanceAccessControlAttributeConfiguration(CreateInstanceAccessControlAttributeConfigurationRequest request)
AWSSSOAdmin
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 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 AWSSSOAdmin
public CreatePermissionSetResult createPermissionSet(CreatePermissionSetRequest request)
AWSSSOAdmin
Creates 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 AWSSSOAdmin
public CreateTrustedTokenIssuerResult createTrustedTokenIssuer(CreateTrustedTokenIssuerRequest request)
AWSSSOAdmin
Creates 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 AWSSSOAdmin
public DeleteAccountAssignmentResult deleteAccountAssignment(DeleteAccountAssignmentRequest request)
AWSSSOAdmin
Deletes 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 AWSSSOAdmin
public DeleteApplicationResult deleteApplication(DeleteApplicationRequest request)
AWSSSOAdmin
Deletes the association with the application. The connected service resource still exists.
deleteApplication
in interface AWSSSOAdmin
public DeleteApplicationAccessScopeResult deleteApplicationAccessScope(DeleteApplicationAccessScopeRequest request)
AWSSSOAdmin
Deletes an IAM Identity Center access scope from an application.
deleteApplicationAccessScope
in interface AWSSSOAdmin
public DeleteApplicationAssignmentResult deleteApplicationAssignment(DeleteApplicationAssignmentRequest request)
AWSSSOAdmin
Revoke application access to an application by deleting application assignments for a user or group.
deleteApplicationAssignment
in interface AWSSSOAdmin
public DeleteApplicationAuthenticationMethodResult deleteApplicationAuthenticationMethod(DeleteApplicationAuthenticationMethodRequest request)
AWSSSOAdmin
Deletes an authentication method from an application.
deleteApplicationAuthenticationMethod
in interface AWSSSOAdmin
public DeleteApplicationGrantResult deleteApplicationGrant(DeleteApplicationGrantRequest request)
AWSSSOAdmin
Deletes a grant from an application.
deleteApplicationGrant
in interface AWSSSOAdmin
public DeleteInlinePolicyFromPermissionSetResult deleteInlinePolicyFromPermissionSet(DeleteInlinePolicyFromPermissionSetRequest request)
AWSSSOAdmin
Deletes the inline policy from a specified permission set.
deleteInlinePolicyFromPermissionSet
in interface AWSSSOAdmin
public DeleteInstanceResult deleteInstance(DeleteInstanceRequest request)
AWSSSOAdmin
Deletes 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 AWSSSOAdmin
public DeleteInstanceAccessControlAttributeConfigurationResult deleteInstanceAccessControlAttributeConfiguration(DeleteInstanceAccessControlAttributeConfigurationRequest request)
AWSSSOAdmin
Disables 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 AWSSSOAdmin
public DeletePermissionSetResult deletePermissionSet(DeletePermissionSetRequest request)
AWSSSOAdmin
Deletes the specified permission set.
deletePermissionSet
in interface AWSSSOAdmin
public DeletePermissionsBoundaryFromPermissionSetResult deletePermissionsBoundaryFromPermissionSet(DeletePermissionsBoundaryFromPermissionSetRequest request)
AWSSSOAdmin
Deletes the permissions boundary from a specified PermissionSet.
deletePermissionsBoundaryFromPermissionSet
in interface AWSSSOAdmin
public DeleteTrustedTokenIssuerResult deleteTrustedTokenIssuer(DeleteTrustedTokenIssuerRequest request)
AWSSSOAdmin
Deletes 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 AWSSSOAdmin
public DescribeAccountAssignmentCreationStatusResult describeAccountAssignmentCreationStatus(DescribeAccountAssignmentCreationStatusRequest request)
AWSSSOAdmin
Describes the status of the assignment creation request.
describeAccountAssignmentCreationStatus
in interface AWSSSOAdmin
public DescribeAccountAssignmentDeletionStatusResult describeAccountAssignmentDeletionStatus(DescribeAccountAssignmentDeletionStatusRequest request)
AWSSSOAdmin
Describes the status of the assignment deletion request.
describeAccountAssignmentDeletionStatus
in interface AWSSSOAdmin
public DescribeApplicationResult describeApplication(DescribeApplicationRequest request)
AWSSSOAdmin
Retrieves the details of an application associated with an instance of IAM Identity Center.
describeApplication
in interface AWSSSOAdmin
public DescribeApplicationAssignmentResult describeApplicationAssignment(DescribeApplicationAssignmentRequest request)
AWSSSOAdmin
Retrieves 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 AWSSSOAdmin
public DescribeApplicationProviderResult describeApplicationProvider(DescribeApplicationProviderRequest request)
AWSSSOAdmin
Retrieves 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 AWSSSOAdmin
public DescribeInstanceResult describeInstance(DescribeInstanceRequest request)
AWSSSOAdmin
Returns 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 AWSSSOAdmin
public DescribeInstanceAccessControlAttributeConfigurationResult describeInstanceAccessControlAttributeConfiguration(DescribeInstanceAccessControlAttributeConfigurationRequest request)
AWSSSOAdmin
Returns 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 AWSSSOAdmin
public DescribePermissionSetResult describePermissionSet(DescribePermissionSetRequest request)
AWSSSOAdmin
Gets the details of the permission set.
describePermissionSet
in interface AWSSSOAdmin
public DescribePermissionSetProvisioningStatusResult describePermissionSetProvisioningStatus(DescribePermissionSetProvisioningStatusRequest request)
AWSSSOAdmin
Describes the status for the given permission set provisioning request.
describePermissionSetProvisioningStatus
in interface AWSSSOAdmin
public DescribeTrustedTokenIssuerResult describeTrustedTokenIssuer(DescribeTrustedTokenIssuerRequest request)
AWSSSOAdmin
Retrieves 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 AWSSSOAdmin
public DetachCustomerManagedPolicyReferenceFromPermissionSetResult detachCustomerManagedPolicyReferenceFromPermissionSet(DetachCustomerManagedPolicyReferenceFromPermissionSetRequest request)
AWSSSOAdmin
Detaches the specified customer managed policy from the specified PermissionSet.
detachCustomerManagedPolicyReferenceFromPermissionSet
in interface AWSSSOAdmin
public DetachManagedPolicyFromPermissionSetResult detachManagedPolicyFromPermissionSet(DetachManagedPolicyFromPermissionSetRequest request)
AWSSSOAdmin
Detaches the attached Amazon Web Services managed policy ARN from the specified permission set.
detachManagedPolicyFromPermissionSet
in interface AWSSSOAdmin
public GetApplicationAccessScopeResult getApplicationAccessScope(GetApplicationAccessScopeRequest request)
AWSSSOAdmin
Retrieves the authorized targets for an IAM Identity Center access scope for an application.
getApplicationAccessScope
in interface AWSSSOAdmin
public GetApplicationAssignmentConfigurationResult getApplicationAssignmentConfiguration(GetApplicationAssignmentConfigurationRequest request)
AWSSSOAdmin
Retrieves the configuration of PutApplicationAssignmentConfiguration.
getApplicationAssignmentConfiguration
in interface AWSSSOAdmin
public GetApplicationAuthenticationMethodResult getApplicationAuthenticationMethod(GetApplicationAuthenticationMethodRequest request)
AWSSSOAdmin
Retrieves details about an authentication method used by an application.
getApplicationAuthenticationMethod
in interface AWSSSOAdmin
public GetApplicationGrantResult getApplicationGrant(GetApplicationGrantRequest request)
AWSSSOAdmin
Retrieves details about an application grant.
getApplicationGrant
in interface AWSSSOAdmin
public GetInlinePolicyForPermissionSetResult getInlinePolicyForPermissionSet(GetInlinePolicyForPermissionSetRequest request)
AWSSSOAdmin
Obtains the inline policy assigned to the permission set.
getInlinePolicyForPermissionSet
in interface AWSSSOAdmin
public GetPermissionsBoundaryForPermissionSetResult getPermissionsBoundaryForPermissionSet(GetPermissionsBoundaryForPermissionSetRequest request)
AWSSSOAdmin
Obtains the permissions boundary for a specified PermissionSet.
getPermissionsBoundaryForPermissionSet
in interface AWSSSOAdmin
public ListAccountAssignmentCreationStatusResult listAccountAssignmentCreationStatus(ListAccountAssignmentCreationStatusRequest request)
AWSSSOAdmin
Lists the status of the Amazon Web Services account assignment creation requests for a specified IAM Identity Center instance.
listAccountAssignmentCreationStatus
in interface AWSSSOAdmin
public ListAccountAssignmentDeletionStatusResult listAccountAssignmentDeletionStatus(ListAccountAssignmentDeletionStatusRequest request)
AWSSSOAdmin
Lists the status of the Amazon Web Services account assignment deletion requests for a specified IAM Identity Center instance.
listAccountAssignmentDeletionStatus
in interface AWSSSOAdmin
public ListAccountAssignmentsResult listAccountAssignments(ListAccountAssignmentsRequest request)
AWSSSOAdmin
Lists the assignee of the specified Amazon Web Services account with the specified permission set.
listAccountAssignments
in interface AWSSSOAdmin
public ListAccountAssignmentsForPrincipalResult listAccountAssignmentsForPrincipal(ListAccountAssignmentsForPrincipalRequest request)
AWSSSOAdmin
Retrieves a list of the IAM Identity Center associated Amazon Web Services accounts that the principal has access to.
listAccountAssignmentsForPrincipal
in interface AWSSSOAdmin
public ListAccountsForProvisionedPermissionSetResult listAccountsForProvisionedPermissionSet(ListAccountsForProvisionedPermissionSetRequest request)
AWSSSOAdmin
Lists all the Amazon Web Services accounts where the specified permission set is provisioned.
listAccountsForProvisionedPermissionSet
in interface AWSSSOAdmin
public ListApplicationAccessScopesResult listApplicationAccessScopes(ListApplicationAccessScopesRequest request)
AWSSSOAdmin
Lists the access scopes and authorized targets associated with an application.
listApplicationAccessScopes
in interface AWSSSOAdmin
public ListApplicationAssignmentsResult listApplicationAssignments(ListApplicationAssignmentsRequest request)
AWSSSOAdmin
Lists Amazon Web Services account users that are assigned to an application.
listApplicationAssignments
in interface AWSSSOAdmin
public ListApplicationAssignmentsForPrincipalResult listApplicationAssignmentsForPrincipal(ListApplicationAssignmentsForPrincipalRequest request)
AWSSSOAdmin
Lists the applications to which a specified principal is assigned.
listApplicationAssignmentsForPrincipal
in interface AWSSSOAdmin
public ListApplicationAuthenticationMethodsResult listApplicationAuthenticationMethods(ListApplicationAuthenticationMethodsRequest request)
AWSSSOAdmin
Lists all of the authentication methods supported by the specified application.
listApplicationAuthenticationMethods
in interface AWSSSOAdmin
public ListApplicationGrantsResult listApplicationGrants(ListApplicationGrantsRequest request)
AWSSSOAdmin
List the grants associated with an application.
listApplicationGrants
in interface AWSSSOAdmin
public ListApplicationProvidersResult listApplicationProviders(ListApplicationProvidersRequest request)
AWSSSOAdmin
Lists the application providers configured in the IAM Identity Center identity store.
listApplicationProviders
in interface AWSSSOAdmin
public 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 AWSSSOAdmin
public ListCustomerManagedPolicyReferencesInPermissionSetResult listCustomerManagedPolicyReferencesInPermissionSet(ListCustomerManagedPolicyReferencesInPermissionSetRequest request)
AWSSSOAdmin
Lists all customer managed policies attached to a specified PermissionSet.
listCustomerManagedPolicyReferencesInPermissionSet
in interface AWSSSOAdmin
public ListInstancesResult listInstances(ListInstancesRequest request)
AWSSSOAdmin
Lists 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 AWSSSOAdmin
public ListManagedPoliciesInPermissionSetResult listManagedPoliciesInPermissionSet(ListManagedPoliciesInPermissionSetRequest request)
AWSSSOAdmin
Lists the Amazon Web Services managed policy that is attached to a specified permission set.
listManagedPoliciesInPermissionSet
in interface AWSSSOAdmin
public ListPermissionSetProvisioningStatusResult listPermissionSetProvisioningStatus(ListPermissionSetProvisioningStatusRequest request)
AWSSSOAdmin
Lists the status of the permission set provisioning requests for a specified IAM Identity Center instance.
listPermissionSetProvisioningStatus
in interface AWSSSOAdmin
public ListPermissionSetsResult listPermissionSets(ListPermissionSetsRequest request)
AWSSSOAdmin
Lists the PermissionSets in an IAM Identity Center instance.
listPermissionSets
in interface AWSSSOAdmin
public ListPermissionSetsProvisionedToAccountResult listPermissionSetsProvisionedToAccount(ListPermissionSetsProvisionedToAccountRequest request)
AWSSSOAdmin
Lists all the permission sets that are provisioned to a specified Amazon Web Services account.
listPermissionSetsProvisionedToAccount
in interface AWSSSOAdmin
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
AWSSSOAdmin
Lists the tags that are attached to a specified resource.
listTagsForResource
in interface AWSSSOAdmin
public ListTrustedTokenIssuersResult listTrustedTokenIssuers(ListTrustedTokenIssuersRequest request)
AWSSSOAdmin
Lists all the trusted token issuers configured in an instance of IAM Identity Center.
listTrustedTokenIssuers
in interface AWSSSOAdmin
public ProvisionPermissionSetResult provisionPermissionSet(ProvisionPermissionSetRequest request)
AWSSSOAdmin
The process by which a specified permission set is provisioned to the specified target.
provisionPermissionSet
in interface AWSSSOAdmin
public PutApplicationAccessScopeResult putApplicationAccessScope(PutApplicationAccessScopeRequest request)
AWSSSOAdmin
Adds or updates the list of authorized targets for an IAM Identity Center access scope for an application.
putApplicationAccessScope
in interface AWSSSOAdmin
public 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 AWSSSOAdmin
public PutApplicationAuthenticationMethodResult putApplicationAuthenticationMethod(PutApplicationAuthenticationMethodRequest request)
AWSSSOAdmin
Adds or updates an authentication method for an application.
putApplicationAuthenticationMethod
in interface AWSSSOAdmin
public PutApplicationGrantResult putApplicationGrant(PutApplicationGrantRequest request)
AWSSSOAdmin
Adds a grant to an application.
putApplicationGrant
in interface AWSSSOAdmin
public PutInlinePolicyToPermissionSetResult putInlinePolicyToPermissionSet(PutInlinePolicyToPermissionSetRequest request)
AWSSSOAdmin
Attaches 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 AWSSSOAdmin
public PutPermissionsBoundaryToPermissionSetResult putPermissionsBoundaryToPermissionSet(PutPermissionsBoundaryToPermissionSetRequest request)
AWSSSOAdmin
Attaches an Amazon Web Services managed or customer managed policy to the specified PermissionSet as a permissions boundary.
putPermissionsBoundaryToPermissionSet
in interface AWSSSOAdmin
public TagResourceResult tagResource(TagResourceRequest request)
AWSSSOAdmin
Associates a set of tags with a specified resource.
tagResource
in interface AWSSSOAdmin
public UntagResourceResult untagResource(UntagResourceRequest request)
AWSSSOAdmin
Disassociates a set of tags from a specified resource.
untagResource
in interface AWSSSOAdmin
public UpdateApplicationResult updateApplication(UpdateApplicationRequest request)
AWSSSOAdmin
Updates application properties.
updateApplication
in interface AWSSSOAdmin
public UpdateInstanceResult updateInstance(UpdateInstanceRequest request)
AWSSSOAdmin
Update the details for the instance of IAM Identity Center that is owned by the Amazon Web Services account.
updateInstance
in interface AWSSSOAdmin
public UpdateInstanceAccessControlAttributeConfigurationResult updateInstanceAccessControlAttributeConfiguration(UpdateInstanceAccessControlAttributeConfigurationRequest request)
AWSSSOAdmin
Updates 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 AWSSSOAdmin
public UpdatePermissionSetResult updatePermissionSet(UpdatePermissionSetRequest request)
AWSSSOAdmin
Updates an existing permission set.
updatePermissionSet
in interface AWSSSOAdmin
public UpdateTrustedTokenIssuerResult updateTrustedTokenIssuer(UpdateTrustedTokenIssuerRequest request)
AWSSSOAdmin
Updates 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 AWSSSOAdmin
public void shutdown()
AWSSSOAdmin
shutdown
in interface AWSSSOAdmin
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AWSSSOAdmin
Response 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 AWSSSOAdmin
request
- The originally executed request.