This is the multi-page printable view of this section. Click here to print.
List IAM users
1 - 1.4
scp-cli iam iam user list
--account_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--login_id <value>]
[--email <value>]
[--nation_id <value>]
[--phone_number <value>]
[--user_name <value>]
[--exclude_group_id <value>]
[--exclude_policy_id <value>]
[--type <value>]
[--has_permissions <value>]
[--exclude_user_id <value>]
Description
List IAM users
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.4 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| account_id required | string | Account ID Field | - |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| login_id optional | string | Login ID | - |
| email optional | string | User Email | - |
| nation_id optional | string | Nation ID | - |
| phone_number optional | string | User Phone Number | - |
| user_name optional | string | User Name | - |
| exclude_group_id optional | string | Exception Target Group | - |
| exclude_policy_id optional | string | Exception Target Policy | - |
| type optional | string | User Type | - |
| has_permissions optional | boolean | Filter users with policy or group membership (copyable) | - |
| exclude_user_id optional | string | User ID to Exclude | f39c460fade34fecb05ede8f904b24b7 |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | |
| access_keys | Access Keys | [] |
| account_id | Account ID | |
| company_name | Company Name | |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | User Description | |
| dst_offset | DST Offset | |
| User Email | ||
| email_authenticated | Email Authentication Status | |
| first_name | User Name | |
| groups | groups | |
| last_login_at | Last Login | |
| last_name | User Last Name | |
| last_password_update_at | Last Password Update Time | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Name | |
| password_reuse_count | Password Reuse Count | |
| phone_authenticated | Phone Authentication Status | |
| policies | User Policies | [] |
| state | Status | |
| timezone | Timezone ID | |
| type | Type | |
| tz_id | Timezone ID | |
| user_name | User Name | |
| utc_offset | UTC Offset |
2 - 1.3
scp-cli iam iam user list
--account_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--login_id <value>]
[--email <value>]
[--nation_id <value>]
[--phone_number <value>]
[--user_name <value>]
[--exclude_group_id <value>]
[--exclude_policy_id <value>]
[--type <value>]
Description
List IAM users
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.3 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| account_id required | string | Account ID Field | - |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| login_id optional | string | Login ID | - |
| email optional | string | User Email | - |
| nation_id optional | string | Nation ID | - |
| phone_number optional | string | User Phone Number | - |
| user_name optional | string | User Name | - |
| exclude_group_id optional | string | Exception Target Group | - |
| exclude_policy_id optional | string | Exception Target Policy | - |
| type optional | string | User Type | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | |
| account_id | Account ID | |
| company_name | Company Name | |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | User Description | |
| dst_offset | DST Offset | |
| User Email | ||
| email_authenticated | Email Authentication Status | |
| first_name | User Name | |
| groups | Group Names | |
| last_login_at | Last Login | |
| last_name | User Last Name | |
| last_password_update_at | Last Password Update Time | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Name | |
| password_reuse_count | Password Reuse Count | |
| phone_authenticated | Phone Authentication Status | |
| policies | User Policies | [] |
| state | Status | |
| timezone | Timezone ID | |
| type | Type | |
| tz_id | Timezone ID | |
| user_name | User Name | |
| utc_offset | UTC Offset |
3 - 1.2
scp-cli iam iam user list
--account_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--login_id <value>]
[--email <value>]
[--nation_id <value>]
[--phone_number <value>]
[--user_name <value>]
[--exclude_group_id <value>]
[--exclude_policy_id <value>]
[--type <value>]
Description
List IAM users
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20260930 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| account_id required | string | Account ID Field | - |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| login_id optional | string | Login ID | - |
| email optional | string | User Email | - |
| nation_id optional | string | Nation ID | - |
| phone_number optional | string | User Phone Number | - |
| user_name optional | string | User Name | - |
| exclude_group_id optional | string | Exception Target Group | - |
| exclude_policy_id optional | string | Exception Target Policy | - |
| type optional | string | User Type | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | |
| account_id | Account ID | |
| company_name | Company Name | |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | User Description | |
| dst_offset | DST Offset | |
| User Email | ||
| email_authenticated | Email Authentication Status | |
| first_name | User Name | |
| groups | Group Names | |
| last_login_at | Last Login | |
| last_name | User Last Name | |
| last_password_update_at | Last Password Update Time | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Name | |
| password_reuse_count | Password Reuse Count | |
| phone_authenticated | Phone Authentication Status | |
| policies | User Policies | [] |
| state | Status | |
| timezone | Timezone ID | |
| type | Type | |
| tz_id | Timezone ID | |
| user_name | User Name | |
| utc_offset | UTC Offset |
4 - 1.1
scp-cli iam iam user list
--account_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--login_id <value>]
[--email <value>]
[--nation_id <value>]
[--phone_number <value>]
[--user_name <value>]
[--exclude_group_id <value>]
[--exclude_policy_id <value>]
[--type <value>]
Description
List IAM users
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| account_id required | string | Account ID Field | - |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| login_id optional | string | Login ID | - |
| email optional | string | User Email | - |
| nation_id optional | string | Nation ID | - |
| phone_number optional | string | User Phone Number | - |
| user_name optional | string | User Name | - |
| exclude_group_id optional | string | Exception Target Group | - |
| exclude_policy_id optional | string | Exception Target Policy | - |
| type optional | string | User Type | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | |
| account_id | Account ID | |
| company_name | Company Name | |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | User Description | |
| dst_offset | DST Offset | |
| User Email | ||
| email_authenticated | Email Authentication Status | |
| first_name | User Name | |
| groups | Group Names | |
| last_login_at | Last Login | |
| last_name | User Last Name | |
| last_password_update_at | Last Password Update Time | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Name | |
| password_reuse_count | Password Reuse Count | |
| phone_authenticated | Phone Authentication Status | |
| policies | User Policies | [] |
| state | Status | |
| timezone | Timezone ID | |
| type | Type | |
| tz_id | Timezone ID | |
| user_name | User Name | |
| utc_offset | UTC Offset |
5 - 1.0
scp-cli iam iam user list
--account_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--login_id <value>]
[--email <value>]
[--nation_id <value>]
[--phone_number <value>]
[--user_name <value>]
[--exclude_group_id <value>]
[--exclude_policy_id <value>]
[--type <value>]
Description
List IAM users
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| account_id required | string | Account ID Field | - |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| login_id optional | string | Login ID | - |
| email optional | string | User Email | - |
| nation_id optional | string | Nation ID | - |
| phone_number optional | string | User Phone Number | - |
| user_name optional | string | User Name | - |
| exclude_group_id optional | string | Exception Target Group | - |
| exclude_policy_id optional | string | Exception Target Policy | - |
| type optional | string | User Type | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | |
| account_id | Account ID | |
| company_name | Company Name | |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | User Description | |
| dst_offset | DST Offset | |
| User Email | ||
| email_authenticated | Email Authentication Status | |
| first_name | User Name | |
| groups | Group Names | |
| last_login_at | Last Login | |
| last_name | User Last Name | |
| last_password_update_at | Last Password Update Time | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Name | |
| password_reuse_count | Password Reuse Count | |
| phone_authenticated | Phone Authentication Status | |
| policies | User Policies | [] |
| state | Status | |
| timezone | Timezone ID | |
| type | Type | |
| tz_id | Timezone ID | |
| user_name | User Name | |
| utc_offset | UTC Offset |