AWS - IAM Identity Center

Amazon Web Services IAM Identity Center.

IT Services · AWS - IAM Identity Center

Details

IDAWS - IAM Identity Center
ProviderAmazon
CategoryIT Services
From Version5.0.0
Docker Imagedemisto/boto3py3:1.0.0.10221838
Supported ModulesAgentix XSIAM

README

Amazon Web Services Identity and Access Management Identity Center(IAM)

For detailed instructions about setting up authentication, see: AWS Integrations - Authentication.

Configure AWS - IAM Identity Center in Cortex

Parameter Description Required
Role Arn   False
Role Session Name A descriptive name for the assumed role session. False
AWS Default Region   True
Role Session Duration   False
Identity Store ID The Identity Store ID parameter is required for API requests. It can be provided as a parameter or as an argument. If the Identity Store ID was not specified - Test failure. False
Access Key   False
Secret Key   False
Access Key   False
Secret Key   False
Timeout The time in seconds until a timeout exception is reached. You can specify just the read timeout (for example 60) or also the connect timeout followed after a comma (for example 60,10). If a connect timeout is not specified, a default of 10 seconds will be used. False
Retries The maximum number of retry attempts when connection or throttling errors are encountered. Set to 0 to disable retries. The default value is 5 and the limit is 10. Note: Increasing the number of retries will increase the execution time. False
Trust any certificate (not secure)   False

Commands

You can execute these commands from the CLI, as part of an automation, or in a playbook.
After you successfully execute a command, a DBot message appears in the War Room with the command details.

aws-iam-identitycenter-create-user

Creates a new IAM Identity Center user for your AWS account.

Base Command

aws-iam-identitycenter-create-user

Input

Argument Name Description Required
userName The username of the user to create. Required
familyName The family name of the user to create. Required
givenName The first name of the user to create. Required
userEmailAddress The email address of the user to create. Optional
displayName The display name of the user to create. Required
profileUrl The profile URL of the user to create. Optional
userEmailAddressPrimary Is this the primary email address for the associated resource?. Possible values are: yes, no. Optional
userType The type of the user to create. Optional
title The title of the user to create. Optional
region The AWS Region. If not specified, the default region will be used. Possible values are: us-east-1, us-east-2, us-west-1, us-west-2, ca-central-1, eu-west-1, eu-central-1, eu-west-2, ap-northeast-1, ap-northeast-2, ap-southeast-1, ap-southeast-2, ap-south-1, sa-east-1, eu-north-1, eu-west-3. Optional
roleArn The Amazon Resource Name. Optional
roleSessionDuration Role session duration. Optional
roleSessionName Role session name. Optional
IdentityStoreId Identity store ID. Optional

Context Output

Path Type Description
AWS.IAMIdentityCenter.User.UserId string The user ID.
AWS.IAMIdentityCenter.User.IdentityStoreId string Identity Store ID.

Command example

!aws-iam-identitycenter-create-user displayName="John Doe" familyName=Doe givenName=John userName=johndoe userEmailAddress=johnDoe@gmail.com

Context Example

{
    "AWS": {
        "IAMIdentityCenter": {
            "User": {
                "IdentityStoreId": "d-9967750fbd",
                "UserId": "634418e2-20c1-703e-4358-a8312472c85d"
            }
        }
    }
}

Human Readable Output

User johndoe has been successfully created with user id 634418e2-20c1-703e-4358-a8312472c85d

IdentityStoreId UserId
d-9967750fbd 634418e2-20c1-703e-4358-a8312472c85d

aws-iam-identitycenter-get-user

Retrieves information about the specified IAM user.

Base Command

aws-iam-identitycenter-get-user

Input

Argument Name Description Required
region The AWS Region. If not specified, the default region will be used. Possible values are: us-east-1, us-east-2, us-west-1, us-west-2, ca-central-1, eu-west-1, eu-central-1, eu-west-2, ap-northeast-1, ap-northeast-2, ap-southeast-1, ap-southeast-2, ap-south-1, sa-east-1, eu-north-1, eu-west-3. Optional
roleArn The Amazon Resource Name. Optional
roleSessionDuration Role session duration. Optional
roleSessionName Role session name. Optional
IdentityStoreId Identity store ID. Optional
userName The name of the user to get information about. Required

Context Output

Path Type Description
AWS.IAMIdentityCenter.User.UserName string The friendly name identifying the user.
AWS.IAMIdentityCenter.User.UserId string The stable and unique string identifying the user.
AWS.IAMIdentityCenter.User.ExternalIds.Issuer String The issuer for an external identifier.
AWS.IAMIdentityCenter.User.ExternalIds.Id String The identifier issued to this resource by an external identity provider.
AWS.IAMIdentityCenter.User.Name.Formatted String Formatted version of the user’s name for display.
AWS.IAMIdentityCenter.User.Name.FamilyName String The family name of the user.
AWS.IAMIdentityCenter.User.Name.GivenName String The given name of the user.
AWS.IAMIdentityCenter.User.Name.MiddleName String The middle name of the user.
AWS.IAMIdentityCenter.User.Name.HonorificPrefix String The honorific prefix of the user.
AWS.IAMIdentityCenter.User.Name.HonorificSuffix String The honorific suffix of the user.
AWS.IAMIdentityCenter.User.DisplayName String The name of the user formatted for display when referenced.
AWS.IAMIdentityCenter.User.NickName String An alternate name for the user.
AWS.IAMIdentityCenter.User.ProfileUrl String URL associated with the user.
AWS.IAMIdentityCenter.User.Emails.Value String Email address associated with the user.
AWS.IAMIdentityCenter.User.Emails.Type String Type of email address.
AWS.IAMIdentityCenter.User.Emails.Primary String Indicates whether this is the primary email address.
AWS.IAMIdentityCenter.User.Addresses.StreetAddress String Street address.
AWS.IAMIdentityCenter.User.Addresses.Locality String Address locality.
AWS.IAMIdentityCenter.User.Addresses.Region String Region of the address.
AWS.IAMIdentityCenter.User.Addresses.PostalCode String Postal code of the address.
AWS.IAMIdentityCenter.User.Addresses.Country String Country of the address.
AWS.IAMIdentityCenter.User.Addresses.Formatted String Formatted version of the address for display.
AWS.IAMIdentityCenter.User.Addresses.Type String Type of address.
AWS.IAMIdentityCenter.User.Addresses.Primary String Indicates whether this is the primary address.
AWS.IAMIdentityCenter.User.PhoneNumbers.Value String Phone number associated with the user.
AWS.IAMIdentityCenter.User.PhoneNumbers.Type String Type of phone number.
AWS.IAMIdentityCenter.User.PhoneNumbers.Primary String Indicates whether this is the primary phone number.
AWS.IAMIdentityCenter.User.UserType String Type of user.
AWS.IAMIdentityCenter.User.Title String Title of the user.
AWS.IAMIdentityCenter.User.PreferredLanguage String Preferred language of the user.
AWS.IAMIdentityCenter.User.Locale String Geographical region or location of the user.
AWS.IAMIdentityCenter.User.Timezone String Time zone of the user.
AWS.IAMIdentityCenter.User.IdentityStoreId String Globally unique identifier for the identity store.

Command example

!aws-iam-identitycenter-get-user userName=johndoe

Context Example

{
    "AWS": {
        "IAMIdentityCenter": {
            "User": {
                "DisplayName": "John Doe",
                "Emails": [
                    {
                        "Value": "johnDoe@gmail.com"
                    }
                ],
                "IdentityStoreId": "d-9967750fbd",
                "Name": {
                    "FamilyName": "Doe",
                    "GivenName": "John"
                },
                "UserId": "634418e2-20c1-703e-4358-a8312472c85d",
                "UserName": "johndoe"
            }
        }
    }
}

Human Readable Output

AWS IAM Identity Center Users

DisplayName Emails UserId UserName
John Doe johnDoe@gmail.com 634418e2-20c1-703e-4358-a8312472c85d johndoe

aws-iam-identitycenter-list-users

Lists the IAM users, returns all users in the AWS account.

Base Command

aws-iam-identitycenter-list-users

Input

Argument Name Description Required
region The AWS Region. If not specified, the default region will be used. Possible values are: us-east-1, us-east-2, us-west-1, us-west-2, ca-central-1, eu-west-1, eu-central-1, eu-west-2, ap-northeast-1, ap-northeast-2, ap-southeast-1, ap-southeast-2, ap-south-1, sa-east-1, eu-north-1, eu-west-3. Optional
roleArn The Amazon Resource Name. Optional
roleSessionDuration Role session duration. Optional
roleSessionName Role session name. Optional
IdentityStoreId Identity store ID. Optional
limit Number of results to return. Default is 50. Optional
nextToken The pagination token. Optional

Context Output

