Get all rights
This document is automatically generated based on https://github.com/authing/authing-docs-factory based on https://api-explorer.genauth.ai V3 API, and is consistent with API parameters and return results. If the description of this document is incorrect, please refer to V3 API.
Get all rights of the current user pool
Method name
ManagementClient.get_all_rights_item
Request parameters
| Name | Type | Required | Default value | Description | Sample value |
|---|
Request Response
Type: CostGetAllRightItemRespDto
| Name | Type | Description |
|---|---|---|
| statusCode | number | Business status code, which can be used to determine whether the operation is successful. 200 means success. |
| message | string | description |
| apiCode | number | Segmented error code, which can be used to get the specific error type (not returned for successful requests). For a detailed list of error codes, see: API Code List |
| requestId | string | Request ID. Returned when the request fails. |
| data | <a RightItemRes | Response data |
Sample result:
json
{
"statusCode": 200,
"message": "Success",
"requestId": "934108e5-9fbf-4d24-8da1-c330328abd6c",
"data": {
"rightsItems": {
"rightsModelCode": "SocialConnections",
"rightsModelName": "SocialConnections",
"dataType": "1: Quantity type, 2: Digital read-only, no measurement, 3: Assertion type, 4: String read-only",
"dataValue": "0"
}
}
}Data Structure
RightItemRes
| Name | Type | Is it required | Description | Sample value |
|---|---|---|---|---|
| rightsItems | array | Yes | Response data Nested type: <a RightItemDto. |
RightItemDto
| Name | Type | Is it required? | Description | Sample value |
|---|---|---|---|---|
| rightsModelCode | string | Yes | Rights code | SocialConnections |
| rightsModelName | string | Yes | Rights name | SocialConnections |
| dataType | string | Yes | Rights data type | 1: Quantity type, 2: Number read-only, no measurement, 3: Assertion type, 4: String read-only |
| dataValue | string | Yes | Rights value | 0 |