Getting Information About Your Groups

You can list the groups in your account, the users in a group, the managed policies attached to a group, or the groups to which a user belongs.

To modify users in a group, see Adding or Removing a User from a Group. To modify the name or path of a group, see Modifying a Group.

Getting Information About Your Groups Using Cockpit v2

Listing the Groups in Your Account

See the EIM Groups dashboard.

Listing the Users in a Group

In the EIM Groups dashboard, click the details icon of the group for which you want to list the users.
The EIM group details panel appears.
Click the Added Users tab.
The list of users added to the group appears.

Listing the Managed Policies Attached to a Group

In the EIM Groups dashboard, click the details icon of the group for which you want to list the managed policies attached to.
The EIM group details panel appears.
Click the Attached Managed Policies tab.
The list of managed policies attached to the group appears.

Getting Information About Your Groups Using OSC CLI

Listing the Groups in Your Account

The ReadUserGroups command lists the groups with the specified path prefix.
If you do not specify any path prefix, this action returns all the groups (or an empty list if there are none).

Request sample

$ osc-cli api ReadUserGroups --profile "default" \
    --Filters '{
        "PathPrefix": "/ex",
        "UserGroupIds": ["ug-12345678"]
      }' \
    --FirstItem 1 \
    --ResultsPerPage 30

This command contains the following attributes that you need to specify:

DryRun: (optional) If true, checks whether you have the required permissions to perform the action.
Filters: (optional) One or more filters.
- PathPrefix: (optional) The path prefix of the groups. If not specified, it is set to a slash (/).
- UserGroupIds: (optional) The IDs of the user groups.
FirstItem: (optional) The item starting the list of groups requested.
ResultsPerPage: (optional) The maximum number of items that can be returned in a single response (by default, 100).

The ReadUserGroups command returns the following elements:

HasMoreItems: If true, there are more items to return using the FirstItem parameter in a new request.
MaxResultsLimit: Indicates maximum results defined for the operation.
MaxResultsTruncated: If true, indicates whether requested page size is more than allowed.
ResponseContext: Information about the context of the response.
- RequestId: The ID of the request.
UserGroups: A list of user groups.
- CreationDate: The date and time (UTC) of creation of the user group.
- LastModificationDate: The date and time (UTC) of the last modification of the user group.
- Name: The name of the user group.
- Orn: The Outscale Resource Name (ORN) of the user group. For more information, see Resource Identifiers.
- Path: The path to the user group.
- UserGroupId: The ID of the user group.

Result sample

{
  "ResponseContext": {
    "RequestId": "0475ca1e-d0c5-441d-712a-da55a4175157"
  },
  "HasMoreItems": true,
  "MaxResultsLimit": 30,
  "MaxResultsTruncated": true,
  "UserGroups": [
    {
      "CreationDate": "2010-10-01T12:34:56.789Z",
      "LastModificationDate": "2010-10-01T12:34:56.789Z",
      "Name": "example-usergroup",
      "Orn": "orn:ows:idauth::012345678910:usergroup/example/usergroup-example",
      "Path": "/example/",
      "UserGroupId": "ug-12345678"
    }
  ]
}

Listing the Users in a Group

The ReadUserGroup command lists information about a specified user group, including its users.

Request sample

$ osc-cli api ReadUserGroup --profile "default" \
    --Path "/example/" \
    --UserGroupName "example-usergroup"

This command contains the following attributes that you need to specify:

DryRun: (optional) If true, checks whether you have the required permissions to perform the action.
Path: (optional) The path to the group. If not specified, it is set to a slash (/).
UserGroupName: The name of the group.

The ReadUserGroup command returns the following elements:

ResponseContext: Information about the context of the response.
- RequestId: The ID of the request.
UserGroup: Information about the user group.
- CreationDate: The date and time (UTC) of creation of the user group.
- LastModificationDate: The date and time (UTC) of the last modification of the user group.
- Name: The name of the user group.
- Orn: The Outscale Resource Name (ORN) of the user group. For more information, see Resource Identifiers.
- Path: The path to the user group.
- UserGroupId: The ID of the user group.
Users: A list of EIM users.
- CreationDate: The date and time (UTC) of creation of the EIM user.
- LastModificationDate: The date and time (UTC) of the last modification of the EIM user.
- Path: The path to the EIM user.
- UserEmail: The email address of the EIM user.
- UserId: The ID of the EIM user.
- UserName: The name of the EIM user.

Result sample

