Retrieve the property of users

get {protocol}://{userdomain}:{port}/api/open/v1/users

Returns basic information for a user. If no account query parameter is provided, it returns a list of all users.
The account parameter is case-insensitive, and if no matching account is found, an invalid parameter error is returned.

Responses

Response body

object

result

integer

required

The result to include:

40200 - success
40401 - invalid parameter
40403 - no permission
40405 - license feature deny
40405 - item not found
40408 - item existed
40411 - access control deny （IP allow list）
40420 - invalid access token
40426 - verification failure
50503 - out of service

40200 40401 40403 40405 40408 40411 40420 40426 50503

data

array of objects | null

User list.

data

object

int32

required

1 to 2147483647

The id for an object.

account

string

required

length ≤ 128

User email.

adserver_name

string

length ≤ 256

The name for an object.

role

string

required

The role to include:

member - member
group_manager - group manager
admin - team administrator
onwer - team owner

member group_manager admin owner

groups

array of objects

required

length ≤ 1024

The group which the user is associated. For default group, its group id is 0.

groups*

object

int32

required

1 to 2147483647

The id for an object.

name

string

required

length ≤ 256

The name for an object.

category

string

required

The category to include:

local_user - general user
ad_user - individual ad user
ad_group - ad group
ad_group_member - ad group member
sso_user - sso user
sso_group - sso group
sso_group_member - sso group member

local_user ad_user ad_group ad_group_member sso_user sso_group sso_group_member

sos

boolean

required

SOS capability settings of the user.

web

boolean

required

Web access capability settings of the user.

status

boolean

required

Status settings of the user.

sos_result

boolean

required

SOS capability result of the user.

web_result

boolean

required

Web access capability result of the user.

status_result

boolean

required

Status result of the user.

ad_server_id

int32

1 to 2147483647

The id for an object.

ad_server_name

string

The name of the AD server.
This item is only displayed for ad_user or ad_group.

auth_method_id

integer

The id of the auth method.

For users in sso_user and sso_group, its auth_method_id field is its associated sso profile's id.

For users in other categories, its auth_method_id field is always 0.

auth_method_name

string

The name of the auth method.
This item is only displayed for sso_user or sso_group.

errmsg

string

length ≤ 256

Error message.

Language

Credentials

OAuth2

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://user.domain.com:443/api/open/v1/users \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successful response.

429Error response for too many request.

defaultDefault api error response.