Path Type Description
AWS.IAMIdentityCenter.User.UserName string The friendly name identifying the user.
AWS.IAMIdentityCenter.User.UserId string The stable and unique string identifying the user.
AWS.IAMIdentityCenter.User.ExternalIds.Issuer String The issuer for an external identifier.
AWS.IAMIdentityCenter.User.ExternalIds.Id String The identifier issued to this resource by an external identity provider.
AWS.IAMIdentityCenter.User.Name.Formatted String Formatted version of the user’s name for display.
AWS.IAMIdentityCenter.User.Name.FamilyName String The family name of the user.
AWS.IAMIdentityCenter.User.Name.GivenName String The given name of the user.
AWS.IAMIdentityCenter.User.Name.MiddleName String The middle name of the user.
AWS.IAMIdentityCenter.User.Name.HonorificPrefix String The honorific prefix of the user.
AWS.IAMIdentityCenter.User.Name.HonorificSuffix String The honorific suffix of the user.
AWS.IAMIdentityCenter.User.DisplayName String The name of the user formatted for display when referenced.
AWS.IAMIdentityCenter.User.NickName String An alternate name for the user.
AWS.IAMIdentityCenter.User.ProfileUrl String URL associated with the user.
AWS.IAMIdentityCenter.User.Emails.Value String Email address associated with the user.
AWS.IAMIdentityCenter.User.Emails.Type String Type of email address.
AWS.IAMIdentityCenter.User.Emails.Primary String Indicates whether this is the primary email address.
AWS.IAMIdentityCenter.User.Addresses.StreetAddress String Street address.
AWS.IAMIdentityCenter.User.Addresses.Locality String Address locality.
AWS.IAMIdentityCenter.User.Addresses.Region String Region of the address.
AWS.IAMIdentityCenter.User.Addresses.PostalCode String Postal code of the address.
AWS.IAMIdentityCenter.User.Addresses.Country String Country of the address.
AWS.IAMIdentityCenter.User.Addresses.Formatted String Formatted version of the address for display.
AWS.IAMIdentityCenter.User.Addresses.Type String Type of address.
AWS.IAMIdentityCenter.User.Addresses.Primary String Indicates whether this is the primary address.
AWS.IAMIdentityCenter.User.PhoneNumbers.Value String Phone number associated with the user.
AWS.IAMIdentityCenter.User.PhoneNumbers.Type String Type of phone number.
AWS.IAMIdentityCenter.User.PhoneNumbers.Primary String Indicates whether this is the primary phone number.
AWS.IAMIdentityCenter.User.UserType String Type of user.
AWS.IAMIdentityCenter.User.Title String Title of the user.
AWS.IAMIdentityCenter.User.PreferredLanguage String Preferred language of the user.
AWS.IAMIdentityCenter.User.Locale String Geographical region or location of the user.
AWS.IAMIdentityCenter.User.Timezone String Time zone of the user.
AWS.IAMIdentityCenter.User.IdentityStoreId String Globally unique identifier for the identity store.
AWS.IAMIdentityCenter.UserNextToken String Pagination token.

Command example


#### Context Example

```json
{
    "AWS": {
        "IAMIdentityCenter": {
            "User": [
                {
                    "DisplayName": "John Doe",
                    "Emails": [
                        {
                            "Value": "johnDoe@gmail.com"
                        }
                    ],
                    "IdentityStoreId": "d-9967750fbd",
                    "Name": {
                        "FamilyName": "Doe",
                        "GivenName": "John"
                    },
                    "UserId": "8374c852-10e1-70e2-8996-5b0d54bf8ccd",
                    "UserName": "johndoe"
                },
            ],
            "UserNextToken": null
        }
    }
}

Human Readable Output

AWS IAM Identity Center Users

DisplayName Emails UserId UserName
johndoe johnDoe@gmail.com 8374c852-10e1-70e2-8996-5b0d54bf8ccd johndoe

aws-iam-identitycenter-list-groups

Lists all the IAM groups in the AWS account.

Base Command

aws-iam-identitycenter-list-groups

Input

Argument Name Description Required
region The AWS Region. If not specified, the default region will be used. Possible values are: us-east-1, us-east-2, us-west-1, us-west-2, ca-central-1, eu-west-1, eu-central-1, eu-west-2, ap-northeast-1, ap-northeast-2, ap-southeast-1, ap-southeast-2, ap-south-1, sa-east-1, eu-north-1, eu-west-3. Optional
roleArn The Amazon Resource Name. Optional
roleSessionDuration Role session duration. Optional
roleSessionName Role session name. Optional
IdentityStoreId Identity store ID. Optional
limit Number of results to return. Default is 50. Optional
nextToken The pagination token. Optional

Context Output

Path Type Description
AWS.IAMIdentityCenter.Group.GroupId String The identifier for a group in the identity store.
AWS.IAMIdentityCenter.Group.DisplayName String The display name value for the group.
AWS.IAMIdentityCenter.Group.ExternalIds.Issuer String The issuer for an external identifier.
AWS.IAMIdentityCenter.Group.ExternalIds.Id String The identifier issued to this resource by an external identity provider.
AWS.IAMIdentityCenter.Group.Description String A description of the specified group.
AWS.IAMIdentityCenter.Group.IdentityStoreId String The globally unique identifier for the identity store.
AWS.IAMIdentityCenter.GroupNextToken String The pagination token used for the ListUsers and ListGroups API operations.

Command example


#### Context Example

```json
{
    "AWS": {
        "IAMIdentityCenter": {
            "Group": [
                {
                    "DisplayName": "new",
                    "GroupId": "53142802-e001-7004-9134-9e6e4e1e10c0",
                    "IdentityStoreId": "d-9967750fbd"
                }
            ],
            "GroupNextToken": null
        }
    }
}

Human Readable Output

AWS IAM Identity Center Groups

DisplayName GroupId
new 53142802-e001-7004-9134-9e6e4e1e10c0

aws-iam-identitycenter-list-groups-for-user

Lists the IAM Identity Center groups that the specified IAM user belongs to.

Base Command

aws-iam-identitycenter-list-groups-for-user

Input

Argument Name Description Required
region The AWS Region. If not specified, the default region will be used. Possible values are: us-east-1, us-east-2, us-west-1, us-west-2, ca-central-1, eu-west-1, eu-central-1, eu-west-2, ap-northeast-1, ap-northeast-2, ap-southeast-1, ap-southeast-2, ap-south-1, sa-east-1, eu-north-1, eu-west-3. Optional
roleArn The Amazon Resource Name. Optional
roleSessionDuration Role session duration. Optional
roleSessionName Role session name. Optional
IdentityStoreId Identity store ID. Optional
limit Number of results to return. Default is 50. Optional
nextToken The pagination token. Optional
userName The name of the user to list groups for. Required

Context Output

Path Type Description
AWS.IAMIdentityCenter.User.UserId string User ID.
AWS.IAMIdentityCenter.User.GroupMemeberships.MembershipId string The friendly name that identifies the group.
AWS.IAMIdentityCenter.User.GroupMemeberships.GroupId string The stable and unique string identifying the group.

Command example

!aws-iam-identitycenter-list-groups-for-user userName=johndoe

Context Example

{
    "AWS": {
        "IAMIdentityCenter": {
            "GroupsUserNextToken":null,
            "User":{
                "GroupMemberships":[
                    {
                        "GroupId":"a3948882-5051-7090-524c-c8c850bf1919",
                        "MembershipId":"e374b872-9011-7000-c847-55fdcc299204",
                    }
                ],
                "UserId":"c3f438a2-e041-7033-75e8-63eb8c64b0e4"
            }
        }
    }
}

Human Readable Output

AWS IAM Identity Center Groups

GroupID MembershipID UserID
a3948882-5051-7090-524c-c8c850bf1919 e374b872-9011-7000-c847-55fdcc299204 c3f438a2-e041-7033-75e8-63eb8c64b0e4

aws-iam-identitycenter-add-user-to-group

Adds the specified user to the specified group.

Base Command

aws-iam-identitycenter-add-user-to-group

Input

Argument Name Description Required
region The AWS Region. If not specified, the default region will be used. Possible values are: us-east-1, us-east-2, us-west-1, us-west-2, ca-central-1, eu-west-1, eu-central-1, eu-west-2, ap-northeast-1, ap-northeast-2, ap-southeast-1, ap-southeast-2, ap-south-1, sa-east-1, eu-north-1, eu-west-3. Optional
roleArn The Amazon Resource Name. Optional
roleSessionDuration Role session duration. Optional
roleSessionName Role session name. Optional
IdentityStoreId Identity store ID. Optional
userName The name of the user to add. Required
groupName The name of the group to update. Required

Context Output

There is no context output for this command.

Command example

