Getting Information About Your Users

As a root account, you can get information about the EIM users of your account, including their creation dates, paths, unique IDs and OUTSCALE Resource Names.

Getting Information About Your Users Using Cockpit v2

See the EIM Users dashboard.

Getting Information About Your Users Using OSC CLI

The ReadUsers command lists all EIM users that have a specified path.
If you do not specify a path, this action returns a list of all users in the account (or an empty list if there are none).

Request sample
$ osc-cli api ReadUsers --profile "default"

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.

    • UserIds: (optional) The IDs of the users.

  • FirstItem: (optional) The item starting the list of users requested.

  • ResultsPerPage: (optional) The maximum number of items that can be returned in a single response (by default, 100).

The ReadUsers 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.

  • 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
{
  "Users": [
    {
      "UserEmail": "user@example.com",
      "UserName": "example-user",
      "UserId": "ABCDEFGHIJKLMNOPQRSTUVWXYZ12345",
      "Path": "/documentation/"
    }
  ],
  "ResponseContext": {
    "RequestId": "0475ca1e-d0c5-441d-712a-da55a4175157"
  }
}

Getting Information About Your Users Using oapi-cli

The ReadUsers command lists all EIM users that have a specified path.
If you do not specify a path, this action returns a list of all users in the account (or an empty list if there are none).

Request sample
$ oapi-cli --profile "default" ReadUsers

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.

    • UserIds: (optional) The IDs of the users.

  • FirstItem: (optional) The item starting the list of users requested.

  • ResultsPerPage: (optional) The maximum number of items that can be returned in a single response (by default, 100).

The ReadUsers 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.

  • 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
{
  "Users": [
    {
      "UserEmail": "user@example.com",
      "UserName": "example-user",
      "UserId": "ABCDEFGHIJKLMNOPQRSTUVWXYZ12345",
      "Path": "/documentation/"
    }
  ],
  "ResponseContext": {
    "RequestId": "0475ca1e-d0c5-441d-712a-da55a4175157"
  }
}

Getting Information About Your Users Using AWS CLI

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

Getting Information About a Specific User Using AWS CLI

To get information about a user, use the get-user command following this syntax:

Request sample
$ aws iam get-user \
    --profile YOUR_PROFILE \
    --user-name Jane \
    --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) user-name: The name of the user you want to get information about.

    If you do not specify a user name, this action returns information about the user who sends the request

  • 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-user command returns the following elements:

  • User: Information about the specified user. 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
{
    "User": {
        "UserName": "Jane",
        "Path": "/division/subdivision/",
        "CreateDate": "2016-05-12T06:30:24.165Z",
        "UserId": "1234567890000",
        "Arn": "arn:aws:iam::123456789012:user/Jane"
    }
}

Listing Your Users Using AWS CLI

To get information about EIM users, use the list-users command following this syntax:

Request sample
$ aws iam list-users \
    --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 specific users. If unspecified, you will get information about all users of your account.

  • 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-users command returns the following elements:

  • Users: A list of EIM users. This element contains the following information:

    • UserName: The name of the user.

    • Path: The path for the user.

    • CreateDate: The date and time of creation of the user.

    • UserId: The user ID. For more information, see Resource Identifiers.

    • Arn: The OUTSCALE Resource Name (ORN) of the user. For more information, see Resource Identifiers.

Result sample
{
    "Users": {
        "UserName": "USER_NAME",
        "Path": "/PATH/SUB_PATH/",
        "CreateDate": "2016-05-12T12:12:24.165Z",
        "UserId": "1234567890000",
        "Arn": "arn:aws:iam::123456789012:user/USER_NAME"
    }
}

Related Pages

Corresponding API Method

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

Export to PDF