This is the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.

List IAM users

1: 1.4
2: 1.3
3: 1.2
4: 1.1
5: 1.0

1 - 1.4

get /v1/accounts/{account_id}/users

Description

List IAM users

State ACTIVE (CURRENT)

Version	Not Before
1.4	-

Parameters

Type	Name	Description	Schema	Default
path	account_id required	Account ID Field Example :	string	None
query	size optional	size Example : `20`	any of [integer, null]	20
query	page optional	page Example : `0`	any of [integer, null]	0
query	sort optional	sort Example : `created_at:desc`	any of [string, null]	None
query	login_id optional	Login ID Example :	any of [string, null]	None
query	email optional	User Email Example :	any of [string, null]	None
query	nation_id optional	Nation ID Example :	any of [string, null]	None
query	phone_number optional	User Phone Number Example :	any of [string, null]	None
query	user_name optional	User Name Example :	any of [string, null]	None
query	exclude_group_id optional	Exception Target Group Example :	any of [string, null]	None
query	exclude_policy_id optional	Exception Target Policy Example :	any of [string, null]	None
query	type optional	User Type Example :	any of [string, null]	None
query	has_permissions optional	Filter users with policy or group membership (copyable) Example :	any of [boolean, null]	None
query	exclude_user_id optional	User ID to Exclude Example : `f39c460fade34fecb05ede8f904b24b7`	any of [string, null]	None

Responses

HTTP Code	Description	Schema
200	OK	ListIAMUserResponseV1Dot4
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/accounts/{account_id}/users

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = iam 1.4"

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ],
    "users": [
        {
            "access_keys": [],
            "account_id": "",
            "company_name": "",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "",
            "dst_offset": "",
            "email": "",
            "email_authenticated": "",
            "first_name": "",
            "groups": [],
            "id": "",
            "last_login_at": "",
            "last_name": "",
            "last_password_update_at": "",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "",
            "password_reuse_count": "",
            "phone_authenticated": "",
            "policies": [],
            "state": "",
            "timezone": "",
            "type": "",
            "tz_id": "",
            "user_name": "",
            "utc_offset": ""
        }
    ]
}

2 - 1.3

get /v1/accounts/{account_id}/users

Description

List IAM users

State ACTIVE (SUPPORTED)

Version	Not Before
1.3	20261130

Parameters

Type	Name	Description	Schema	Default
path	account_id required	Account ID Field Example :	string	None
query	size optional	size Example : `20`	any of [integer, null]	20
query	page optional	page Example : `0`	any of [integer, null]	0
query	sort optional	sort Example : `created_at:desc`	any of [string, null]	None
query	login_id optional	Login ID Example :	any of [string, null]	None
query	email optional	User Email Example :	any of [string, null]	None
query	nation_id optional	Nation ID Example :	any of [string, null]	None
query	phone_number optional	User Phone Number Example :	any of [string, null]	None
query	user_name optional	User Name Example :	any of [string, null]	None
query	exclude_group_id optional	Exception Target Group Example :	any of [string, null]	None
query	exclude_policy_id optional	Exception Target Policy Example :	any of [string, null]	None
query	type optional	User Type Example :	any of [string, null]	None

Responses

HTTP Code	Description	Schema
200	OK	ListIAMUserResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/accounts/{account_id}/users

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = iam 1.3"

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ],
    "users": [
        {
            "account_id": "",
            "company_name": "",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "",
            "dst_offset": "",
            "email": "",
            "email_authenticated": "",
            "first_name": "",
            "groups": [
                ""
            ],
            "id": "",
            "last_login_at": "",
            "last_name": "",
            "last_password_update_at": "",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "",
            "password_reuse_count": "",
            "phone_authenticated": "",
            "policies": [],
            "state": "",
            "timezone": "",
            "type": "",
            "tz_id": "",
            "user_name": "",
            "utc_offset": ""
        }
    ]
}

3 - 1.2

get /v1/accounts/{account_id}/users

Description

List IAM users

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20260930

Parameters

