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

Modifying Application Role Information

Function

This API is used to modify application role information.

URI

PUT /api/v2/tenant/applications/{application_id}/role/{role_id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

role_id

Yes

String

Role ID.

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

name

Yes

String

Application 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

Modify an application role based on the application ID and role ID, and modify the role name to administrator 2.

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

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

{
  "name": "administrator 2"
}

Example Responses

Status code: 200

Request successful.

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

Status Codes

Status Code

Description

200

Request successful.

400

Request failed.

Error Codes

See Error Codes.