Help Center/ ROMA Connect/ API Reference/ Public Resource APIs/ Application Management/ Querying Application Members
Updated on 2025-07-18 GMT+08:00
View PDF

Querying Application Members

Function

This API is used to query members of an application.

URI

GET /v2/{project_id}/instances/{instance_id}/apps/{app_id}/users

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

app_id

Yes

String

Application ID.

instance_id

Yes

String

Instance ID.

project_id

Yes

String

Project ID. For details about how to obtain a project ID, see "Appendix" > "Obtaining a Project ID" in this document.
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

user_name

No

String

Name of the member to query. Exact match is used.

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token, which can be obtained by calling the IAM API (value of X-Subject-Token in the response header).

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

total

Integer

Total number of members of an application.

id

String

Application ID.

users

Array of users objects

Members.
Table 5 users

Parameter

Type

Description

id

String

User ID.

name

String

Username.

roles

Array of strings

Application permissions.

  • read: permission to read resources of an application, including API debugging. This permission must be included.

  • access: permission to access resources of an application.

  • delete: permission to delete resources of an application.

  • modify: permission to modify resources of an application, including API release and removal.

  • admin: all permissions on an application and its resources.

  • When only the user admin is provided, all other permissions are automatically applied.

  • The read permission is automatically applied when it is not provided.

Status code: 403

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

error_details

String

Error information.

request_id

String

Request ID.

Example Requests

None

Example Responses

Status code: 200

Query succeeded.

{
  "total" : 1,
  "id" : "b2e6b145-4f3f-4a80-aa45-f4b8029f95a3",
  "users" : [ {
    "id" : "string",
    "name" : "string",
    "roles" : [ "read, access, delete, modify, admin" ]
  } ]
}

Status code: 403

Forbidden

{
  "error_code" : "ROMA.00000101",
  "error_msg" : "error summary",
  "error_details" : "some error details here",
  "request_id" : "13760c1fe8655e61209b75665e9bef43"
}

Status Codes

Status Code

Description

200

Query succeeded.

403

Forbidden

Error Codes

See Error Codes.

Parent topic: Application Management