Queries role information using OpenAPI.
Endpoints and authorization information
Obtain an endpoint to replace {domain} in the API request syntax.
Product | Resource | Required permission |
Organization Management | Organization role | Read-only |
Request syntax
GET https://{domain}/oapi/v1/platform/organizations/roles/{id}Request headers
Parameter | Type | Required | Description | Example |
x-yunxiao-token | string | Yes | Personal access token. | pt-0fh3****0fbG_35af****0484 |
Request parameters
Parameter | Type | Position | Required | Description | Example |
id | string | path | Yes | The role ID. |
Request examples
curl -X 'GET' \
'https://{domain}/oapi/v1/platform/organizations/roles/{id}' \
-H 'Content-Type: application/json' \
-H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484'Response parameters
Parameter | Type | Description | Example |
| - | object | ||
id | string | The role ID. | 99d1****6124 |
name | string | The role name. | Sample Name |
organizationId | string | The organization ID. | 99d1****6124 |
permissions | array[string] | The list of permissions for the role. | ["base******"] |
Response example
{
"id": "99d1****6124",
"name": "Sample Name",
"organizationId": "99d1****6124",
"permissions": ["base******"]
}Error codes
For more information about error codes, see the Error Code Center.