Create Role¶
Create a role.
Request Format¶
POST https://{apigw-address}/app-portal-service/v2.3/role/create
Request Parameters (URI)¶
Name |
Location (Path/Query) |
Required/Optional |
Data Type |
Description |
|---|---|---|---|---|
orgId |
Query |
Required |
String |
OU ID. How to get orgId >> |
Request Parameters (Body)¶
Name |
Required/Optional |
Data Type |
Description |
|---|---|---|---|
name |
Required |
String |
Role name. |
description |
Required |
String |
Role description. |
Response Parameters¶
Name |
Data Type |
Description |
|---|---|---|
data |
String |
Role ID. |
Error Codes¶
Error Code |
Description |
|---|---|
31400 |
OU ID, role name, and role description are required. |
31403 |
The application has no permission to create roles. |
31404 |
OU ID does not exist, or the OU has no permission to access the application. |
31408 |
The role name already exists. |
Samples¶
Request Sample¶
url: https://{apigw-address}/app-portal-service/v2.3/role/create?orgId=yourOrgId
method: POST
{
"name": "test",
"description": "test"
}
Return Sample¶
{
"code": 0,
"message": "OK",
"data": "your_role_id"
}