{
  "ResponseContext": {
    "RequestId": "0475ca1e-d0c5-441d-712a-da55a4175157"
  },
  "UserGroup": {
    "CreationDate": "2010-10-01T12:34:56.789Z",
    "LastModificationDate": "2010-10-01T12:34:56.789Z",
    "Name": "example-usergroup",
    "Orn": "orn:ows:idauth::012345678910:usergroup/example/usergroup-example",
    "Path": "/example/",
    "UserGroupId": "ug-12345678"
  },
  "Users": [
    {
      "CreationDate": "2010-10-01T12:34:56.789Z",
      "LastModificationDate": "2010-10-01T12:34:56.789Z",
      "Path": "/example/",
      "UserEmail": "user@example.com",
      "UserId": "ABCDEFGHIJKLMNOPQRSTUVWXYZ12345",
      "UserName": "example-user"
    }
  ]
}

Listing the Groups for a User

The ReadUserGroupsPerUser command lists the groups a specified user belongs to.

Request sample

$ osc-cli api ReadUserGroupsPerUser --profile "default" \
    --UserName "example-user" \
    --UserPath "/example/"

This command contains the following attributes that you need to specify:

DryRun: (optional) If true, checks whether you have the required permissions to perform the action.
UserName: The name of the user.
UserPath: (optional) The path to the user (by default, /).

The ReadUserGroupsPerUser command returns the following elements:

ResponseContext: Information about the context of the response.
- RequestId: The ID of the request.
UserGroups: A list of user groups.
- CreationDate: The date and time (UTC) of creation of the user group.
- LastModificationDate: The date and time (UTC) of the last modification of the user group.
- Name: The name of the user group.
- Orn: The Outscale Resource Name (ORN) of the user group. For more information, see Resource Identifiers.
- Path: The path to the user group.
- UserGroupId: The ID of the user group.

Result sample

{
  "ResponseContext": {
    "RequestId": "0475ca1e-d0c5-441d-712a-da55a4175157"
  },
  "UserGroups": [
    {
      "CreationDate": "2010-10-01T12:34:56.789Z",
      "LastModificationDate": "2010-10-01T12:34:56.789Z",
      "Name": "example-usergroup",
      "Orn": "orn:ows:idauth::012345678910:usergroup/example/usergroup-example",
      "Path": "/example/",
      "UserGroupId": "ug-12345678"
    }
  ]
}

Getting Information About Your Groups Using oapi-cli

Listing the Groups in Your Account

The ReadUserGroups command lists the groups with the specified path prefix.
If you do not specify any path prefix, this action returns all the groups (or an empty list if there are none).

Request sample

$ oapi-cli --profile "default" ReadUserGroups \
    --Filters '{
        "PathPrefix": "/ex",
        "UserGroupIds": ["ug-12345678"]
      }' \
    --FirstItem 1 \
    --ResultsPerPage 30

This command contains the following attributes that you need to specify:

DryRun: (optional) If true, checks whether you have the required permissions to perform the action.
Filters: (optional) One or more filters.
- PathPrefix: (optional) The path prefix of the groups. If not specified, it is set to a slash (/).
- UserGroupIds: (optional) The IDs of the user groups.
FirstItem: (optional) The item starting the list of groups requested.
ResultsPerPage: (optional) The maximum number of items that can be returned in a single response (by default, 100).

The ReadUserGroups command returns the following elements:

HasMoreItems: If true, there are more items to return using the FirstItem parameter in a new request.
MaxResultsLimit: Indicates maximum results defined for the operation.
MaxResultsTruncated: If true, indicates whether requested page size is more than allowed.
ResponseContext: Information about the context of the response.
- RequestId: The ID of the request.
UserGroups: A list of user groups.
- CreationDate: The date and time (UTC) of creation of the user group.
- LastModificationDate: The date and time (UTC) of the last modification of the user group.
- Name: The name of the user group.
- Orn: The Outscale Resource Name (ORN) of the user group. For more information, see Resource Identifiers.
- Path: The path to the user group.
- UserGroupId: The ID of the user group.

Result sample

{
  "ResponseContext": {
    "RequestId": "0475ca1e-d0c5-441d-712a-da55a4175157"
  },
  "HasMoreItems": true,
  "MaxResultsLimit": 30,
  "MaxResultsTruncated": true,
  "UserGroups": [
    {
      "CreationDate": "2010-10-01T12:34:56.789Z",
      "LastModificationDate": "2010-10-01T12:34:56.789Z",
      "Name": "example-usergroup",
      "Orn": "orn:ows:idauth::012345678910:usergroup/example/usergroup-example",
      "Path": "/example/",
      "UserGroupId": "ug-12345678"
    }
  ]
}

Listing the Users in a Group

The ReadUserGroup command lists information about a specified user group, including its users.

Request sample