Type	Name	Description	Schema	Default
path	account_id required	Account ID Field Example :	string	None
query	size optional	size Example : `20`	any of [integer, null]	20
query	page optional	page Example : `0`	any of [integer, null]	0
query	sort optional	sort Example : `created_at:desc`	any of [string, null]	None
query	login_id optional	Login ID Example :	any of [string, null]	None
query	email optional	User Email Example :	any of [string, null]	None
query	nation_id optional	Nation ID Example :	any of [string, null]	None
query	phone_number optional	User Phone Number Example :	any of [string, null]	None
query	user_name optional	User Name Example :	any of [string, null]	None
query	exclude_group_id optional	Exception Target Group Example :	any of [string, null]	None
query	exclude_policy_id optional	Exception Target Policy Example :	any of [string, null]	None
query	type optional	User Type Example :	any of [string, null]	None

Responses

HTTP Code	Description	Schema
200	OK	ListIAMUserResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/accounts/{account_id}/users

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = iam 1.2"

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ],
    "users": [
        {
            "account_id": "",
            "company_name": "",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "",
            "dst_offset": "",
            "email": "",
            "email_authenticated": "",
            "first_name": "",
            "groups": [
                ""
            ],
            "id": "",
            "last_login_at": "",
            "last_name": "",
            "last_password_update_at": "",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "",
            "password_reuse_count": "",
            "phone_authenticated": "",
            "policies": [],
            "state": "",
            "timezone": "",
            "type": "",
            "tz_id": "",
            "user_name": "",
            "utc_offset": ""
        }
    ]
}

4 - 1.1

get /v1/accounts/{account_id}/users

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

Type	Name	Description	Schema	Default
path	account_id required	Account ID Field Example :	string	None
query	size optional	size Example : `20`	any of [integer, null]	20
query	page optional	page Example : `0`	any of [integer, null]	0
query	sort optional	sort Example : `created_at:desc`	any of [string, null]	None
query	login_id optional	Login ID Example :	any of [string, null]	None
query	email optional	User Email Example :	any of [string, null]	None
query	nation_id optional	Nation ID Example :	any of [string, null]	None
query	phone_number optional	User Phone Number Example :	any of [string, null]	None
query	user_name optional	User Name Example :	any of [string, null]	None
query	exclude_group_id optional	Exception Target Group Example :	any of [string, null]	None
query	exclude_policy_id optional	Exception Target Policy Example :	any of [string, null]	None
query	type optional	User Type Example :	any of [string, null]	None

Responses

HTTP Code	Description	Schema
200	OK	ListIAMUserResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/accounts/{account_id}/users

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = iam 1.1"

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ],
    "users": [
        {
            "account_id": "",
            "company_name": "",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "",
            "dst_offset": "",
            "email": "",
            "email_authenticated": "",
            "first_name": "",
            "groups": [
                ""
            ],
            "id": "",
            "last_login_at": "",
            "last_name": "",
            "last_password_update_at": "",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "",
            "password_reuse_count": "",
            "phone_authenticated": "",
            "policies": [],
            "state": "",
            "timezone": "",
            "type": "",
            "tz_id": "",
            "user_name": "",
            "utc_offset": ""
        }
    ]
}

5 - 1.0

get /v1/accounts/{account_id}/users

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

Type	Name	Description	Schema	Default
path	account_id required	Account ID Field Example :	string	None
query	size optional	size Example : `20`	any of [integer, null]	20
query	page optional	page Example : `0`	any of [integer, null]	0
query	sort optional	sort Example : `created_at:desc`	any of [string, null]	None
query	login_id optional	Login ID Example :	any of [string, null]	None
query	email optional	User Email Example :	any of [string, null]	None
query	nation_id optional	Nation ID Example :	any of [string, null]	None
query	phone_number optional	User Phone Number Example :	any of [string, null]	None
query	user_name optional	User Name Example :	any of [string, null]	None
query	exclude_group_id optional	Exception Target Group Example :	any of [string, null]	None
query	exclude_policy_id optional	Exception Target Policy Example :	any of [string, null]	None
query	type optional	User Type Example :	any of [string, null]	None

Responses

HTTP Code	Description	Schema
200	OK	ListIAMUserResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/accounts/{account_id}/users

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = iam 1.0"

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ],
    "users": [
        {
            "account_id": "",
            "company_name": "",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "",
            "dst_offset": "",
            "email": "",
            "email_authenticated": "",
            "first_name": "",
            "groups": [
                ""
            ],
            "id": "",
            "last_login_at": "",
            "last_name": "",
            "last_password_update_at": "",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "",
            "password_reuse_count": "",
            "phone_authenticated": "",
            "policies": [],
            "state": "",
            "timezone": "",
            "type": "",
            "tz_id": "",
            "user_name": "",
            "utc_offset": ""
        }
    ]
}