!aws-iam-identitycenter-add-user-to-group groupName=NewGroup userName=johndoe

Human Readable Output

The membership id 4314c862-b0c1-705e-d5da-ccf59fd045f3 has been successfully created.

aws-iam-identitycenter-get-group

Get AWS IAM Identity Center group Information.

Base Command

aws-iam-identitycenter-get-group

Input

Argument Name Description Required
region The AWS Region. If not specified, the default region will be used. Possible values are: us-east-1, us-east-2, us-west-1, us-west-2, ca-central-1, eu-west-1, eu-central-1, eu-west-2, ap-northeast-1, ap-northeast-2, ap-southeast-1, ap-southeast-2, ap-south-1, sa-east-1, eu-north-1, eu-west-3. Optional
roleArn The Amazon Resource Name. Optional
roleSessionDuration Role session duration. Optional
roleSessionName Role session name. Optional
IdentityStoreId Identity store ID. Optional
displayName The name of the group to search. Required

Context Output

Path Type Description
AWS.IAMIdentityCenter.Group.GroupId String The identifier for a group in the identity store.
AWS.IAMIdentityCenter.Group.DisplayName String The display name of the group.
AWS.IAMIdentityCenter.Group.ExternalIds.Issuer String The issuer for an external identifier.
AWS.IAMIdentityCenter.Group.ExternalIds.Id String The identifier issued to this resource by an external identity provider.
AWS.IAMIdentityCenter.Group.Description String A description of the group.
AWS.IAMIdentityCenter.Group.IdentityStoreId String The globally unique identifier for the identity store.

Command example

!aws-iam-identitycenter-get-group displayName=NewGroup

Context Example

{
    "AWS": {
        "IAMIdentityCenter": {
            "Group": {
                "Description": "New",
                "DisplayName": "NewGroup",
                "GroupId": "f3a478d2-50b1-7078-81a4-c97c703007f3",
                "IdentityStoreId": "d-9967750fbd"
            }
        }
    }
}

Human Readable Output

AWS IAM Identity Center Groups

DisplayName GroupId
NewGroup f3a478d2-50b1-7078-81a4-c97c703007f3

aws-iam-identitycenter-get-user-by-email

Retrieves information about the specified IAM user.

Base Command

aws-iam-identitycenter-get-user-by-email

Input

Argument Name Description Required
region The AWS Region. If not specified, the default region will be used. Possible values are: us-east-1, us-east-2, us-west-1, us-west-2, ca-central-1, eu-west-1, eu-central-1, eu-west-2, ap-northeast-1, ap-northeast-2, ap-southeast-1, ap-southeast-2, ap-south-1, sa-east-1, eu-north-1, eu-west-3. Optional
roleArn The Amazon Resource Name. Optional
roleSessionDuration Role session duration. Optional
roleSessionName Role session name. Optional
IdentityStoreId Identity store ID. Optional
emailAddress The email of the user. Required

Context Output

Path Type Description
AWS.IAMIdentityCenter.User.UserName string The friendly name identifying the user.
AWS.IAMIdentityCenter.User.UserId string The stable and unique string identifying the user.
AWS.IAMIdentityCenter.User.ExternalIds.Issuer String The issuer for an external identifier.
AWS.IAMIdentityCenter.User.ExternalIds.Id String The identifier issued to this resource by an external identity provider.
AWS.IAMIdentityCenter.User.Name.Formatted String Formatted version of the user’s name for display.
AWS.IAMIdentityCenter.User.Name.FamilyName String The family name of the user.
AWS.IAMIdentityCenter.User.Name.GivenName String The given name of the user.
AWS.IAMIdentityCenter.User.Name.MiddleName String The middle name of the user.
AWS.IAMIdentityCenter.User.Name.HonorificPrefix String The honorific prefix of the user.
AWS.IAMIdentityCenter.User.Name.HonorificSuffix String The honorific suffix of the user.
AWS.IAMIdentityCenter.User.DisplayName String The name of the user formatted for display when referenced.
AWS.IAMIdentityCenter.User.NickName String An alternate name for the user.
AWS.IAMIdentityCenter.User.ProfileUrl String URL associated with the user.
AWS.IAMIdentityCenter.User.Emails.Value String Email address associated with the user.
AWS.IAMIdentityCenter.User.Emails.Type String Type of email address.
AWS.IAMIdentityCenter.User.Emails.Primary String Indicates whether this is the primary email address.
AWS.IAMIdentityCenter.User.Addresses.StreetAddress String Street address.
AWS.IAMIdentityCenter.User.Addresses.Locality String Address locality.
AWS.IAMIdentityCenter.User.Addresses.Region String Region of the address.
AWS.IAMIdentityCenter.User.Addresses.PostalCode String Postal code of the address.
AWS.IAMIdentityCenter.User.Addresses.Country String Country of the address.
AWS.IAMIdentityCenter.User.Addresses.Formatted String Formatted version of the address for display.
AWS.IAMIdentityCenter.User.Addresses.Type String Type of address.
AWS.IAMIdentityCenter.User.Addresses.Primary String Indicates whether this is the primary address.
AWS.IAMIdentityCenter.User.PhoneNumbers.Value String Phone number associated with the user.
AWS.IAMIdentityCenter.User.PhoneNumbers.Type String Type of phone number.
AWS.IAMIdentityCenter.User.PhoneNumbers.Primary String Indicates whether this is the primary phone number.
AWS.IAMIdentityCenter.User.UserType String Type of user.
AWS.IAMIdentityCenter.User.Title String Title of the user.
AWS.IAMIdentityCenter.User.PreferredLanguage String Preferred language of the user.
AWS.IAMIdentityCenter.User.Locale String Geographical region or location of the user.
AWS.IAMIdentityCenter.User.Timezone String Time zone of the user.
AWS.IAMIdentityCenter.User.IdentityStoreId String Globally unique identifier for the identity store.

Command example

!aws-iam-identitycenter-get-user-by-email emailAddress=johnDoe@gmail.com

Context Example

{
    "AWS": {
        "IAMIdentityCenter": {
            "User": {
                "DisplayName": "John Doe",
                "Emails": [
                    {
                        "Primary": true,
                        "Type": "work",
                        "Value": "johnDoe@gmail.com"
                    }
                ],
                "IdentityStoreId": "d-9967750fbd",
                "Name": {
                    "FamilyName": "Doe",
                    "GivenName": "John"
                },
                "UserId": "13746842-e011-70fe-14fe-600d496510f0",
                "UserName": "johndoe",
            }
        }
    }
}

Human Readable Output

AWS IAM Identity Center Users

DisplayName Emails UserId UserName
John Doe johnDoe@gmail.com 13746842-e011-70fe-14fe-600d496510f0 johndoe

aws-iam-identitycenter-list-memberships

Lists the memberships of the group.

Base Command

aws-iam-identitycenter-list-memberships

Input

Argument Name Description Required
region The AWS Region. If not specified, the default region will be used. Possible values are: us-east-1, us-east-2, us-west-1, us-west-2, ca-central-1, eu-west-1, eu-central-1, eu-west-2, ap-northeast-1, ap-northeast-2, ap-southeast-1, ap-southeast-2, ap-south-1, sa-east-1, eu-north-1, eu-west-3. Optional
roleArn The Amazon Resource Name. Optional
roleSessionDuration Role session duration. Optional
roleSessionName Role session name. Optional
IdentityStoreId Identity store ID. Optional
limit Number of results to return. Default is 50. Optional
nextToken The pagination token. Optional
groupName The name of the group to list the memberships. Required

Context Output

Path Type Description
AWS.IAMIdentityCenter.GroupMemberships.IdentityStoreId String The globally unique identifier for the identity store.
AWS.IAMIdentityCenter.Group.GroupMemberships.MembershipId String The identifier for a GroupMembership object in an identity store.
AWS.IAMIdentityCenter.Group.GroupId String The identifier for a group in the identity store.
AWS.IAMIdentityCenter.Group.GroupMemberships.UserId String Identifier of resources that can be members.
AWS.IAMIdentityCenter.GroupMembershipNextToken String The pagination token.

Command example

!aws-iam-identitycenter-list-memberships groupName=NewGroup

Context Example

{
    "AWS": {
        "IAMIdentityCenter": {
            "Group": {
                "GroupMemberships":[
                    {
                        "MembershipId":"e374b872-9011-7000-c847-55fdcc299204",
                        "UserId":"c3f438a2-e041-7033-75e8-63eb8c64b0e4"
                    }
                ]
            },
            "GroupMembershipNextToken":null
        }
    }
}

Human Readable Output

GroupId MembershipId UserId
a3948882-5051-7090-524c-c8c850bf1919 e374b872-9011-7000-c847-55fdcc299204 c3f438a2-e041-7033-75e8-63eb8c64b0e4