$ oapi-cli --profile "default" ReadUserGroup \
    --Path "/example/" \
    --UserGroupName "example-usergroup"

This command contains the following attributes that you need to specify:

DryRun: (optional) If true, checks whether you have the required permissions to perform the action.
Path: (optional) The path to the group. If not specified, it is set to a slash (/).
UserGroupName: The name of the group.

The ReadUserGroup command returns the following elements:

ResponseContext: Information about the context of the response.
- RequestId: The ID of the request.
UserGroup: Information about the user group.
- CreationDate: The date and time (UTC) of creation of the user group.
- LastModificationDate: The date and time (UTC) of the last modification of the user group.
- Name: The name of the user group.
- Orn: The Outscale Resource Name (ORN) of the user group. For more information, see Resource Identifiers.
- Path: The path to the user group.
- UserGroupId: The ID of the user group.
Users: A list of EIM users.
- CreationDate: The date and time (UTC) of creation of the EIM user.
- LastModificationDate: The date and time (UTC) of the last modification of the EIM user.
- Path: The path to the EIM user.
- UserEmail: The email address of the EIM user.
- UserId: The ID of the EIM user.
- UserName: The name of the EIM user.

Result sample

{
  "ResponseContext": {
    "RequestId": "0475ca1e-d0c5-441d-712a-da55a4175157"
  },
  "UserGroup": {
    "CreationDate": "2010-10-01T12:34:56.789Z",
    "LastModificationDate": "2010-10-01T12:34:56.789Z",
    "Name": "example-usergroup",
    "Orn": "orn:ows:idauth::012345678910:usergroup/example/usergroup-example",
    "Path": "/example/",
    "UserGroupId": "ug-12345678"
  },
  "Users": [
    {
      "CreationDate": "2010-10-01T12:34:56.789Z",
      "LastModificationDate": "2010-10-01T12:34:56.789Z",
      "Path": "/example/",
      "UserEmail": "user@example.com",
      "UserId": "ABCDEFGHIJKLMNOPQRSTUVWXYZ12345",
      "UserName": "example-user"
    }
  ]
}

Listing the Groups for a User

The ReadUserGroupsPerUser command lists the groups a specified user belongs to.

Request sample

$ oapi-cli --profile "default" ReadUserGroupsPerUser \
    --UserName "example-user" \
    --UserPath "/example/"

This command contains the following attributes that you need to specify:

DryRun: (optional) If true, checks whether you have the required permissions to perform the action.
UserName: The name of the user.
UserPath: (optional) The path to the user (by default, /).

The ReadUserGroupsPerUser command returns the following elements:

ResponseContext: Information about the context of the response.
- RequestId: The ID of the request.
UserGroups: A list of user groups.
- CreationDate: The date and time (UTC) of creation of the user group.
- LastModificationDate: The date and time (UTC) of the last modification of the user group.
- Name: The name of the user group.
- Orn: The Outscale Resource Name (ORN) of the user group. For more information, see Resource Identifiers.
- Path: The path to the user group.
- UserGroupId: The ID of the user group.

Result sample

{
  "ResponseContext": {
    "RequestId": "0475ca1e-d0c5-441d-712a-da55a4175157"
  },
  "UserGroups": [
    {
      "CreationDate": "2010-10-01T12:34:56.789Z",
      "LastModificationDate": "2010-10-01T12:34:56.789Z",
      "Name": "example-usergroup",
      "Orn": "orn:ows:idauth::012345678910:usergroup/example/usergroup-example",
      "Path": "/example/",
      "UserGroupId": "ug-12345678"
    }
  ]
}

Getting Information About Your Groups Using AWS CLI

Before you begin: Install and configure AWS CLI. For more information, see Installing and Configuring AWS CLI.

Listing the Groups in Your Account

To list the groups in your account, use the list-groups command following this syntax:

Request sample

$ aws iam list-groups \
    --profile YOUR_PROFILE \
    --path-prefix / \
    --endpoint https://eim.eu-west-2.outscale.com

This command contains the following attributes that you need to specify:

(optional) profile: The named profile you want to use, created when configuring AWS CLI. For more information, see Installing and Configuring AWS CLI.
(optional) path-prefix: The path prefix of the groups you want to list. If not specified, it is set to a slash (/), which lists all the groups.
endpoint: The endpoint corresponding to the Region you want to send the request to. For more information, see Installing and Configuring AWS CLI.

The list-groups command returns the following elements:

Groups: Information about one or more groups. This element contains the following information:
- Path: The path for the group.
- CreateDate: The date and time of creation of the group.
- GroupId: The group ID.
- Arn: The OUTSCALE Resource Name (ORN) of the group.
- GroupName: The group name.

