AWS IAM Identity Center (successor to AWS Single Sign-On) helps you securely create, or connect, your workforce identities and manage their access centrally across AWS accounts and applications. IAM Identity Center is the recommended approach for workforce authentication and authorization in AWS, for organizations of any size and type.
Although AWS Single Sign-On was renamed, the sso and identitystore
API namespaces will continue to retain their original name for backward
compatibility purposes. For more information, see IAM Identity Center rename.
This reference guide provides information on single sign-on operations which could be used for access management of AWS accounts. For information about IAM Identity Center features, see the IAM Identity Center User Guide.
Many operations in the IAM Identity Center APIs rely on identifiers for users and groups, known as principals. For more information about how to work with principals and principal IDs in IAM Identity Center, see the Identity Store API Reference.
AWS provides SDKs that consist of libraries and sample code for various programming languages and platforms (Java, Ruby, .Net, iOS, Android, and more). The SDKs provide a convenient way to create programmatic access to IAM Identity Center and other AWS services. For more information about the AWS SDKs, including how to download and install them, see Tools for Amazon Web Services.
ssoadmin(config = list(), credentials = list(), endpoint = NULL, region = NULL)A client for the service. You can call the service's operations using
syntax like svc$operation(...), where svc is the name you've assigned
to the client. The available operations are listed in the
Operations section.
Optional configuration of credentials, endpoint, and/or region.
credentials:
creds:
access_key_id: AWS access key ID
secret_access_key: AWS secret access key
session_token: AWS temporary session token
profile: The name of a profile to use. If not given, then the default profile is used.
anonymous: Set anonymous credentials.
endpoint: The complete URL to use for the constructed client.
region: The AWS Region used in instantiating the client.
close_connection: Immediately close all HTTP connections.
timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.
s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e. http://s3.amazonaws.com/BUCKET/KEY.
sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html
Optional credentials shorthand for the config parameter
creds:
access_key_id: AWS access key ID
secret_access_key: AWS secret access key
session_token: AWS temporary session token
profile: The name of a profile to use. If not given, then the default profile is used.
anonymous: Set anonymous credentials.
Optional shorthand for complete URL to use for the constructed client.
Optional shorthand for AWS Region used in instantiating the client.
svc <- ssoadmin(
config = list(
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string",
close_connection = "logical",
timeout = "numeric",
s3_force_path_style = "logical",
sts_regional_endpoint = "string"
),
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string"
)
| attach_customer_managed_policy_reference_to_permission_set | Attaches the specified customer managed policy to the specified PermissionSet |
| attach_managed_policy_to_permission_set | Attaches an AWS managed policy ARN to a permission set |
| create_account_assignment | Assigns access to a principal for a specified AWS account using a specified permission set |
| create_instance_access_control_attribute_configuration | Enables the attributes-based access control (ABAC) feature for the specified IAM Identity Center instance |
| create_permission_set | Creates a permission set within a specified IAM Identity Center instance |
| delete_account_assignment | Deletes a principal's access from a specified AWS account using a specified permission set |
| delete_inline_policy_from_permission_set | Deletes the inline policy from a specified permission set |
| delete_instance_access_control_attribute_configuration | 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_permissions_boundary_from_permission_set | Deletes the permissions boundary from a specified PermissionSet |
| delete_permission_set | Deletes the specified permission set |
| describe_account_assignment_creation_status | Describes the status of the assignment creation request |
| describe_account_assignment_deletion_status | Describes the status of the assignment deletion request |
| describe_instance_access_control_attribute_configuration | 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 | Gets the details of the permission set |
| describe_permission_set_provisioning_status | Describes the status for the given permission set provisioning request |
| detach_customer_managed_policy_reference_from_permission_set | Detaches the specified customer managed policy from the specified PermissionSet |
| detach_managed_policy_from_permission_set | Detaches the attached AWS managed policy ARN from the specified permission set |
| get_inline_policy_for_permission_set | Obtains the inline policy assigned to the permission set |
| get_permissions_boundary_for_permission_set | Obtains the permissions boundary for a specified PermissionSet |
| list_account_assignment_creation_status | Lists the status of the AWS account assignment creation requests for a specified IAM Identity Center instance |
| list_account_assignment_deletion_status | Lists the status of the AWS account assignment deletion requests for a specified IAM Identity Center instance |
| list_account_assignments | Lists the assignee of the specified AWS account with the specified permission set |
| list_accounts_for_provisioned_permission_set | Lists all the AWS accounts where the specified permission set is provisioned |
| list_customer_managed_policy_references_in_permission_set | Lists all customer managed policies attached to a specified PermissionSet |
| list_instances | Lists the IAM Identity Center instances that the caller has access to |
| list_managed_policies_in_permission_set | Lists the AWS managed policy that is attached to a specified permission set |
| list_permission_set_provisioning_status | Lists the status of the permission set provisioning requests for a specified IAM Identity Center instance |
| list_permission_sets | Lists the PermissionSets in an IAM Identity Center instance |
| list_permission_sets_provisioned_to_account | Lists all the permission sets that are provisioned to a specified AWS account |
| list_tags_for_resource | Lists the tags that are attached to a specified resource |
| provision_permission_set | The process by which a specified permission set is provisioned to the specified target |
| put_inline_policy_to_permission_set | Attaches an inline policy to a permission set |
| put_permissions_boundary_to_permission_set | Attaches an AWS managed or customer managed policy to the specified PermissionSet as a permissions boundary |
| tag_resource | Associates a set of tags with a specified resource |
| untag_resource | Disassociates a set of tags from a specified resource |
| update_instance_access_control_attribute_configuration | 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 | Updates an existing permission set |
if (FALSE) {
svc <- ssoadmin()
svc$attach_customer_managed_policy_reference_to_permission_set(
Foo = 123
)
}
Run the code above in your browser using DataLab