Client

ssoadmin

R Documentation

AWS Single Sign-On Admin¶

Description¶

IAM Identity Center (successor to Single Sign-On) helps you securely create, or connect, your workforce identities and manage their access centrally across Amazon Web Services accounts and applications. IAM Identity Center is the recommended approach for workforce authentication and authorization in Amazon Web Services, for organizations of any size and type.

IAM Identity Center uses the sso and identitystore API namespaces.

This reference guide provides information on single sign-on operations which could be used for access management of Amazon Web Services 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.

Amazon Web Services 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 Amazon Web Services services. For more information about the Amazon Web Services SDKs, including how to download and install them, see Tools for Amazon Web Services.

Usage¶

ssoadmin(config = list(), credentials = list(), endpoint = NULL, region = NULL)

Arguments¶

config

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

credentials

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.

endpoint

Optional shorthand for complete URL to use for the constructed client.

region

Optional shorthand for AWS Region used in instantiating the client.

Value¶

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.

Service syntax¶

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"
)

Operations¶

Attaches the specified customer managed policy to the specified PermissionSet; Attaches an Amazon Web Services managed policy ARN to a permission set
create_account_assignment: Assigns access to a principal for a specified Amazon Web Services account using a specified permission set
create_application: Creates an application in IAM Identity Center for the given application provider
create_application_assignment: Grant application access to a user or group
create_instance: 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; 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
create_trusted_token_issuer: Creates a connection to a trusted token issuer in an instance of IAM Identity Center
delete_account_assignment: Deletes a principal's access from a specified Amazon Web Services account using a specified permission set
delete_application: Deletes the association with the application
delete_application_access_scope: Deletes an IAM Identity Center access scope from an application
delete_application_assignment: Revoke application access to an application by deleting application assignments for a user or group; Deletes an authentication method from an application
delete_application_grant: Deletes a grant from an application; Deletes the inline policy from a specified permission set
delete_instance: Deletes the instance of IAM Identity Center; 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; Deletes the permissions boundary from a specified PermissionSet
delete_permission_set: Deletes the specified permission set
delete_trusted_token_issuer: Deletes a trusted token issuer configuration from an instance of IAM Identity Center; Describes the status of the assignment creation request; Describes the status of the assignment deletion request
describe_application: Retrieves the details of an application associated with an instance of IAM Identity Center
describe_application_assignment: Retrieves a direct assignment of a user or group to an application
describe_application_provider: 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: Returns the details of an instance of IAM Identity Center; 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; Describes the status for the given permission set provisioning request
describe_trusted_token_issuer: Retrieves details about a trusted token issuer configuration stored in an instance of IAM Identity Center; Detaches the specified customer managed policy from the specified PermissionSet; Detaches the attached Amazon Web Services managed policy ARN from the specified permission set
get_application_access_scope: Retrieves the authorized targets for an IAM Identity Center access scope for an application; Retrieves the configuration of PutApplicationAssignmentConfiguration
get_application_authentication_method: Retrieves details about an authentication method used by an application
get_application_grant: Retrieves details about an application grant
get_inline_policy_for_permission_set: Obtains the inline policy assigned to the permission set; Obtains the permissions boundary for a specified PermissionSet; Lists the status of the Amazon Web Services account assignment creation requests for a specified IAM Identity Center instance; Lists the status of the Amazon Web Services account assignment deletion requests for a specified IAM Identity Center instance
list_account_assignments: Lists the assignee of the specified Amazon Web Services account with the specified permission set; Retrieves a list of the IAM Identity Center associated Amazon Web Services accounts that the principal has access to; Lists all the Amazon Web Services accounts where the specified permission set is provisioned
list_application_access_scopes: Lists the access scopes and authorized targets associated with an application
list_application_assignments: Lists Amazon Web Services account users that are assigned to an application; Lists the applications to which a specified principal is assigned; Lists all of the authentication methods supported by the specified application
list_application_grants: List the grants associated with an application
list_application_providers: Lists the application providers configured in the IAM Identity Center identity store
list_applications: Lists all applications associated with the instance of IAM Identity Center; Lists all customer managed policies attached to a specified PermissionSet
list_instances: 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; Lists the Amazon Web Services managed policy that is attached to a specified permission set; 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; Lists all the permission sets that are provisioned to a specified Amazon Web Services account
list_tags_for_resource: Lists the tags that are attached to a specified resource
list_trusted_token_issuers: Lists all the trusted token issuers configured in an instance of IAM Identity Center
provision_permission_set: The process by which a specified permission set is provisioned to the specified target
put_application_access_scope: Adds or updates the list of authorized targets for an IAM Identity Center access scope for an application; Configure how users gain access to an application
put_application_authentication_method: Adds or updates an authentication method for an application
put_application_grant: Adds a grant to an application
put_inline_policy_to_permission_set: Attaches an inline policy to a permission set; Attaches an Amazon Web Services 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_application: Updates application properties
update_instance: Update the details for the instance of IAM Identity Center that is owned by the Amazon Web Services account; 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
update_trusted_token_issuer: Updates the name of the trusted token issuer, or the path of a source attribute or destination attribute for a trusted token issuer configuration

Examples¶

## Not run: 
svc <- ssoadmin()
svc$attach_customer_managed_policy_reference_to_permission_set(
  Foo = 123
)

## End(Not run)