Result sample

"Groups": [
  {
      "Path": "/",
      "CreateDate": "2016-05-12T06:30:24.165Z",
      "GroupId": "LMGPOKFGVV8K6LEXAMPLE",
      "Arn": "arn:aws:iam::123456789012:group/GROUP_NAME",
      "GroupName": "GROUP_NAME"
  },
  {
      "Path": "/",
      "CreateDate": "2016-05-24T16:01:32.124Z",
      "GroupId": "GTXCYYUIXZR2JD8YEXAMPLE",
      "Arn": "arn:aws:iam::123456789012:group/GROUP_NAME_2",
      "GroupName": "GROUP_NAME_2"
  },
]

Listing the Users in a Group

To get the list of users in a group, use the get-group command following this syntax:

Request sample

$ aws iam get-group \
    --profile YOUR_PROFILE \
    --group-name GROUP_NAME \
    --endpoint https://eim.eu-west-2.outscale.com

This command contains the following attributes that you need to specify:

(optional) profile: The named profile you want to use, created when configuring AWS CLI. For more information, see Installing and Configuring AWS CLI.
group-name: The name of the group whose users you want to list.
endpoint: The endpoint corresponding to the Region you want to send the request to. For more information, see Installing and Configuring AWS CLI.

The get-group command returns the following elements:

Group: Information about the group. This element contains the following information:
- Path: The path for the group.
- CreateDate: The date and time of creation of the group.
- GroupId: The group ID.
- Arn: The OUTSCALE Resource Name (ORN) of the group.
- GroupName: The group name.
Users: Information about one or more users that are in the group. This element contains the following information:
- UserName: The user name.
- Path: The path for the user.
- CreateDate: The date and time of creation of the user.
- UserId: The user ID.
- Arn: The OUTSCALE Resource Name (ORN) of the user.

Result sample

{
    "Group": {
      "Path": "/",
      "CreateDate": "2016-05-24T16:01:32.124Z",
      "GroupId": "GTXCYYUIXZR2JD8YEXAMPLE",
      "Arn": "arn:aws:iam::123456789012:group/GROUP_NAME",
      "GroupName": "GROUP_NAME"
    },
        "Users": [
            {
                "UserName": "Jane",
                "Path": "/division/subdivision/",
                "CreateDate": "2016-05-12T06:30:24.165Z",
                "UserId": "1234567890000",
                "Arn": "arn:aws:iam::123456789012:user/USER_NAME"
            },
            {
                "UserName": "John",
                "Path": "/division/subdivision/",
                "CreateDate": "2016-04-12T09:15:08Z",
                "UserId": "0000987654321",
                "Arn": "arn:aws:iam::123456789012:user/USER_NAME_2"
            }
]
}

Listing the Groups for a User

In Cockpit, the list of groups to which a user belongs is available on the Groups page, when you click Add/remove group . For more information, see Adding or Removing a User from a Group.

To get the list of groups to which a user belongs, use the list-groups-for-user command following this syntax:

Request sample

$ aws iam list-groups-for-user \
    --profile YOUR_PROFILE \
    --user-name USER_NAME \
    --endpoint https://eim.eu-west-2.outscale.com

This command contains the following attributes that you need to specify:

(optional) profile: The named profile you want to use, created when configuring AWS CLI. For more information, see Installing and Configuring AWS CLI.
user-name: The name of the user.
endpoint: The endpoint corresponding to the Region you want to send the request to. For more information, see Installing and Configuring AWS CLI.

The list-groups-for-user command returns the following elements:

Groups: Information about one or more groups the specified user belongs to. This element contains the following information:
- Path: The path for the group.
- CreateDate: The date and time of creation of the group.
- GroupId: The group ID.
- Arn: The OUTSCALE Resource Name (ORN) of the group.
- GroupName: The group name.

Result sample

"Groups": [
  {
      "Path": "/",
      "CreateDate": "2016-05-12T06:30:24.165Z",
      "GroupId": "LMGPOKFGVV8K6LEXAMPLE",
      "Arn": "arn:aws:iam::123456789012:group/GROUP_NAME",
      "GroupName": "GROUP_NAME"
  },
  {
      "Path": "/",
      "CreateDate": "2016-05-24T16:01:32.124Z",
      "GroupId": "GTXCYYUIXZR2JD8YEXAMPLE",
      "Arn": "arn:aws:iam::123456789012:group/GROUP_NAME_2",
      "GroupName": "GROUP_NAME_2"
  },
]

Related Pages

Corresponding API Methods

AWS™ and Amazon Web Services™ are trademarks of Amazon Technologies, Inc or its affiliates in the United States and/or other countries.