Class: Aws::SSOAdmin::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::SSOAdmin::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb
Overview
An API client for SSOAdmin. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::SSOAdmin::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#attach_customer_managed_policy_reference_to_permission_set(params = {}) ⇒ Struct
Attaches the specified customer managed policy to the specified PermissionSet.
-
#attach_managed_policy_to_permission_set(params = {}) ⇒ Struct
Attaches an Amazon Web Services managed policy ARN to a permission set.
-
#create_account_assignment(params = {}) ⇒ Types::CreateAccountAssignmentResponse
Assigns access to a principal for a specified Amazon Web Services account using a specified permission set.
-
#create_application(params = {}) ⇒ Types::CreateApplicationResponse
Creates an OAuth 2.0 customer managed application in IAM Identity Center for the given application provider.
-
#create_application_assignment(params = {}) ⇒ Struct
Grant application access to a user or group.
-
#create_instance(params = {}) ⇒ Types::CreateInstanceResponse
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.
-
#create_instance_access_control_attribute_configuration(params = {}) ⇒ Struct
Enables the attributes-based access control (ABAC) feature for the specified IAM Identity Center instance.
-
#create_permission_set(params = {}) ⇒ Types::CreatePermissionSetResponse
Creates a permission set within a specified IAM Identity Center instance.
-
#create_trusted_token_issuer(params = {}) ⇒ Types::CreateTrustedTokenIssuerResponse
Creates a connection to a trusted token issuer in an instance of IAM Identity Center.
-
#delete_account_assignment(params = {}) ⇒ Types::DeleteAccountAssignmentResponse
Deletes a principal's access from a specified Amazon Web Services account using a specified permission set.
-
#delete_application(params = {}) ⇒ Struct
Deletes the association with the application.
-
#delete_application_access_scope(params = {}) ⇒ Struct
Deletes an IAM Identity Center access scope from an application.
-
#delete_application_assignment(params = {}) ⇒ Struct
Revoke application access to an application by deleting application assignments for a user or group.
-
#delete_application_authentication_method(params = {}) ⇒ Struct
Deletes an authentication method from an application.
-
#delete_application_grant(params = {}) ⇒ Struct
Deletes a grant from an application.
-
#delete_inline_policy_from_permission_set(params = {}) ⇒ Struct
Deletes the inline policy from a specified permission set.
-
#delete_instance(params = {}) ⇒ Struct
Deletes the instance of IAM Identity Center.
-
#delete_instance_access_control_attribute_configuration(params = {}) ⇒ Struct
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.
-
#delete_permission_set(params = {}) ⇒ Struct
Deletes the specified permission set.
-
#delete_permissions_boundary_from_permission_set(params = {}) ⇒ Struct
Deletes the permissions boundary from a specified PermissionSet.
-
#delete_trusted_token_issuer(params = {}) ⇒ Struct
Deletes a trusted token issuer configuration from an instance of IAM Identity Center.
-
#describe_account_assignment_creation_status(params = {}) ⇒ Types::DescribeAccountAssignmentCreationStatusResponse
Describes the status of the assignment creation request.
-
#describe_account_assignment_deletion_status(params = {}) ⇒ Types::DescribeAccountAssignmentDeletionStatusResponse
Describes the status of the assignment deletion request.
-
#describe_application(params = {}) ⇒ Types::DescribeApplicationResponse
Retrieves the details of an application associated with an instance of IAM Identity Center.
-
#describe_application_assignment(params = {}) ⇒ Types::DescribeApplicationAssignmentResponse
Retrieves a direct assignment of a user or group to an application.
-
#describe_application_provider(params = {}) ⇒ Types::DescribeApplicationProviderResponse
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.
-
#describe_instance(params = {}) ⇒ Types::DescribeInstanceResponse
Returns the details of an instance of IAM Identity Center.
-
#describe_instance_access_control_attribute_configuration(params = {}) ⇒ Types::DescribeInstanceAccessControlAttributeConfigurationResponse
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.
-
#describe_permission_set(params = {}) ⇒ Types::DescribePermissionSetResponse
Gets the details of the permission set.
-
#describe_permission_set_provisioning_status(params = {}) ⇒ Types::DescribePermissionSetProvisioningStatusResponse
Describes the status for the given permission set provisioning request.
-
#describe_trusted_token_issuer(params = {}) ⇒ Types::DescribeTrustedTokenIssuerResponse
Retrieves details about a trusted token issuer configuration stored in an instance of IAM Identity Center.
-
#detach_customer_managed_policy_reference_from_permission_set(params = {}) ⇒ Struct
Detaches the specified customer managed policy from the specified PermissionSet.
-
#detach_managed_policy_from_permission_set(params = {}) ⇒ Struct
Detaches the attached Amazon Web Services managed policy ARN from the specified permission set.
-
#get_application_access_scope(params = {}) ⇒ Types::GetApplicationAccessScopeResponse
Retrieves the authorized targets for an IAM Identity Center access scope for an application.
-
#get_application_assignment_configuration(params = {}) ⇒ Types::GetApplicationAssignmentConfigurationResponse
Retrieves the configuration of PutApplicationAssignmentConfiguration.
-
#get_application_authentication_method(params = {}) ⇒ Types::GetApplicationAuthenticationMethodResponse
Retrieves details about an authentication method used by an application.
-
#get_application_grant(params = {}) ⇒ Types::GetApplicationGrantResponse
Retrieves details about an application grant.
-
#get_inline_policy_for_permission_set(params = {}) ⇒ Types::GetInlinePolicyForPermissionSetResponse
Obtains the inline policy assigned to the permission set.
-
#get_permissions_boundary_for_permission_set(params = {}) ⇒ Types::GetPermissionsBoundaryForPermissionSetResponse
Obtains the permissions boundary for a specified PermissionSet.
-
#list_account_assignment_creation_status(params = {}) ⇒ Types::ListAccountAssignmentCreationStatusResponse
Lists the status of the Amazon Web Services account assignment creation requests for a specified IAM Identity Center instance.
-
#list_account_assignment_deletion_status(params = {}) ⇒ Types::ListAccountAssignmentDeletionStatusResponse
Lists the status of the Amazon Web Services account assignment deletion requests for a specified IAM Identity Center instance.
-
#list_account_assignments(params = {}) ⇒ Types::ListAccountAssignmentsResponse
Lists the assignee of the specified Amazon Web Services account with the specified permission set.
-
#list_account_assignments_for_principal(params = {}) ⇒ Types::ListAccountAssignmentsForPrincipalResponse
Retrieves a list of the IAM Identity Center associated Amazon Web Services accounts that the principal has access to.
-
#list_accounts_for_provisioned_permission_set(params = {}) ⇒ Types::ListAccountsForProvisionedPermissionSetResponse
Lists all the Amazon Web Services accounts where the specified permission set is provisioned.
-
#list_application_access_scopes(params = {}) ⇒ Types::ListApplicationAccessScopesResponse
Lists the access scopes and authorized targets associated with an application.
-
#list_application_assignments(params = {}) ⇒ Types::ListApplicationAssignmentsResponse
Lists Amazon Web Services account users that are assigned to an application.
-
#list_application_assignments_for_principal(params = {}) ⇒ Types::ListApplicationAssignmentsForPrincipalResponse
Lists the applications to which a specified principal is assigned.
-
#list_application_authentication_methods(params = {}) ⇒ Types::ListApplicationAuthenticationMethodsResponse
Lists all of the authentication methods supported by the specified application.
-
#list_application_grants(params = {}) ⇒ Types::ListApplicationGrantsResponse
List the grants associated with an application.
-
#list_application_providers(params = {}) ⇒ Types::ListApplicationProvidersResponse
Lists the application providers configured in the IAM Identity Center identity store.
-
#list_applications(params = {}) ⇒ Types::ListApplicationsResponse
Lists all applications associated with the instance of IAM Identity Center.
-
#list_customer_managed_policy_references_in_permission_set(params = {}) ⇒ Types::ListCustomerManagedPolicyReferencesInPermissionSetResponse
Lists all customer managed policies attached to a specified PermissionSet.
-
#list_instances(params = {}) ⇒ Types::ListInstancesResponse
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.
-
#list_managed_policies_in_permission_set(params = {}) ⇒ Types::ListManagedPoliciesInPermissionSetResponse
Lists the Amazon Web Services managed policy that is attached to a specified permission set.
-
#list_permission_set_provisioning_status(params = {}) ⇒ Types::ListPermissionSetProvisioningStatusResponse
Lists the status of the permission set provisioning requests for a specified IAM Identity Center instance.
-
#list_permission_sets(params = {}) ⇒ Types::ListPermissionSetsResponse
Lists the PermissionSets in an IAM Identity Center instance.
-
#list_permission_sets_provisioned_to_account(params = {}) ⇒ Types::ListPermissionSetsProvisionedToAccountResponse
Lists all the permission sets that are provisioned to a specified Amazon Web Services account.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists the tags that are attached to a specified resource.
-
#list_trusted_token_issuers(params = {}) ⇒ Types::ListTrustedTokenIssuersResponse
Lists all the trusted token issuers configured in an instance of IAM Identity Center.
-
#provision_permission_set(params = {}) ⇒ Types::ProvisionPermissionSetResponse
The process by which a specified permission set is provisioned to the specified target.
-
#put_application_access_scope(params = {}) ⇒ Struct
Adds or updates the list of authorized targets for an IAM Identity Center access scope for an application.
-
#put_application_assignment_configuration(params = {}) ⇒ Struct
Configure how users gain access to an application.
-
#put_application_authentication_method(params = {}) ⇒ Struct
Adds or updates an authentication method for an application.
-
#put_application_grant(params = {}) ⇒ Struct
Creates a configuration for an application to use grants.
-
#put_inline_policy_to_permission_set(params = {}) ⇒ Struct
Attaches an inline policy to a permission set.
-
#put_permissions_boundary_to_permission_set(params = {}) ⇒ Struct
Attaches an Amazon Web Services managed or customer managed policy to the specified PermissionSet as a permissions boundary.
-
#tag_resource(params = {}) ⇒ Struct
Associates a set of tags with a specified resource.
-
#untag_resource(params = {}) ⇒ Struct
Disassociates a set of tags from a specified resource.
-
#update_application(params = {}) ⇒ Struct
Updates application properties.
-
#update_instance(params = {}) ⇒ Struct
Update the details for the instance of IAM Identity Center that is owned by the Amazon Web Services account.
-
#update_instance_access_control_attribute_configuration(params = {}) ⇒ Struct
Updates the IAM Identity Center identity store attributes that you can use with the IAM Identity Center instance for attributes-based access control (ABAC).
-
#update_permission_set(params = {}) ⇒ Struct
Updates an existing permission set.
-
#update_trusted_token_issuer(params = {}) ⇒ Struct
Updates the name of the trusted token issuer, or the path of a source attribute or destination attribute for a trusted token issuer configuration.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
473 474 475 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 473 def initialize(*args) super end |
Instance Method Details
#attach_customer_managed_policy_reference_to_permission_set(params = {}) ⇒ Struct
Attaches the specified customer managed policy to the specified PermissionSet.
511 512 513 514 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 511 def (params = {}, = {}) req = build_request(:attach_customer_managed_policy_reference_to_permission_set, params) req.send_request() end |
#attach_managed_policy_to_permission_set(params = {}) ⇒ Struct
Attaches an Amazon Web Services managed policy ARN to a permission set.
ProvisionPermissionSet
after
this operation. Calling ProvisionPermissionSet
applies the
corresponding IAM policy updates to all assigned accounts.
555 556 557 558 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 555 def (params = {}, = {}) req = build_request(:attach_managed_policy_to_permission_set, params) req.send_request() end |
#create_account_assignment(params = {}) ⇒ Types::CreateAccountAssignmentResponse
Assigns access to a principal for a specified Amazon Web Services account using a specified permission set.
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.
DescribeAccountAssignmentCreationStatus
to describe the status of an
assignment creation request.
644 645 646 647 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 644 def create_account_assignment(params = {}, = {}) req = build_request(:create_account_assignment, params) req.send_request() end |
#create_application(params = {}) ⇒ Types::CreateApplicationResponse
Creates an OAuth 2.0 customer managed application in IAM Identity Center for the given application provider.
753 754 755 756 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 753 def create_application(params = {}, = {}) req = build_request(:create_application, params) req.send_request() end |
#create_application_assignment(params = {}) ⇒ Struct
Grant application access to a user or group.
791 792 793 794 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 791 def create_application_assignment(params = {}, = {}) req = build_request(:create_application_assignment, params) req.send_request() end |
#create_instance(params = {}) ⇒ Types::CreateInstanceResponse
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.
860 861 862 863 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 860 def create_instance(params = {}, = {}) req = build_request(:create_instance, params) req.send_request() end |
#create_instance_access_control_attribute_configuration(params = {}) ⇒ Struct
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.
DescribeInstanceAccessControlAttributeConfiguration
to validate that
InstanceAccessControlAttributeConfiguration
was created.
914 915 916 917 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 914 def create_instance_access_control_attribute_configuration(params = {}, = {}) req = build_request(:create_instance_access_control_attribute_configuration, params) req.send_request() end |
#create_permission_set(params = {}) ⇒ Types::CreatePermissionSetResponse
Creates a permission set within a specified IAM Identity Center instance.
CreateAccountAssignment
.
984 985 986 987 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 984 def (params = {}, = {}) req = build_request(:create_permission_set, params) req.send_request() end |
#create_trusted_token_issuer(params = {}) ⇒ Types::CreateTrustedTokenIssuerResponse
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.
1075 1076 1077 1078 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 1075 def create_trusted_token_issuer(params = {}, = {}) req = build_request(:create_trusted_token_issuer, params) req.send_request() end |
#delete_account_assignment(params = {}) ⇒ Types::DeleteAccountAssignmentResponse
Deletes a principal's access from a specified Amazon Web Services account using a specified permission set.
DescribeAccountAssignmentDeletionStatus
to describe the status of an
assignment deletion request.
1148 1149 1150 1151 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 1148 def delete_account_assignment(params = {}, = {}) req = build_request(:delete_account_assignment, params) req.send_request() end |
#delete_application(params = {}) ⇒ Struct
Deletes the association with the application. The connected service resource still exists.
1174 1175 1176 1177 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 1174 def delete_application(params = {}, = {}) req = build_request(:delete_application, params) req.send_request() end |
#delete_application_access_scope(params = {}) ⇒ Struct
Deletes an IAM Identity Center access scope from an application.
1200 1201 1202 1203 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 1200 def delete_application_access_scope(params = {}, = {}) req = build_request(:delete_application_access_scope, params) req.send_request() end |
#delete_application_assignment(params = {}) ⇒ Struct
Revoke application access to an application by deleting application assignments for a user or group.
1239 1240 1241 1242 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 1239 def delete_application_assignment(params = {}, = {}) req = build_request(:delete_application_assignment, params) req.send_request() end |
#delete_application_authentication_method(params = {}) ⇒ Struct
Deletes an authentication method from an application.
1267 1268 1269 1270 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 1267 def delete_application_authentication_method(params = {}, = {}) req = build_request(:delete_application_authentication_method, params) req.send_request() end |
#delete_application_grant(params = {}) ⇒ Struct
Deletes a grant from an application.
1293 1294 1295 1296 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 1293 def delete_application_grant(params = {}, = {}) req = build_request(:delete_application_grant, params) req.send_request() end |
#delete_inline_policy_from_permission_set(params = {}) ⇒ Struct
Deletes the inline policy from a specified permission set.
1323 1324 1325 1326 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 1323 def (params = {}, = {}) req = build_request(:delete_inline_policy_from_permission_set, params) req.send_request() end |
#delete_instance(params = {}) ⇒ Struct
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.
1349 1350 1351 1352 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 1349 def delete_instance(params = {}, = {}) req = build_request(:delete_instance, params) req.send_request() end |
#delete_instance_access_control_attribute_configuration(params = {}) ⇒ Struct
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.
1379 1380 1381 1382 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 1379 def delete_instance_access_control_attribute_configuration(params = {}, = {}) req = build_request(:delete_instance_access_control_attribute_configuration, params) req.send_request() end |
#delete_permission_set(params = {}) ⇒ Struct
Deletes the specified permission set.
1409 1410 1411 1412 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 1409 def (params = {}, = {}) req = build_request(:delete_permission_set, params) req.send_request() end |
#delete_permissions_boundary_from_permission_set(params = {}) ⇒ Struct
Deletes the permissions boundary from a specified PermissionSet.
1436 1437 1438 1439 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 1436 def (params = {}, = {}) req = build_request(:delete_permissions_boundary_from_permission_set, params) req.send_request() end |
#delete_trusted_token_issuer(params = {}) ⇒ Struct
Deletes a trusted token issuer configuration from an instance of IAM Identity Center.
1465 1466 1467 1468 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 1465 def delete_trusted_token_issuer(params = {}, = {}) req = build_request(:delete_trusted_token_issuer, params) req.send_request() end |
#describe_account_assignment_creation_status(params = {}) ⇒ Types::DescribeAccountAssignmentCreationStatusResponse
Describes the status of the assignment creation request.
1509 1510 1511 1512 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 1509 def describe_account_assignment_creation_status(params = {}, = {}) req = build_request(:describe_account_assignment_creation_status, params) req.send_request() end |
#describe_account_assignment_deletion_status(params = {}) ⇒ Types::DescribeAccountAssignmentDeletionStatusResponse
Describes the status of the assignment deletion request.
1553 1554 1555 1556 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 1553 def describe_account_assignment_deletion_status(params = {}, = {}) req = build_request(:describe_account_assignment_deletion_status, params) req.send_request() end |
#describe_application(params = {}) ⇒ Types::DescribeApplicationResponse
Retrieves the details of an application associated with an instance of IAM Identity Center.
1603 1604 1605 1606 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 1603 def describe_application(params = {}, = {}) req = build_request(:describe_application, params) req.send_request() end |
#describe_application_assignment(params = {}) ⇒ Types::DescribeApplicationAssignmentResponse
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.
1658 1659 1660 1661 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 1658 def describe_application_assignment(params = {}, = {}) req = build_request(:describe_application_assignment, params) req.send_request() end |
#describe_application_provider(params = {}) ⇒ Types::DescribeApplicationProviderResponse
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.
1699 1700 1701 1702 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 1699 def describe_application_provider(params = {}, = {}) req = build_request(:describe_application_provider, params) req.send_request() end |
#describe_instance(params = {}) ⇒ Types::DescribeInstanceResponse
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 ofACTIVE
. While the instance is in theCREATE_IN_PROGRESS
state, you can call only DescribeInstance and DeleteInstance operations.DELETE_IN_PROGRESS
- The instance is being deleted. ReturnsAccessDeniedException
after the delete operation completes.ACTIVE
- The instance is active.
1750 1751 1752 1753 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 1750 def describe_instance(params = {}, = {}) req = build_request(:describe_instance, params) req.send_request() end |
#describe_instance_access_control_attribute_configuration(params = {}) ⇒ Types::DescribeInstanceAccessControlAttributeConfigurationResponse
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.
1792 1793 1794 1795 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 1792 def describe_instance_access_control_attribute_configuration(params = {}, = {}) req = build_request(:describe_instance_access_control_attribute_configuration, params) req.send_request() end |
#describe_permission_set(params = {}) ⇒ Types::DescribePermissionSetResponse
Gets the details of the permission set.
1833 1834 1835 1836 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 1833 def (params = {}, = {}) req = build_request(:describe_permission_set, params) req.send_request() end |
#describe_permission_set_provisioning_status(params = {}) ⇒ Types::DescribePermissionSetProvisioningStatusResponse
Describes the status for the given permission set provisioning request.
1876 1877 1878 1879 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 1876 def (params = {}, = {}) req = build_request(:describe_permission_set_provisioning_status, params) req.send_request() end |
#describe_trusted_token_issuer(params = {}) ⇒ Types::DescribeTrustedTokenIssuerResponse
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.
1918 1919 1920 1921 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 1918 def describe_trusted_token_issuer(params = {}, = {}) req = build_request(:describe_trusted_token_issuer, params) req.send_request() end |
#detach_customer_managed_policy_reference_from_permission_set(params = {}) ⇒ Struct
Detaches the specified customer managed policy from the specified PermissionSet.
1955 1956 1957 1958 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 1955 def (params = {}, = {}) req = build_request(:detach_customer_managed_policy_reference_from_permission_set, params) req.send_request() end |
#detach_managed_policy_from_permission_set(params = {}) ⇒ Struct
Detaches the attached Amazon Web Services managed policy ARN from the specified permission set.
1991 1992 1993 1994 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 1991 def (params = {}, = {}) req = build_request(:detach_managed_policy_from_permission_set, params) req.send_request() end |
#get_application_access_scope(params = {}) ⇒ Types::GetApplicationAccessScopeResponse
Retrieves the authorized targets for an IAM Identity Center access scope for an application.
2029 2030 2031 2032 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 2029 def get_application_access_scope(params = {}, = {}) req = build_request(:get_application_access_scope, params) req.send_request() end |
#get_application_assignment_configuration(params = {}) ⇒ Types::GetApplicationAssignmentConfigurationResponse
Retrieves the configuration of PutApplicationAssignmentConfiguration.
2060 2061 2062 2063 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 2060 def get_application_assignment_configuration(params = {}, = {}) req = build_request(:get_application_assignment_configuration, params) req.send_request() end |
#get_application_authentication_method(params = {}) ⇒ Types::GetApplicationAuthenticationMethodResponse
Retrieves details about an authentication method used by an application.
2094 2095 2096 2097 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 2094 def get_application_authentication_method(params = {}, = {}) req = build_request(:get_application_authentication_method, params) req.send_request() end |
#get_application_grant(params = {}) ⇒ Types::GetApplicationGrantResponse
Retrieves details about an application grant.
2131 2132 2133 2134 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 2131 def get_application_grant(params = {}, = {}) req = build_request(:get_application_grant, params) req.send_request() end |
#get_inline_policy_for_permission_set(params = {}) ⇒ Types::GetInlinePolicyForPermissionSetResponse
Obtains the inline policy assigned to the permission set.
2167 2168 2169 2170 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 2167 def (params = {}, = {}) req = build_request(:get_inline_policy_for_permission_set, params) req.send_request() end |
#get_permissions_boundary_for_permission_set(params = {}) ⇒ Types::GetPermissionsBoundaryForPermissionSetResponse
Obtains the permissions boundary for a specified PermissionSet.
2202 2203 2204 2205 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 2202 def (params = {}, = {}) req = build_request(:get_permissions_boundary_for_permission_set, params) req.send_request() end |
#list_account_assignment_creation_status(params = {}) ⇒ Types::ListAccountAssignmentCreationStatusResponse
Lists the status of the Amazon Web Services account assignment creation requests for a specified IAM Identity Center instance.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2257 2258 2259 2260 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 2257 def list_account_assignment_creation_status(params = {}, = {}) req = build_request(:list_account_assignment_creation_status, params) req.send_request() end |
#list_account_assignment_deletion_status(params = {}) ⇒ Types::ListAccountAssignmentDeletionStatusResponse
Lists the status of the Amazon Web Services account assignment deletion requests for a specified IAM Identity Center instance.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2312 2313 2314 2315 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 2312 def list_account_assignment_deletion_status(params = {}, = {}) req = build_request(:list_account_assignment_deletion_status, params) req.send_request() end |
#list_account_assignments(params = {}) ⇒ Types::ListAccountAssignmentsResponse
Lists the assignee of the specified Amazon Web Services account with the specified permission set.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2371 2372 2373 2374 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 2371 def list_account_assignments(params = {}, = {}) req = build_request(:list_account_assignments, params) req.send_request() end |
#list_account_assignments_for_principal(params = {}) ⇒ Types::ListAccountAssignmentsForPrincipalResponse
Retrieves a list of the IAM Identity Center associated Amazon Web Services accounts that the principal has access to. This action must be called from the management account containing your organization instance of IAM Identity Center. This action is not valid for account instances of IAM Identity Center.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2447 2448 2449 2450 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 2447 def list_account_assignments_for_principal(params = {}, = {}) req = build_request(:list_account_assignments_for_principal, params) req.send_request() end |
#list_accounts_for_provisioned_permission_set(params = {}) ⇒ Types::ListAccountsForProvisionedPermissionSetResponse
Lists all the Amazon Web Services accounts where the specified permission set is provisioned.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2504 2505 2506 2507 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 2504 def (params = {}, = {}) req = build_request(:list_accounts_for_provisioned_permission_set, params) req.send_request() end |
#list_application_access_scopes(params = {}) ⇒ Types::ListApplicationAccessScopesResponse
Lists the access scopes and authorized targets associated with an application.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2559 2560 2561 2562 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 2559 def list_application_access_scopes(params = {}, = {}) req = build_request(:list_application_access_scopes, params) req.send_request() end |
#list_application_assignments(params = {}) ⇒ Types::ListApplicationAssignmentsResponse
Lists Amazon Web Services account users that are assigned to an application.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2614 2615 2616 2617 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 2614 def list_application_assignments(params = {}, = {}) req = build_request(:list_application_assignments, params) req.send_request() end |
#list_application_assignments_for_principal(params = {}) ⇒ Types::ListApplicationAssignmentsForPrincipalResponse
Lists the applications to which a specified principal is assigned. You must provide a filter when calling this action from a member account against your organization instance of IAM Identity Center. A filter is not required when called from the management account against an organization instance of IAM Identity Center, or from a member account against an account instance of IAM Identity Center in the same account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2692 2693 2694 2695 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 2692 def list_application_assignments_for_principal(params = {}, = {}) req = build_request(:list_application_assignments_for_principal, params) req.send_request() end |
#list_application_authentication_methods(params = {}) ⇒ Types::ListApplicationAuthenticationMethodsResponse
Lists all of the authentication methods supported by the specified application.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2735 2736 2737 2738 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 2735 def list_application_authentication_methods(params = {}, = {}) req = build_request(:list_application_authentication_methods, params) req.send_request() end |
#list_application_grants(params = {}) ⇒ Types::ListApplicationGrantsResponse
List the grants associated with an application.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2782 2783 2784 2785 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 2782 def list_application_grants(params = {}, = {}) req = build_request(:list_application_grants, params) req.send_request() end |
#list_application_providers(params = {}) ⇒ Types::ListApplicationProvidersResponse
Lists the application providers configured in the IAM Identity Center identity store.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2838 2839 2840 2841 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 2838 def list_application_providers(params = {}, = {}) req = build_request(:list_application_providers, params) req.send_request() end |
#list_applications(params = {}) ⇒ Types::ListApplicationsResponse
Lists all applications associated with the instance of IAM Identity
Center. When listing applications for an organization instance in the
management account, member accounts must use the applicationAccount
parameter to filter the list to only applications created from that
account. When listing applications for an account instance in the same
member account, a filter is not required.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2916 2917 2918 2919 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 2916 def list_applications(params = {}, = {}) req = build_request(:list_applications, params) req.send_request() end |
#list_customer_managed_policy_references_in_permission_set(params = {}) ⇒ Types::ListCustomerManagedPolicyReferencesInPermissionSetResponse
Lists all customer managed policies attached to a specified PermissionSet.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2965 2966 2967 2968 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 2965 def (params = {}, = {}) req = build_request(:list_customer_managed_policy_references_in_permission_set, params) req.send_request() end |
#list_instances(params = {}) ⇒ Types::ListInstancesResponse
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3010 3011 3012 3013 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 3010 def list_instances(params = {}, = {}) req = build_request(:list_instances, params) req.send_request() end |
#list_managed_policies_in_permission_set(params = {}) ⇒ Types::ListManagedPoliciesInPermissionSetResponse
Lists the Amazon Web Services managed policy that is attached to a specified permission set.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3062 3063 3064 3065 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 3062 def (params = {}, = {}) req = build_request(:list_managed_policies_in_permission_set, params) req.send_request() end |
#list_permission_set_provisioning_status(params = {}) ⇒ Types::ListPermissionSetProvisioningStatusResponse
Lists the status of the permission set provisioning requests for a specified IAM Identity Center instance.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3117 3118 3119 3120 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 3117 def (params = {}, = {}) req = build_request(:list_permission_set_provisioning_status, params) req.send_request() end |
#list_permission_sets(params = {}) ⇒ Types::ListPermissionSetsResponse
Lists the PermissionSets in an IAM Identity Center instance.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3163 3164 3165 3166 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 3163 def (params = {}, = {}) req = build_request(:list_permission_sets, params) req.send_request() end |
#list_permission_sets_provisioned_to_account(params = {}) ⇒ Types::ListPermissionSetsProvisionedToAccountResponse
Lists all the permission sets that are provisioned to a specified Amazon Web Services account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3219 3220 3221 3222 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 3219 def (params = {}, = {}) req = build_request(:list_permission_sets_provisioned_to_account, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists the tags that are attached to a specified resource.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3266 3267 3268 3269 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 3266 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#list_trusted_token_issuers(params = {}) ⇒ Types::ListTrustedTokenIssuersResponse
Lists all the trusted token issuers configured in an instance of IAM Identity Center.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3322 3323 3324 3325 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 3322 def list_trusted_token_issuers(params = {}, = {}) req = build_request(:list_trusted_token_issuers, params) req.send_request() end |
#provision_permission_set(params = {}) ⇒ Types::ProvisionPermissionSetResponse
The process by which a specified permission set is provisioned to the specified target.
3373 3374 3375 3376 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 3373 def (params = {}, = {}) req = build_request(:provision_permission_set, params) req.send_request() end |
#put_application_access_scope(params = {}) ⇒ Struct
Adds or updates the list of authorized targets for an IAM Identity Center access scope for an application.
3407 3408 3409 3410 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 3407 def put_application_access_scope(params = {}, = {}) req = build_request(:put_application_access_scope, params) req.send_request() end |
#put_application_assignment_configuration(params = {}) ⇒ Struct
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
.
3453 3454 3455 3456 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 3453 def put_application_assignment_configuration(params = {}, = {}) req = build_request(:put_application_assignment_configuration, params) req.send_request() end |
#put_application_authentication_method(params = {}) ⇒ Struct
Adds or updates an authentication method for an application.
3492 3493 3494 3495 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 3492 def put_application_authentication_method(params = {}, = {}) req = build_request(:put_application_authentication_method, params) req.send_request() end |
#put_application_grant(params = {}) ⇒ Struct
Creates a configuration for an application to use grants. Conceptually grants are authorization to request actions related to tokens. This configuration will be used when parties are requesting and receiving tokens during the trusted identity propagation process. For more information on the IAM Identity Center supported grant workflows, see SAML 2.0 and OAuth 2.0.
A grant is created between your applications and Identity Center instance which enables an application to use specified mechanisms to obtain tokens. These tokens are used by your applications to gain access to Amazon Web Services resources on behalf of users. The following elements are within these exchanges:
Requester - The application requesting access to Amazon Web Services resources.
Subject - Typically the user that is requesting access to Amazon Web Services resources.
Grant - Conceptually, a grant is authorization to access Amazon Web Services resources. These grants authorize token generation for authenticating access to the requester and for the request to make requests on behalf of the subjects. There are four types of grants:
AuthorizationCode - Allows an application to request authorization through a series of user-agent redirects.
JWT bearer - Authorizes an application to exchange a JSON Web Token that came from an external identity provider. To learn more, see RFC 6479.
Refresh token - Enables application to request new access tokens to replace expiring or expired access tokens.
Exchange token - A grant that requests tokens from the authorization server by providing a ‘subject’ token with access scope authorizing trusted identity propagation to this application. To learn more, see RFC 8693.
- Authorization server - IAM Identity Center requests tokens.
User credentials are never shared directly within these exchanges. Instead, applications use grants to request access tokens from IAM Identity Center. For more information, see RFC 6479.
Use cases
Connecting to custom applications.
Configuring an Amazon Web Services service to make calls to another Amazon Web Services services using JWT tokens.
3593 3594 3595 3596 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 3593 def put_application_grant(params = {}, = {}) req = build_request(:put_application_grant, params) req.send_request() end |
#put_inline_policy_to_permission_set(params = {}) ⇒ Struct
Attaches an inline policy to a permission set.
ProvisionPermissionSet
after
this action to apply the corresponding IAM policy updates to all
assigned accounts.
3634 3635 3636 3637 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 3634 def (params = {}, = {}) req = build_request(:put_inline_policy_to_permission_set, params) req.send_request() end |
#put_permissions_boundary_to_permission_set(params = {}) ⇒ Struct
Attaches an Amazon Web Services managed or customer managed policy to the specified PermissionSet as a permissions boundary.
3672 3673 3674 3675 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 3672 def (params = {}, = {}) req = build_request(:put_permissions_boundary_to_permission_set, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Associates a set of tags with a specified resource.
3711 3712 3713 3714 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 3711 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Disassociates a set of tags from a specified resource.
3745 3746 3747 3748 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 3745 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_application(params = {}) ⇒ Struct
Updates application properties.
3792 3793 3794 3795 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 3792 def update_application(params = {}, = {}) req = build_request(:update_application, params) req.send_request() end |
#update_instance(params = {}) ⇒ Struct
Update the details for the instance of IAM Identity Center that is owned by the Amazon Web Services account.
3823 3824 3825 3826 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 3823 def update_instance(params = {}, = {}) req = build_request(:update_instance, params) req.send_request() end |
#update_instance_access_control_attribute_configuration(params = {}) ⇒ Struct
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.
3869 3870 3871 3872 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 3869 def update_instance_access_control_attribute_configuration(params = {}, = {}) req = build_request(:update_instance_access_control_attribute_configuration, params) req.send_request() end |
#update_permission_set(params = {}) ⇒ Struct
Updates an existing permission set.
3913 3914 3915 3916 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 3913 def (params = {}, = {}) req = build_request(:update_permission_set, params) req.send_request() end |
#update_trusted_token_issuer(params = {}) ⇒ Struct
Updates the name of the trusted token issuer, or the path of a source attribute or destination attribute for a trusted token issuer configuration.
3961 3962 3963 3964 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 3961 def update_trusted_token_issuer(params = {}, = {}) req = build_request(:update_trusted_token_issuer, params) req.send_request() end |