aws-iam-identitycenter-delete-user

Removes the specified user from the AWS IAM Identity Center.

Base Command

aws-iam-identitycenter-delete-user

Input

Argument Name Description Required
region The AWS Region. If not specified, the default region will be used. Possible values are: us-east-1, us-east-2, us-west-1, us-west-2, ca-central-1, eu-west-1, eu-central-1, eu-west-2, ap-northeast-1, ap-northeast-2, ap-southeast-1, ap-southeast-2, ap-south-1, sa-east-1, eu-north-1, eu-west-3. Optional
roleArn The Amazon Resource Name. Optional
roleSessionDuration Role session duration. Optional
roleSessionName Role session name. Optional
IdentityStoreId Identity store ID. Optional
userName The name of the user to remove. Required

Context Output

There is no context output for this command.

Command example

!aws-iam-identitycenter-delete-user userName=johndoe

Human Readable Output

The User 634418e2-20c1-703e-4358-a8312472c85d has been removed.

aws-iam-identitycenter-delete-group

Removes the specified group from the IAM Identity Center.

Base Command

aws-iam-identitycenter-delete-group

Input

Argument Name Description Required
region The AWS Region. If not specified, the default region will be used. Possible values are: us-east-1, us-east-2, us-west-1, us-west-2, ca-central-1, eu-west-1, eu-central-1, eu-west-2, ap-northeast-1, ap-northeast-2, ap-southeast-1, ap-southeast-2, ap-south-1, sa-east-1, eu-north-1, eu-west-3. Optional
roleArn The Amazon Resource Name. Optional
roleSessionDuration Role session duration. Optional
roleSessionName Role session name. Optional
IdentityStoreId Identity store ID. Optional
groupName The name of the group to remove. Required

Context Output

There is no context output for this command.

Command example

!aws-iam-identitycenter-delete-group groupName=NewGroup

Human Readable Output

The Group f3a478d2-50b1-7078-81a4-c97c703007f3 has been removed.

aws-iam-identitycenter-create-group

Creates a new IAM Identity Center group for your AWS account.

Base Command

aws-iam-identitycenter-create-group

Input

Argument Name Description Required
region The AWS Region. If not specified, the default region will be used. Possible values are: us-east-1, us-east-2, us-west-1, us-west-2, ca-central-1, eu-west-1, eu-central-1, eu-west-2, ap-northeast-1, ap-northeast-2, ap-southeast-1, ap-southeast-2, ap-south-1, sa-east-1, eu-north-1, eu-west-3. Optional
roleArn The Amazon Resource Name. Optional
roleSessionDuration Role session duration. Optional
roleSessionName Role session name. Optional
IdentityStoreId Identity store ID. Optional
displayName The name of the group to create. Required
description The description of the group to create. Optional

Context Output

Path Type Description
AWS.IAMIdentityCenter.Group.GroupId string The user ID.
AWS.IAMIdentityCenter.Group.IdentityStoreId string Identity store ID.

Command example

!aws-iam-identitycenter-create-group description=New displayName=NewGroup

Context Example

{
    "AWS": {
        "IAMIdentityCenter": {
            "Group": {
                "GroupId": "f3a478d2-50b1-7078-81a4-c97c703007f3",
                "IdentityStoreId": "d-9967750fbd"
            }
        }
    }
}

Human Readable Output

Group NewGroup has been successfully created with id f3a478d2-50b1-7078-81a4-c97c703007f3

GroupId IdentityStoreId
f3a478d2-50b1-7078-81a4-c97c703007f3 d-9967750fbd

aws-iam-identitycenter-update-group

Updates an IAM Identity Center group for your AWS account.

Base Command

aws-iam-identitycenter-update-group

Input

Argument Name Description Required
region The AWS Region. If not specified, the default region will be used. Possible values are: us-east-1, us-east-2, us-west-1, us-west-2, ca-central-1, eu-west-1, eu-central-1, eu-west-2, ap-northeast-1, ap-northeast-2, ap-southeast-1, ap-southeast-2, ap-south-1, sa-east-1, eu-north-1, eu-west-3. Optional
roleArn The Amazon Resource Name. Optional
roleSessionDuration Role session duration. Optional
roleSessionName Role session name. Optional
IdentityStoreId Identity store ID. Optional
displayName The name of the group to update. Required
description The description of the group to update. Required

Context Output

There is no context output for this command.

Command example

!aws-iam-identitycenter-update-group description=changed displayName=NewGroup

Human Readable Output

Group NewGroup has been successfully updated

aws-iam-identitycenter-update-user

Updates an IAM Identity Center user for your AWS account.

Base Command

aws-iam-identitycenter-update-user

Input

Argument Name Description Required
userName The username of the user to update. Required
familyName The family name of the user to update. Optional
givenName The first name of the user to update. Optional
userEmailAddressPrimary Is this the primary email address for the associated resource. Possible values are: yes, no. Optional
userEmailAddress The email address of the user to update. Optional
displayName The display name of the user to update. Optional
profileUrl The profile URL of the user to update. Optional
userType The type of the user to update. Optional
title The title of the user to update. Optional
region The AWS Region. If not specified, the default region will be used. Possible values are: us-east-1, us-east-2, us-west-1, us-west-2, ca-central-1, eu-west-1, eu-central-1, eu-west-2, ap-northeast-1, ap-northeast-2, ap-southeast-1, ap-southeast-2, ap-south-1, sa-east-1, eu-north-1, eu-west-3. Optional
roleArn The Amazon Resource Name. Optional
roleSessionDuration Role session duration. Optional
roleSessionName Role session name. Optional
IdentityStoreId Identity store ID. Optional

Context Output

There is no context output for this command.

Command example

!aws-iam-identitycenter-update-user userName=johndoe familyName=changed

Human Readable Output

User johndoe has been successfully updated

aws-iam-identitycenter-delete-group-membership

Deletes a user from all groups if a username is provided, or deletes multiple memberships if a list of memberships is provided.

Base Command

aws-iam-identitycenter-delete-group-membership

Input

Argument Name Description Required
region The AWS Region. If not specified, the default region will be used. Possible values are: us-east-1, us-east-2, us-west-1, us-west-2, ca-central-1, eu-west-1, eu-central-1, eu-west-2, ap-northeast-1, ap-northeast-2, ap-southeast-1, ap-southeast-2, ap-south-1, sa-east-1, eu-north-1, eu-west-3. Optional
roleArn The Amazon Resource Name. Optional
roleSessionDuration Role session duration. Optional
roleSessionName Role session name. Optional
IdentityStoreId Identity store ID. Optional
userName The name of the user to delete from all groups. Optional
membershipId Comma-separated list of membership IDs to delete. Optional

Context Output

There is no context output for this command.

Command example

!aws-iam-identitycenter-delete-group-membership userName=johndoe

Human Readable Output

User is not member of any group.

Configuration parameters

  • roleArn — Role Arn
  • roleArnCredentials —
  • roleSessionName — Role Session Name
  • defaultRegion — AWS Default Region (required)
  • sessionDuration — Role Session Duration
  • IdentityStoreId — Identity Store ID
  • access_key — Access Key
  • secret_key — Secret Key
  • credentials — Access Key
  • timeout — Timeout
  • retries — Retries
  • sts_regional_endpoint — AWS STS Regional Endpoints
  • insecure — Trust any certificate (not secure)
  • proxy — Use system proxy settings

Commands (15)

  • aws-iam-identitycenter-add-user-to-group

    Adds the specified user to the specified group.

  • aws-iam-identitycenter-create-group

    Creates a new IAM Identity Center group for your AWS account.

  • aws-iam-identitycenter-create-user

    Creates a new IAM Identity Center user for your AWS account.

  • aws-iam-identitycenter-delete-group

    Removes the specified group from the IAM Identity Center.

  • aws-iam-identitycenter-delete-group-membership

    Deletes a user from all groups if a username is provided, or deletes multiple memberships if a list of memberships is provided.

  • aws-iam-identitycenter-delete-user

    Removes the specified user from the AWS IAM Identity Center.

  • aws-iam-identitycenter-get-group

    Get AWS IAM Identity Center group Information.

  • aws-iam-identitycenter-get-user

    Retrieves information about the specified IAM user.

  • aws-iam-identitycenter-get-user-by-email

    Retrieves information about the specified IAM user.

  • aws-iam-identitycenter-list-groups

    Lists all the IAM groups in the AWS account.

  • aws-iam-identitycenter-list-groups-for-user

    Lists the IAM Identity Center groups that the specified IAM user belongs to.

  • aws-iam-identitycenter-list-memberships

    Lists the memberships of the group.

  • aws-iam-identitycenter-list-users

    Lists the IAM users, returns all users in the AWS account.

  • aws-iam-identitycenter-update-group

    Updates an IAM Identity Center group for your AWS account.

  • aws-iam-identitycenter-update-user

    Updates an IAM Identity Center user for your AWS account.

