identitystore | R Documentation |
The Identity Store service used by AWS IAM Identity Center (successor to AWS Single Sign-On) provides a single place to retrieve all of your identities (users and groups). For more information, see the IAM Identity Center User Guide.
<note> <p>Although AWS Single Sign-On was renamed, the <code>sso</code> and <code>identitystore</code> API namespaces will continue to retain their original name for backward compatibility purposes. For more information, see <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html#renamed">IAM Identity Center rename</a>.</p> </note> <p>This reference guide describes the identity store operations that you can call programatically and includes detailed information about data types and errors.</p>
identitystore(
config = list(),
credentials = list(),
endpoint = NULL,
region = NULL
)
config |
Optional configuration of credentials, endpoint, and/or region.
|
credentials |
Optional credentials shorthand for the config parameter
|
endpoint |
Optional shorthand for complete URL to use for the constructed client. |
region |
Optional shorthand for AWS Region used in instantiating the client. |
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.
svc <- identitystore( 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" )
create_group | Creates a group within the specified identity store |
create_group_membership | Creates a relationship between a member and a group |
create_user | Creates a user within the specified identity store |
delete_group | Delete a group within an identity store given GroupId |
delete_group_membership | Delete a membership within a group given MembershipId |
delete_user | Deletes a user within an identity store given UserId |
describe_group | Retrieves the group metadata and attributes from GroupId in an identity store |
describe_group_membership | Retrieves membership metadata and attributes from MembershipId in an identity store |
describe_user | Retrieves the user metadata and attributes from the UserId in an identity store |
get_group_id | Retrieves GroupId in an identity store |
get_group_membership_id | Retrieves the MembershipId in an identity store |
get_user_id | Retrieves the UserId in an identity store |
is_member_in_groups | Checks the user's membership in all requested groups and returns if the member exists in all queried groups |
list_group_memberships | For the specified group in the specified identity store, returns the list of all GroupMembership objects and returns results in paginated form |
list_group_memberships_for_member | For the specified member in the specified identity store, returns the list of all GroupMembership objects and returns results in paginated form |
list_groups | Lists all groups in the identity store |
list_users | Lists all users in the identity store |
update_group | For the specified group in the specified identity store, updates the group metadata and attributes |
update_user | For the specified user in the specified identity store, updates the user metadata and attributes |
## Not run:
svc <- identitystore()
svc$create_group(
Foo = 123
)
## End(Not run)
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.