Help Center> ROMA Connect> API Reference> Public Resource APIs> Application Management> Querying Candidate Members
View PDF

Querying Candidate Members

Function

This API is used to query candidate members of an application. Members in the abnormal state are filtered out.

URI

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

Table 1 Path parameters

Parameter

Mandatory

Type

Description

app_id

Yes

String

Application ID.

Minimum: 0

Maximum: 64

instance_id

Yes

String

Instance ID.

Minimum: 0

Maximum: 64

project_id

Yes

String

Project ID.

Minimum: 0

Maximum: 64
Table 2 Query parameters

Parameter

Mandatory

Type

Description

filter

No

String

Filter criteria.

  • If this parameter is not specified, all candidate members including the existing application members are returned.

  • If this parameter is set to members, the existing application members are filtered out. This parameter is used when you want to add members in incremental mode.

Minimum: 0

Maximum: 64

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).

Minimum: 1

Maximum: 100000

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

users

Array of CandidatesUser objects

Candidate members.
Table 5 CandidatesUser

Parameter

Type

Description

name

String

Username.

Minimum: 0

Maximum: 64

id

String

User ID.

Minimum: 0

Maximum: 64

Status code: 403

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

Minimum: 1

Maximum: 128

error_msg

String

Error message.

Minimum: 1

Maximum: 128

error_details

String

Error information.

Minimum: 1

Maximum: 128

request_id

String

Request ID.

Minimum: 1

Maximum: 128

Example Requests

None

Example Responses

Status code: 200

OK

{
  "users" : [ {
    "name" : "chenjunjie 00296820",
    "id" : "06d9106f3b000f241f83c010d6b78c81"
  } ],
  "name" : "fdi-dm",
  "id" : "076d742f028025191fe9c0109200f5c8"
}

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

OK

403

Forbidden

Error Codes

See Error Codes.

Parent topic: Application Management