Source

AWSIAMIdentityCenter.py AWSIAMIdentityCenter_test.py AWSIAMIdentityCenter.yml AWSIAMIdentityCenter_description.md command_examples.txt
Download History Raw 
commonfields:
  id: AWS - IAM Identity Center
  version: -1
category: IT Services
provider: Amazon
sectionorder:
- Connect
configuration:
- display: Role Arn
  name: roleArn
  required: false
  section: Connect
  type: 4
  hidden: true
- name: roleArnCredentials
  required: false
  type: 9
  displaypassword: Role Arn
  hiddenusername: true
- display: Role Session Name
  name: roleSessionName
  required: false
  section: Connect
  type: 0
  additionalinfo: "A descriptive name for the assumed role session."
- display: AWS Default Region
  section: Connect
  name: defaultRegion
  type: 15
  required: true
  options:
  - us-east-1
  - us-east-2
  - us-west-1
  - us-west-2
  - ca-central-1
  - eu-west-1
  - eu-central-1
  - eu-west-2
  - ap-northeast-1
  - ap-northeast-2
  - ap-southeast-1
  - ap-southeast-2
  - ap-south-1
  - sa-east-1
  - eu-north-1
  - eu-west-3
  - us-gov-east-1
  - us-gov-west-1
- display: Role Session Duration
  name: sessionDuration
  type: 0
  section: Connect
  required: false
- additionalinfo: "The Identity Store ID parameter is required for API requests. It can be provided as a parameter or as an argument. If the Identity Store ID was not specified - Test failure."
  display: Identity Store ID
  name: IdentityStoreId
  type: 0
  section: Connect
  required: false
- display: Access Key
  name: access_key
  required: false
  section: Connect
  type: 4
  hidden: true
- display: Secret Key
  name: secret_key
  required: false
  section: Connect
  type: 4
  hidden: true
- display: Access Key
  name: credentials
  required: false
  section: Connect
  type: 9
  displaypassword: Secret Key
- display: Timeout
  name: timeout
  required: false
  section: Connect
  type: 0
  additionalinfo: "The time in seconds until a timeout exception is reached. You can specify just the read timeout (for example 60) or also the connect timeout followed after a comma (for example 60,10). If a connect timeout is not specified, a default of 10 seconds will be used."
  defaultvalue: 60,10
- display: Retries
  name: retries
  required: false
  section: Connect
  type: 0
  additionalinfo: "The maximum number of retry attempts when connection or throttling errors are encountered. Set to 0 to disable retries. The default value is 5 and the limit is 10. Note: Increasing the number of retries will increase the execution time."
  defaultvalue: 5
- display: AWS STS Regional Endpoints
  additionalinfo: Sets the AWS_STS_REGIONAL_ENDPOINTS environment variable to specify the AWS STS endpoint resolution logic. By default, this option is set to “legacy” in AWS. Leave empty if the environment variable is already set using server configuration.
  name: sts_regional_endpoint
  options:
  - legacy
  - regional
  type: 15
  section: Connect
  required: false
- display: Trust any certificate (not secure)
  name: insecure
  required: false
  section: Connect
  type: 8
- display: Use system proxy settings
  name: proxy
  type: 8
  section: Connect
  advanced: true
  required: false
