Learn R Programming

paws.security.identity (version 0.7.0)

ssoadmin: 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)

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.

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.

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

attach_customer_managed_policy_reference_to_permission_setAttaches the specified customer managed policy to the specified PermissionSet
attach_managed_policy_to_permission_setAttaches an Amazon Web Services managed policy ARN to a permission set
create_account_assignmentAssigns access to a principal for a specified Amazon Web Services account using a specified permission set
create_applicationCreates an application in IAM Identity Center for the given application provider
create_application_assignmentGrant application access to a user or group
create_instanceCreates 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_configurationEnables the attributes-based access control (ABAC) feature for the specified IAM Identity Center instance
create_permission_setCreates a permission set within a specified IAM Identity Center instance
create_trusted_token_issuerCreates a connection to a trusted token issuer in an instance of IAM Identity Center
delete_account_assignmentDeletes a principal's access from a specified Amazon Web Services account using a specified permission set
delete_applicationDeletes the association with the application
delete_application_access_scopeDeletes an IAM Identity Center access scope from an application
delete_application_assignmentRevoke application access to an application by deleting application assignments for a user or group
delete_application_authentication_methodDeletes an authentication method from an application
delete_application_grantDeletes a grant from an application
delete_inline_policy_from_permission_setDeletes the inline policy from a specified permission set
delete_instanceDeletes the instance of IAM Identity Center
delete_instance_access_control_attribute_configurationDisables 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_setDeletes the permissions boundary from a specified PermissionSet
delete_permission_setDeletes the specified permission set
delete_trusted_token_issuerDeletes a trusted token issuer configuration from an instance of IAM Identity Center
describe_account_assignment_creation_statusDescribes the status of the assignment creation request
describe_account_assignment_deletion_statusDescribes the status of the assignment deletion request
describe_applicationRetrieves the details of an application associated with an instance of IAM Identity Center
describe_application_assignmentRetrieves a direct assignment of a user or group to an application
describe_application_providerRetrieves 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_instanceReturns the details of an instance of IAM Identity Center
describe_instance_access_control_attribute_configurationReturns 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_setGets the details of the permission set
describe_permission_set_provisioning_statusDescribes the status for the given permission set provisioning request
describe_trusted_token_issuerRetrieves details about a trusted token issuer configuration stored in an instance of IAM Identity Center
detach_customer_managed_policy_reference_from_permission_setDetaches the specified customer managed policy from the specified PermissionSet
detach_managed_policy_from_permission_setDetaches the attached Amazon Web Services managed policy ARN from the specified permission set
get_application_access_scopeRetrieves the authorized targets for an IAM Identity Center access scope for an application
get_application_assignment_configurationRetrieves the configuration of PutApplicationAssignmentConfiguration
get_application_authentication_methodRetrieves details about an authentication method used by an application
get_application_grantRetrieves details about an application grant
get_inline_policy_for_permission_setObtains the inline policy assigned to the permission set
get_permissions_boundary_for_permission_setObtains the permissions boundary for a specified PermissionSet
list_account_assignment_creation_statusLists the status of the Amazon Web Services account assignment creation requests for a specified IAM Identity Center instance
list_account_assignment_deletion_statusLists the status of the Amazon Web Services account assignment deletion requests for a specified IAM Identity Center instance
list_account_assignmentsLists the assignee of the specified Amazon Web Services account with the specified permission set
list_account_assignments_for_principalRetrieves a list of the IAM Identity Center associated Amazon Web Services accounts that the principal has access to
list_accounts_for_provisioned_permission_setLists all the Amazon Web Services accounts where the specified permission set is provisioned
list_application_access_scopesLists the access scopes and authorized targets associated with an application
list_application_assignmentsLists Amazon Web Services account users that are assigned to an application
list_application_assignments_for_principalLists the applications to which a specified principal is assigned
list_application_authentication_methodsLists all of the authentication methods supported by the specified application
list_application_grantsList the grants associated with an application
list_application_providersLists the application providers configured in the IAM Identity Center identity store
list_applicationsLists all applications associated with the instance of IAM Identity Center
list_customer_managed_policy_references_in_permission_setLists all customer managed policies attached to a specified PermissionSet
list_instancesLists 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_setLists the Amazon Web Services managed policy that is attached to a specified permission set
list_permission_set_provisioning_statusLists the status of the permission set provisioning requests for a specified IAM Identity Center instance
list_permission_setsLists the PermissionSets in an IAM Identity Center instance
list_permission_sets_provisioned_to_accountLists all the permission sets that are provisioned to a specified Amazon Web Services account
list_tags_for_resourceLists the tags that are attached to a specified resource
list_trusted_token_issuersLists all the trusted token issuers configured in an instance of IAM Identity Center
provision_permission_setThe process by which a specified permission set is provisioned to the specified target
put_application_access_scopeAdds or updates the list of authorized targets for an IAM Identity Center access scope for an application
put_application_assignment_configurationConfigure how users gain access to an application
put_application_authentication_methodAdds or updates an authentication method for an application
put_application_grantAdds a grant to an application
put_inline_policy_to_permission_setAttaches an inline policy to a permission set
put_permissions_boundary_to_permission_setAttaches an Amazon Web Services managed or customer managed policy to the specified PermissionSet as a permissions boundary
tag_resourceAssociates a set of tags with a specified resource
untag_resourceDisassociates a set of tags from a specified resource
update_applicationUpdates application properties
update_instanceUpdate the details for the instance of IAM Identity Center that is owned by the Amazon Web Services account
update_instance_access_control_attribute_configurationUpdates 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_setUpdates an existing permission set
update_trusted_token_issuerUpdates the name of the trusted token issuer, or the path of a source attribute or destination attribute for a trusted token issuer configuration

Examples

Run this code
if (FALSE) {
svc <- ssoadmin()
svc$attach_customer_managed_policy_reference_to_permission_set(
  Foo = 123
)
}

Run the code above in your browser using DataLab