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

Return to the regular view of this page.

Get 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/{user_id}

Description

Get 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
path	user_id required	User ID Example :	string	None

Responses

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

Example HTTP request

Request path

/v1/accounts/{account_id}/users/{user_id}

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

{
    "access_keys": [],
    "account_id": "",
    "company_name": "",
    "created_at": "2024-05-17T00:23:17Z",
    "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
    "created_by_name": "",
    "description": "",
    "dst_offset": "",
    "email": "",
    "email_authenticated": "",
    "first_name": "",
    "id": "",
    "last_login_at": "",
    "last_name": "",
    "last_password_update_at": "",
    "modified_at": "2024-05-17T00:23:17Z",
    "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
    "modified_by_name": "",
    "name": "",
    "password_reuse_count": "",
    "phone_authenticated": "",
    "policies": [],
    "resource_type": "User",
    "service": "iam",
    "service_name": "Identity Access Management",
    "srn": "",
    "state": "",
    "timezone": "",
    "type": "",
    "tz_id": "",
    "user_name": "",
    "utc_offset": ""
}

2 - 1.3

get /v1/accounts/{account_id}/users/{user_id}

Description

Get 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
path	user_id required	User ID Example :	string	None

Responses

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

Example HTTP request

Request path

/v1/accounts/{account_id}/users/{user_id}

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

{
    "account_id": "",
    "company_name": "",
    "created_at": "2024-05-17T00:23:17Z",
    "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
    "created_by_name": "",
    "description": "",
    "dst_offset": "",
    "email": "",
    "email_authenticated": "",
    "first_name": "",
    "id": "",
    "last_login_at": "",
    "last_name": "",
    "last_password_update_at": "",
    "modified_at": "2024-05-17T00:23:17Z",
    "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
    "modified_by_name": "",
    "name": "",
    "password_reuse_count": "",
    "phone_authenticated": "",
    "policies": [],
    "resource_type": "User",
    "service": "iam",
    "service_name": "Identity Access Management",
    "srn": "",
    "state": "",
    "timezone": "",
    "type": "",
    "tz_id": "",
    "user_name": "",
    "utc_offset": ""
}

3 - 1.2

get /v1/accounts/{account_id}/users/{user_id}

Description

Get 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
path	user_id required	User ID Example :	string	None

Responses

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

Example HTTP request

Request path

/v1/accounts/{account_id}/users/{user_id}

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

{
    "account_id": "",
    "company_name": "",
    "created_at": "2024-05-17T00:23:17Z",
    "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
    "created_by_name": "",
    "description": "",
    "dst_offset": "",
    "email": "",
    "email_authenticated": "",
    "first_name": "",
    "id": "",
    "last_login_at": "",
    "last_name": "",
    "last_password_update_at": "",
    "modified_at": "2024-05-17T00:23:17Z",
    "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
    "modified_by_name": "",
    "name": "",
    "password_reuse_count": "",
    "phone_authenticated": "",
    "policies": [],
    "resource_type": "User",
    "service": "iam",
    "service_name": "Identity Access Management",
    "srn": "",
    "state": "",
    "timezone": "",
    "type": "",
    "tz_id": "",
    "user_name": "",
    "utc_offset": ""
}

4 - 1.1

get /v1/accounts/{account_id}/users/{user_id}

Description

Get 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
path	user_id required	User ID Example :	string	None

Responses

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

Example HTTP request

Request path

/v1/accounts/{account_id}/users/{user_id}

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

{
    "account_id": "",
    "company_name": "",
    "created_at": "2024-05-17T00:23:17Z",
    "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
    "created_by_name": "",
    "description": "",
    "dst_offset": "",
    "email": "",
    "email_authenticated": "",
    "first_name": "",
    "id": "",
    "last_login_at": "",
    "last_name": "",
    "last_password_update_at": "",
    "modified_at": "2024-05-17T00:23:17Z",
    "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
    "modified_by_name": "",
    "name": "",
    "password_reuse_count": "",
    "phone_authenticated": "",
    "policies": [],
    "resource_type": "User",
    "service": "iam",
    "service_name": "Identity Access Management",
    "srn": "",
    "state": "",
    "timezone": "",
    "type": "",
    "tz_id": "",
    "user_name": "",
    "utc_offset": ""
}

5 - 1.0

get /v1/accounts/{account_id}/users/{user_id}

Description

Get 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
path	user_id required	User ID Example :	string	None

Responses

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

Example HTTP request

Request path

/v1/accounts/{account_id}/users/{user_id}

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

{
    "account_id": "",
    "company_name": "",
    "created_at": "2024-05-17T00:23:17Z",
    "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
    "created_by_name": "",
    "description": "",
    "dst_offset": "",
    "email": "",
    "email_authenticated": "",
    "first_name": "",
    "id": "",
    "last_login_at": "",
    "last_name": "",
    "last_password_update_at": "",
    "modified_at": "2024-05-17T00:23:17Z",
    "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
    "modified_by_name": "",
    "name": "",
    "password_reuse_count": "",
    "phone_authenticated": "",
    "policies": [],
    "resource_type": "User",
    "service": "iam",
    "service_name": "Identity Access Management",
    "srn": "",
    "state": "",
    "timezone": "",
    "type": "",
    "tz_id": "",
    "user_name": "",
    "utc_offset": ""
}