description: Amazon Web Services IAM Identity Center.
display: AWS - IAM Identity Center
name: AWS - IAM Identity Center
script:
  commands:
  - arguments:
    - description: The username of the user to create.
      name: userName
      required: true
    - description: The family name of the user to create.
      name: familyName
      required: true
    - description: The first name of the user to create.
      name: givenName
      required: true
    - description: The email address of the user to create.
      name: userEmailAddress
      required: false
    - description: The display name of the user to create.
      name: displayName
      required: true
    - description: The profile URL of the user to create.
      name: profileUrl
      required: false
    - description: Is this the primary email address for the associated resource?
      name: userEmailAddressPrimary
      required: false
      auto: PREDEFINED
      predefined:
      - yes
      - no
    - description: The type of the user to create.
      name: userType
      required: false
    - description: The title of the user to create.
      name: title
      required: false
    - auto: PREDEFINED
      description: The AWS Region. If not specified, the default region will be used.
      name: region
      predefined:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - ca-central-1
      - eu-west-1
      - eu-central-1
      - eu-west-2
      - ap-northeast-1
      - ap-northeast-2
      - ap-southeast-1
      - ap-southeast-2
      - ap-south-1
      - sa-east-1
      - eu-north-1
      - eu-west-3
      required: false
    - description: The Amazon Resource Name.
      name: roleArn
      required: false
    - description: Role session duration.
      name: roleSessionDuration
      required: false
    - description: Role session name.
      name: roleSessionName
      required: false
    - description: Identity store ID.
      name: IdentityStoreId
      required: false
    description: Creates a new IAM Identity Center user for your AWS account.
    name: aws-iam-identitycenter-create-user
    outputs:
    - contextPath: AWS.IAMIdentityCenter.User.UserId
      description: The user ID.
      type: string
    - contextPath: AWS.IAMIdentityCenter.User.IdentityStoreId
      description: Identity Store ID.
      type: string
  - arguments:
    - description: The AWS Region. If not specified, the default region will be used.
      name: region
      required: false
      auto: PREDEFINED
      predefined:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - ca-central-1
      - eu-west-1
      - eu-central-1
      - eu-west-2
      - ap-northeast-1
      - ap-northeast-2
      - ap-southeast-1
      - ap-southeast-2
      - ap-south-1
      - sa-east-1
      - eu-north-1
      - eu-west-3
    - description: The Amazon Resource Name.
      name: roleArn
      required: false
    - description: Role session duration.
      name: roleSessionDuration
      required: false
    - description: Role session name.
      name: roleSessionName
      required: false
    - description: Identity store ID.
      name: IdentityStoreId
      required: false
    - description: The name of the user to get information about.
      name: userName
      required: true
    description: Retrieves information about the specified IAM user.
    name: aws-iam-identitycenter-get-user
    outputs:
    - contextPath: AWS.IAMIdentityCenter.User.UserName
      description: The friendly name identifying the user.
      type: string
    - contextPath: AWS.IAMIdentityCenter.User.UserId
      description: The stable and unique string identifying the user.
      type: string
    - contextPath: AWS.IAMIdentityCenter.User.ExternalIds.Issuer
      description: The issuer for an external identifier.
      type: String
    - contextPath: AWS.IAMIdentityCenter.User.ExternalIds.Id
      description: The identifier issued to this resource by an external identity provider.
      type: String
    - contextPath: AWS.IAMIdentityCenter.User.Name.Formatted
      description: Formatted version of the user's name for display.
      type: String
    - contextPath: AWS.IAMIdentityCenter.User.Name.FamilyName
      description: The family name of the user.
      type: String
    - contextPath: AWS.IAMIdentityCenter.User.Name.GivenName
      description: The given name of the user.
      type: String
    - contextPath: AWS.IAMIdentityCenter.User.Name.MiddleName
      description: The middle name of the user.
      type: String
    - contextPath: AWS.IAMIdentityCenter.User.Name.HonorificPrefix
      description: The honorific prefix of the user.
      type: String
    - contextPath: AWS.IAMIdentityCenter.User.Name.HonorificSuffix
      description: The honorific suffix of the user.
      type: String
    - contextPath: AWS.IAMIdentityCenter.User.DisplayName
      description: The name of the user formatted for display when referenced.
      type: String
    - contextPath: AWS.IAMIdentityCenter.User.NickName
      description: An alternate name for the user.
      type: String
    - contextPath: AWS.IAMIdentityCenter.User.ProfileUrl
      description: URL associated with the user.
      type: String
    - contextPath: AWS.IAMIdentityCenter.User.Emails.Value
      description: Email address associated with the user.
      type: String
    - contextPath: AWS.IAMIdentityCenter.User.Emails.Type
      description: Type of email address.
      type: String
    - contextPath: AWS.IAMIdentityCenter.User.Emails.Primary
      description: Indicates whether this is the primary email address.
      type: String
    - contextPath: AWS.IAMIdentityCenter.User.Addresses.StreetAddress
      description: Street address.
      type: String
    - contextPath: AWS.IAMIdentityCenter.User.Addresses.Locality
      description: Address locality.
      type: String
    - contextPath: AWS.IAMIdentityCenter.User.Addresses.Region
      description: Region of the address.
      type: String
    - contextPath: AWS.IAMIdentityCenter.User.Addresses.PostalCode
      description: Postal code of the address.
      type: String
    - contextPath: AWS.IAMIdentityCenter.User.Addresses.Country
      description: Country of the address.
      type: String
    - contextPath: AWS.IAMIdentityCenter.User.Addresses.Formatted
      description: Formatted version of the address for display.
      type: String
    - contextPath: AWS.IAMIdentityCenter.User.Addresses.Type
      description: Type of address.
      type: String
    - contextPath: AWS.IAMIdentityCenter.User.Addresses.Primary
      description: Indicates whether this is the primary address.
      type: String
    - contextPath: AWS.IAMIdentityCenter.User.PhoneNumbers.Value
      description: Phone number associated with the user.
      type: String
    - contextPath: AWS.IAMIdentityCenter.User.PhoneNumbers.Type
      description: Type of phone number.
      type: String
    - contextPath: AWS.IAMIdentityCenter.User.PhoneNumbers.Primary
      description: Indicates whether this is the primary phone number.
      type: String
    - contextPath: AWS.IAMIdentityCenter.User.UserType
      description: Type of user.
      type: String
    - contextPath: AWS.IAMIdentityCenter.User.Title
      description: Title of the user.
      type: String
    - contextPath: AWS.IAMIdentityCenter.User.PreferredLanguage
      description: Preferred language of the user.
      type: String
    - contextPath: AWS.IAMIdentityCenter.User.Locale
      description: Geographical region or location of the user.
      type: String
    - contextPath: AWS.IAMIdentityCenter.User.Timezone
      description: Time zone of the user.
      type: String
    - contextPath: AWS.IAMIdentityCenter.User.IdentityStoreId
      description: Globally unique identifier for the identity store.
      type: String
  - arguments:
    - auto: PREDEFINED
      description: The AWS Region. If not specified, the default region will be used.
      name: region
      predefined:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - ca-central-1
      - eu-west-1
      - eu-central-1
      - eu-west-2
      - ap-northeast-1
      - ap-northeast-2
      - ap-southeast-1
      - ap-southeast-2
      - ap-south-1
      - sa-east-1
      - eu-north-1
      - eu-west-3
      required: false
    - description: The Amazon Resource Name.
      name: roleArn
      required: false
    - description: Role session duration.
      name: roleSessionDuration
      required: false
    - description: Role session name.
      name: roleSessionName
      required: false
    - description: Identity store ID.
      name: IdentityStoreId
      required: false
    - description: Number of results to return. Maximum value is 50.
      defaultValue: '50'
      name: limit
      required: false
    - description: The pagination token.
      name: nextToken
      required: false
    description: Lists the IAM users, returns all users in the AWS account.
    name: aws-iam-identitycenter-list-users
    outputs:
    - contextPath: AWS.IAMIdentityCenter.User.UserName
      description: The friendly name identifying the user.
      type: string
    - contextPath: AWS.IAMIdentityCenter.User.UserId
      description: The stable and unique string identifying the user.
      type: string
    - contextPath: AWS.IAMIdentityCenter.User.ExternalIds.Issuer
      description: The issuer for an external identifier.
      type: String
    - contextPath: AWS.IAMIdentityCenter.User.ExternalIds.Id
      description: The identifier issued to this resource by an external identity provider.
      type: String
    - contextPath: AWS.IAMIdentityCenter.User.Name.Formatted
      description: Formatted version of the user's name for display.
      type: String
    - contextPath: AWS.IAMIdentityCenter.User.Name.FamilyName
      description: The family name of the user.
      type: String
    - contextPath: AWS.IAMIdentityCenter.User.Name.GivenName
      description: The given name of the user.
      type: String
    - contextPath: AWS.IAMIdentityCenter.User.Name.MiddleName
      description: The middle name of the user.
      type: String
    - contextPath: AWS.IAMIdentityCenter.User.Name.HonorificPrefix
      description: The honorific prefix of the user.
      type: String
    - contextPath: AWS.IAMIdentityCenter.User.Name.HonorificSuffix
      description: The honorific suffix of the user.
      type: String
    - contextPath: AWS.IAMIdentityCenter.User.DisplayName
      description: The name of the user formatted for display when referenced.
      type: String
    - contextPath: AWS.IAMIdentityCenter.User.NickName
      description: An alternate name for the user.
      type: String
    - contextPath: AWS.IAMIdentityCenter.User.ProfileUrl
      description: URL associated with the user.
      type: String
    - contextPath: AWS.IAMIdentityCenter.User.Emails.Value
      description: Email address associated with the user.
      type: String
    - contextPath: AWS.IAMIdentityCenter.User.Emails.Type
      description: Type of email address.
      type: String
    - contextPath: AWS.IAMIdentityCenter.User.Emails.Primary
      description: Indicates whether this is the primary email address.
      type: String
    - contextPath: AWS.IAMIdentityCenter.User.Addresses.StreetAddress
      description: Street address.
      type: String
    - contextPath: AWS.IAMIdentityCenter.User.Addresses.Locality
      description: Address locality.
      type: String
    - contextPath: AWS.IAMIdentityCenter.User.Addresses.Region
      description: Region of the address.
      type: String
    - contextPath: AWS.IAMIdentityCenter.User.Addresses.PostalCode
      description: Postal code of the address.
      type: String
    - contextPath: AWS.IAMIdentityCenter.User.Addresses.Country
      description: Country of the address.
      type: String
    - contextPath: AWS.IAMIdentityCenter.User.Addresses.Formatted
      description: Formatted version of the address for display.
      type: String
    - contextPath: AWS.IAMIdentityCenter.User.Addresses.Type
      description: Type of address.
      type: String
    - contextPath: AWS.IAMIdentityCenter.User.Addresses.Primary
      description: Indicates whether this is the primary address.
      type: String
    - contextPath: AWS.IAMIdentityCenter.User.PhoneNumbers.Value
      description: Phone number associated with the user.
      type: String
    - contextPath: AWS.IAMIdentityCenter.User.PhoneNumbers.Type
      description: Type of phone number.
      type: String
    - contextPath: AWS.IAMIdentityCenter.User.PhoneNumbers.Primary
      description: Indicates whether this is the primary phone number.
      type: String
    - contextPath: AWS.IAMIdentityCenter.User.UserType
      description: Type of user.
      type: String
    - contextPath: AWS.IAMIdentityCenter.User.Title
      description: Title of the user.
      type: String
    - contextPath: AWS.IAMIdentityCenter.User.PreferredLanguage
      description: Preferred language of the user.
      type: String
    - contextPath: AWS.IAMIdentityCenter.User.Locale
      description: Geographical region or location of the user.
      type: String
    - contextPath: AWS.IAMIdentityCenter.User.Timezone
      description: Time zone of the user.
      type: String
    - contextPath: AWS.IAMIdentityCenter.User.IdentityStoreId
      description: Globally unique identifier for the identity store.
      type: String
    - contextPath: AWS.IAMIdentityCenter.UserNextToken
      description: Pagination token.
      type: String
  - arguments:
    - auto: PREDEFINED
      description: The AWS Region. If not specified, the default region will be used.
      name: region
      predefined:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - ca-central-1
      - eu-west-1
      - eu-central-1
      - eu-west-2
      - ap-northeast-1
      - ap-northeast-2
      - ap-southeast-1
      - ap-southeast-2
      - ap-south-1
      - sa-east-1
      - eu-north-1
      - eu-west-3
      required: false
    - description: The Amazon Resource Name.
      name: roleArn
      required: false
    - description: Role session duration.
      name: roleSessionDuration
      required: false
    - description: Role session name.
      name: roleSessionName
      required: false
    - description: Identity store ID.
      name: IdentityStoreId
      required: false
    - description: Number of results to return. Maximum value is 50.
      defaultValue: '50'
      name: limit
      required: false
    - description: The pagination token.
      name: nextToken
      required: false
    description: Lists all the IAM groups in the AWS account.
    name: aws-iam-identitycenter-list-groups
    outputs:
    - contextPath: AWS.IAMIdentityCenter.Group.GroupId
      description: The identifier for a group in the identity store.
      type: String
    - contextPath: AWS.IAMIdentityCenter.Group.DisplayName
      description: The display name value for the group.
      type: String
    - contextPath: AWS.IAMIdentityCenter.Group.ExternalIds.Issuer
      description: The issuer for an external identifier.
      type: String
    - contextPath: AWS.IAMIdentityCenter.Group.ExternalIds.Id
      description: The identifier issued to this resource by an external identity provider.
      type: String
    - contextPath: AWS.IAMIdentityCenter.Group.Description
      description: A description of the specified group.
      type: String
    - contextPath: AWS.IAMIdentityCenter.Group.IdentityStoreId
      description: The globally unique identifier for the identity store.
      type: String
    - contextPath: AWS.IAMIdentityCenter.GroupNextToken
      description: The pagination token used for the ListUsers and ListGroups API operations.
      type: String
  - arguments:
    - description: The AWS Region. If not specified, the default region will be used.
      name: region
      required: false
      auto: PREDEFINED
      predefined:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - ca-central-1
      - eu-west-1
      - eu-central-1
      - eu-west-2
      - ap-northeast-1
      - ap-northeast-2
      - ap-southeast-1
      - ap-southeast-2
      - ap-south-1
      - sa-east-1
      - eu-north-1
      - eu-west-3
    - description: The Amazon Resource Name.
      name: roleArn
      required: false
    - description: Role session duration.
      name: roleSessionDuration
      required: false
    - description: Role session name.
      name: roleSessionName
      required: false
    - description: Identity store ID.
      name: IdentityStoreId
      required: false
    - description: Number of results to return. Maximum value is 50.
      defaultValue: '50'
      name: limit
      required: false
    - description: The pagination token.
      name: nextToken
      required: false
    - description: The name of the user to list groups for.
      name: userName
      required: true
    description: Lists the IAM Identity Center groups that the specified IAM user belongs to.
    name: aws-iam-identitycenter-list-groups-for-user
    outputs:
    - contextPath: AWS.IAMIdentityCenter.User.UserId
      description: User ID.
      type: string
    - contextPath: AWS.IAMIdentityCenter.User.GroupMemeberships.MembershipId
      description: The friendly name that identifies the group.
      type: string
    - contextPath: AWS.IAMIdentityCenter.User.GroupMemeberships.GroupId
      description: The stable and unique string identifying the group.
      type: string
  - arguments:
    - description: The AWS Region. If not specified, the default region will be used.
      name: region
      required: false
      auto: PREDEFINED
      predefined:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - ca-central-1
      - eu-west-1
      - eu-central-1
      - eu-west-2
      - ap-northeast-1
      - ap-northeast-2
      - ap-southeast-1
      - ap-southeast-2
      - ap-south-1
      - sa-east-1
      - eu-north-1
      - eu-west-3
    - description: The Amazon Resource Name.
      name: roleArn
      required: false
    - description: Role session duration.
      name: roleSessionDuration
      required: false
    - description: Role session name.
      name: roleSessionName
      required: false
    - description: Identity store ID.
      name: IdentityStoreId
      required: false
    - description: The name of the user to add.
      name: userName
      required: true
    - description: The name of the group to update.
      name: groupName
      required: true
    description: Adds the specified user to the specified group.
    name: aws-iam-identitycenter-add-user-to-group
  - arguments:
    - description: The AWS Region. If not specified, the default region will be used.
      name: region
      required: false
      auto: PREDEFINED
      predefined:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - ca-central-1
      - eu-west-1
      - eu-central-1
      - eu-west-2
      - ap-northeast-1
      - ap-northeast-2
      - ap-southeast-1
      - ap-southeast-2
      - ap-south-1
      - sa-east-1
      - eu-north-1
      - eu-west-3
    - description: The Amazon Resource Name.
      name: roleArn
      required: false
    - description: Role session duration.
      name: roleSessionDuration
      required: false
    - description: Role session name.
      name: roleSessionName
      required: false
    - description: Identity store ID.
      name: IdentityStoreId
      required: false
    - description: The name of the group to search.
      name: displayName
      required: true
    description: Get AWS IAM Identity Center group Information.
    name: aws-iam-identitycenter-get-group
    outputs:
    - contextPath: AWS.IAMIdentityCenter.Group.GroupId
      description: The identifier for a group in the identity store.
      type: String
    - contextPath: AWS.IAMIdentityCenter.Group.DisplayName
      description: The display name of the group.
      type: String
    - contextPath: AWS.IAMIdentityCenter.Group.ExternalIds.Issuer
      description: The issuer for an external identifier.
      type: String
    - contextPath: AWS.IAMIdentityCenter.Group.ExternalIds.Id
      description: The identifier issued to this resource by an external identity provider.
      type: String
    - contextPath: AWS.IAMIdentityCenter.Group.Description
      description: A description of the group.
      type: String
    - contextPath: AWS.IAMIdentityCenter.Group.IdentityStoreId
      description: The globally unique identifier for the identity store.
      type: String
  - arguments:
    - description: The AWS Region. If not specified, the default region will be used.
      name: region
      required: false
      auto: PREDEFINED
      predefined:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - ca-central-1
      - eu-west-1
      - eu-central-1
      - eu-west-2
      - ap-northeast-1
      - ap-northeast-2
      - ap-southeast-1
      - ap-southeast-2
      - ap-south-1
      - sa-east-1
      - eu-north-1
      - eu-west-3
    - description: The Amazon Resource Name.
      name: roleArn
      required: false
    - description: Role session duration.
      name: roleSessionDuration
      required: false
    - description: Role session name.
      name: roleSessionName
      required: false
    - description: Identity store ID.
      name: IdentityStoreId
      required: false
    - description: The email of the user.
      name: emailAddress
      required: true
    description: Retrieves information about the specified IAM user.
    name: aws-iam-identitycenter-get-user-by-email
    outputs:
    - contextPath: AWS.IAMIdentityCenter.User.UserName
      description: The friendly name identifying the user.
      type: string
    - contextPath: AWS.IAMIdentityCenter.User.UserId
      description: The stable and unique string identifying the user.
      type: string
    - contextPath: AWS.IAMIdentityCenter.User.ExternalIds.Issuer
      description: The issuer for an external identifier.
      type: String
    - contextPath: AWS.IAMIdentityCenter.User.ExternalIds.Id
      description: The identifier issued to this resource by an external identity provider.
      type: String
    - contextPath: AWS.IAMIdentityCenter.User.Name.Formatted
      description: Formatted version of the user's name for display.
      type: String
    - contextPath: AWS.IAMIdentityCenter.User.Name.FamilyName
      description: The family name of the user.
      type: String
    - contextPath: AWS.IAMIdentityCenter.User.Name.GivenName
      description: The given name of the user.
      type: String
    - contextPath: AWS.IAMIdentityCenter.User.Name.MiddleName
      description: The middle name of the user.
      type: String
    - contextPath: AWS.IAMIdentityCenter.User.Name.HonorificPrefix
      description: The honorific prefix of the user.
      type: String
    - contextPath: AWS.IAMIdentityCenter.User.Name.HonorificSuffix
      description: The honorific suffix of the user.
      type: String
    - contextPath: AWS.IAMIdentityCenter.User.DisplayName
      description: The name of the user formatted for display when referenced.
      type: String
    - contextPath: AWS.IAMIdentityCenter.User.NickName
      description: An alternate name for the user.
      type: String
    - contextPath: AWS.IAMIdentityCenter.User.ProfileUrl
      description: URL associated with the user.
      type: String
    - contextPath: AWS.IAMIdentityCenter.User.Emails.Value
      description: Email address associated with the user.
      type: String
    - contextPath: AWS.IAMIdentityCenter.User.Emails.Type
      description: Type of email address.
      type: String
    - contextPath: AWS.IAMIdentityCenter.User.Emails.Primary
      description: Indicates whether this is the primary email address.
      type: String
    - contextPath: AWS.IAMIdentityCenter.User.Addresses.StreetAddress
      description: Street address.
      type: String
    - contextPath: AWS.IAMIdentityCenter.User.Addresses.Locality
      description: Address locality.
      type: String
    - contextPath: AWS.IAMIdentityCenter.User.Addresses.Region
      description: Region of the address.
      type: String
    - contextPath: AWS.IAMIdentityCenter.User.Addresses.PostalCode
      description: Postal code of the address.
      type: String
    - contextPath: AWS.IAMIdentityCenter.User.Addresses.Country
      description: Country of the address.
      type: String
    - contextPath: AWS.IAMIdentityCenter.User.Addresses.Formatted
      description: Formatted version of the address for display.
      type: String
    - contextPath: AWS.IAMIdentityCenter.User.Addresses.Type
      description: Type of address.
      type: String
    - contextPath: AWS.IAMIdentityCenter.User.Addresses.Primary
      description: Indicates whether this is the primary address.
      type: String
    - contextPath: AWS.IAMIdentityCenter.User.PhoneNumbers.Value
      description: Phone number associated with the user.
      type: String
    - contextPath: AWS.IAMIdentityCenter.User.PhoneNumbers.Type
      description: Type of phone number.
      type: String
    - contextPath: AWS.IAMIdentityCenter.User.PhoneNumbers.Primary
      description: Indicates whether this is the primary phone number.
      type: String
    - contextPath: AWS.IAMIdentityCenter.User.UserType
      description: Type of user.
      type: String
    - contextPath: AWS.IAMIdentityCenter.User.Title
      description: Title of the user.
      type: String
    - contextPath: AWS.IAMIdentityCenter.User.PreferredLanguage
      description: Preferred language of the user.
      type: String
    - contextPath: AWS.IAMIdentityCenter.User.Locale
      description: Geographical region or location of the user.
      type: String
    - contextPath: AWS.IAMIdentityCenter.User.Timezone
      description: Time zone of the user.
      type: String
    - contextPath: AWS.IAMIdentityCenter.User.IdentityStoreId
      description: Globally unique identifier for the identity store.
      type: String
  - arguments:
    - description: The AWS Region. If not specified, the default region will be used.
      name: region
      auto: PREDEFINED
      predefined:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - ca-central-1
      - eu-west-1
      - eu-central-1
      - eu-west-2
      - ap-northeast-1
      - ap-northeast-2
      - ap-southeast-1
      - ap-southeast-2
      - ap-south-1
      - sa-east-1
      - eu-north-1
      - eu-west-3
      required: false
    - description: The Amazon Resource Name.
      name: roleArn
      required: false
    - description: Role session duration.
      name: roleSessionDuration
      required: false
    - description: Role session name.
      name: roleSessionName
      required: false
    - description: Identity store ID.
      name: IdentityStoreId
      required: false
    - description: The name of the user to remove.
      name: userName
      required: true
    description: Removes the specified user from the AWS IAM Identity Center.
    name: aws-iam-identitycenter-delete-user
  - arguments:
    - auto: PREDEFINED
      description: The AWS Region. If not specified, the default region will be used.
      name: region
      predefined:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - ca-central-1
      - eu-west-1
      - eu-central-1
      - eu-west-2
      - ap-northeast-1
      - ap-northeast-2
      - ap-southeast-1
      - ap-southeast-2
      - ap-south-1
      - sa-east-1
      - eu-north-1
      - eu-west-3
      required: false
    - description: The Amazon Resource Name.
      name: roleArn
      required: false
    - description: Role session duration.
      name: roleSessionDuration
      required: false
    - description: Role session name.
      name: roleSessionName
      required: false
    - description: Identity store ID.
      name: IdentityStoreId
      required: false
    - description: The name of the group to create.
      name: displayName
      required: true
    - description: The description of the group to create.
      name: description
      required: false
    description: Creates a new IAM Identity Center group for your AWS account.
    name: aws-iam-identitycenter-create-group
    outputs:
    - contextPath: AWS.IAMIdentityCenter.Group.GroupId
      description: The user ID.
      type: string
    - contextPath: AWS.IAMIdentityCenter.Group.IdentityStoreId
      description: Identity store ID.
      type: string
  - arguments:
    - auto: PREDEFINED
      description: The AWS Region. If not specified, the default region will be used.
      name: region
      predefined:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - ca-central-1
      - eu-west-1
      - eu-central-1
      - eu-west-2
      - ap-northeast-1
      - ap-northeast-2
      - ap-southeast-1
      - ap-southeast-2
      - ap-south-1
      - sa-east-1
      - eu-north-1
      - eu-west-3
      required: false
    - description: The Amazon Resource Name.
      name: roleArn
      required: false
    - description: Role session duration.
      name: roleSessionDuration
      required: false
    - description: Role session name.
      name: roleSessionName
      required: false
    - description: Identity store ID.
      name: IdentityStoreId
      required: false
    - description: The name of the group to remove.
      name: groupName
      required: true
    description: Removes the specified group from the IAM Identity Center.
    name: aws-iam-identitycenter-delete-group
  - arguments:
    - auto: PREDEFINED
      description: The AWS Region. If not specified, the default region will be used.
      name: region
      predefined:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - ca-central-1
      - eu-west-1
      - eu-central-1
      - eu-west-2
      - ap-northeast-1
      - ap-northeast-2
      - ap-southeast-1
      - ap-southeast-2
      - ap-south-1
      - sa-east-1
      - eu-north-1
      - eu-west-3
      required: false
    - description: The Amazon Resource Name.
      name: roleArn
      required: false
    - description: Role session duration.
      name: roleSessionDuration
      required: false
    - description: Role session name.
      name: roleSessionName
      required: false
    - description: Identity store ID.
      name: IdentityStoreId
      required: false
    - description: The name of the user to delete from all groups.
      name: userName
      required: false
    - description: Comma-separated list of membership IDs to delete.
      name: membershipId
      required: false
    description: Deletes a user from all groups if a username is provided, or deletes multiple memberships if a list of memberships is provided.
    name: aws-iam-identitycenter-delete-group-membership
  - arguments:
    - auto: PREDEFINED
      description: The AWS Region. If not specified, the default region will be used.
      name: region
      predefined:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - ca-central-1
      - eu-west-1
      - eu-central-1
      - eu-west-2
      - ap-northeast-1
      - ap-northeast-2
      - ap-southeast-1
      - ap-southeast-2
      - ap-south-1
      - sa-east-1
      - eu-north-1
      - eu-west-3
      required: false
    - description: The Amazon Resource Name.
      name: roleArn
      required: false
    - description: Role session duration.
      name: roleSessionDuration
      required: false
    - description: Role session name.
      name: roleSessionName
      required: false
    - description: Identity store ID.
      name: IdentityStoreId
      required: false
    - description: Number of results to return. Maximum value is 50.
      defaultValue: '50'
      name: limit
      required: false
    - description: The pagination token.
      name: nextToken
      required: false
    - description: The name of the group to list the memberships.
      name: groupName
      required: true
    description: Lists the memberships of the group.
    name: aws-iam-identitycenter-list-memberships
    outputs:
    - contextPath: AWS.IAMIdentityCenter.GroupMemberships.IdentityStoreId
      description: The globally unique identifier for the identity store.
      type: String
    - contextPath: AWS.IAMIdentityCenter.Group.GroupMemberships.MembershipId
      description: The identifier for a GroupMembership object in an identity store.
      type: String
    - contextPath: AWS.IAMIdentityCenter.Group.GroupId
      description: The identifier for a group in the identity store.
      type: String
    - contextPath: AWS.IAMIdentityCenter.Group.GroupMemberships.UserId
      description: Identifier of resources that can be members.
      type: String
    - contextPath: AWS.IAMIdentityCenter.GroupMembershipNextToken
      description: The pagination token.
      type: String
  - arguments:
    - description: The username of the user to update.
      name: userName
      required: true
    - description: The family name of the user to update.
      name: familyName
      required: false
    - description: The first name of the user to update.
      name: givenName
      required: false
    - description: Is this the primary email address for the associated resource.
      name: userEmailAddressPrimary
      required: false
      auto: PREDEFINED
      predefined:
      - yes
      - no
    - description: The email address of the user to update.
      name: userEmailAddress
      required: false
    - description: The display name of the user to update.
      name: displayName
      required: false
    - description: The profile URL of the user to update.
      name: profileUrl
      required: false
    - description: The type of the user to update.
      name: userType
      required: false
    - description: The title of the user to update.
      name: title
      required: false
    - auto: PREDEFINED
      description: The AWS Region. If not specified, the default region will be used.
      name: region
      predefined:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - ca-central-1
      - eu-west-1
      - eu-central-1
      - eu-west-2
      - ap-northeast-1
      - ap-northeast-2
      - ap-southeast-1
      - ap-southeast-2
      - ap-south-1
      - sa-east-1
      - eu-north-1
      - eu-west-3
      required: false
    - description: The Amazon Resource Name.
      name: roleArn
      required: false
    - description: Role session duration.
      name: roleSessionDuration
      required: false
    - description: Role session name.
      name: roleSessionName
      required: false
    - description: Identity store ID.
      name: IdentityStoreId
      required: false
    description: Updates an IAM Identity Center user for your AWS account.
    name: aws-iam-identitycenter-update-user
  - arguments:
    - auto: PREDEFINED
      description: The AWS Region. If not specified, the default region will be used.
      name: region
      predefined:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - ca-central-1
      - eu-west-1
      - eu-central-1
      - eu-west-2
      - ap-northeast-1
      - ap-northeast-2
      - ap-southeast-1
      - ap-southeast-2
      - ap-south-1
      - sa-east-1
      - eu-north-1
      - eu-west-3
      required: false
    - description: The Amazon Resource Name.
      name: roleArn
      required: false
    - description: Role session duration.
      name: roleSessionDuration
      required: false
    - description: Role session name.
      name: roleSessionName
      required: false
    - description: Identity store ID.
      name: IdentityStoreId
      required: false
    - description: The name of the group to update.
      name: displayName
      required: true
    - description: The description of the group to update.
      name: description
      required: true
    description: Updates an IAM Identity Center group for your AWS account.
    name: aws-iam-identitycenter-update-group
  dockerimage: demisto/boto3py3:1.0.0.10221838
  runonce: false
  script: ''
  subtype: python3
  type: python
fromversion: 5.0.0
tests:
- AWS-IAMIdentityCenter-Test