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

Setting Application Members

Function

  • This API is used to set members of an application. If an empty array is carried, the existing members are cleared.

  • The setting is a full update, rather than an incremental update. In other words, the members of the application are replaced with the members carried In the request.

URI

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

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

Request Parameters

Table 2 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
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

users

No

Array of strings

Members to add. If the list is empty, all members of the application are cleared.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

total

Integer

Total number of members of an application.

Minimum: 1

Maximum: 5

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.

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

{
  "users" : [ {
    "id" : "06d9106f3b000f241f83c010d6b78c81",
    "roles" : [ "read" ]
  } ]
}

Example Responses

Status code: 200

OK

{
  "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

OK

403

Forbidden

Error Codes

See Error Codes.

Parent topic: Application Management