Query User with Permission

Last Updated on : 2023-07-06 08:20:22download

Query the information about all the users with a specified permission under a specified organization.

API address

POST: /v1.0/iot-03/idaas-prod/spaces/{space_id}/organizations/{organization_code}/users/actions/query

Request parameter

Parameter name	Type	IN	Required	Description
organization_code	String	uri	true	The identifier of a specified organization.
space_id	String	uri	true	The ID of a specified space.

Description of body

Parameter name	Type	Required	Description
role_code	String	false	The identifier of a specified role.
page_number	Integer	false	The current page number.
page_size	Integer	false	The number of items per page.

Return parameter

Parameter name	Type	Description
result	Page	The returned result on pages, including the current page number, number of items on each page, total number of pages, total number of items, and specific data.

Description of result

Parameter name	Type	Description
total_count	Integer	The total number of items that are found.
total_pages	Integer	The total number of pages.
page_number	Integer	The current page number.
page_size	Integer	The number of items per page.
results	IdaasUserParam	The list of results.

Description of results

Parameter name	Type	Description
gmt_modified	Long	The time when it is modified.
gmt_create	Long	The time when it is created.
remark	String	The remarks.
uid	String	The user's identifier.
space_id	String	The ID of a specified space.
username	String	The username.
type	Integer	The user type.

Request example

POST: /v1.0/iot-03/idaas-prod/spaces/1400335346549391440/organizations/Acode/users/actions/query

{
  "role_code": "Acode",
  "page_number": 1,
  "page_size": 10
}

Return example

{
    "result": {
        "total_count": 1,
        "total_pages": 1,
        "page_number": 1,
        "results": [
            {
                "gmt_create": "1622775600000",
                "remark": "Remarks",
                "gmt_modified": "1622775600000",
                "type": 0,
                "uid": "052533b7bf1d41c78505e421daa3f29a",
                "space_id": "1400335346549391440",
                "username": "username"
            }
        ],
        "page_size": 20
    },
    "t": 1629272469492,
    "success": true
}

Error code

For more information, see error code.