Help Center/ OneAccess/ API Reference/ OneAccess APIs/ Management APIs/ Application Role Management/ Adding an Application Role
Updated on 2024-12-30 GMT+08:00
View PDF
Share

Adding an Application Role

Function

This API is used to add an application role.

Constraints

null

URI

POST /api/v2/tenant/applications/{application_id}/role

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

application_id

Yes

String

Application ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

Content-Type

Yes

String

Set this field to "application/json;charset=utf8".

Authorization

Yes

String

Authentication credential. The value is "Bearer {access_token}". access_token is obtained by calling the API for obtaining an access credential.
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

code

Yes

String

Role code, which is unique in an application.

name

No

String

Role name.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

role_id

String

Role ID.

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error details.

Example Requests

Add an application role based on the application ID. Role code: admin1; role name: administrator 1.

POST https://{domain_name}/api/v2/tenant/applications/{application_id}/role

Authorization: Bearer 334963fc-1e4a-473b-9096-52a929140...

{
    "code": "admin1",
    "name": "administrator 1"
}

Example Responses

Status code: 200

Role ID.

{
  "role_id" : "20220420140745089-23E4-DFF0A1900"
}

Status Codes

Status Code

Description

200

Role ID.

400

Request failed.

Error Codes

See Error Codes.