Collection Access Control
- Last UpdatedJul 11, 2023
- 2 minute read
API for collection access control.
Get Collection Acl
Gets the access control list for the collection.
Request
GET /api/v1/tenants/{tenantId}/namespaces/{namespaceId}/accesscontrol/clientfailover/groups
Parameters
string tenantId
string namespaceId
Response
| Status Code | Body Type | Description |
|---|---|---|
| 200 | AccessControlList | The access control list for the collection. |
| 400 | ErrorResponse | Request is not valid. See the response body for additional details. |
| 403 | ErrorResponse | Request is not authorized. |
| 503 | ErrorResponse | Service unavailable. |
Example response body
200 Response (AccessControlList)
{
"RoleTrusteeAccessControlEntries": [
{
"Trustee": {
"Type": 1,
"ObjectId": "string",
"TenantId": "string"
},
"AccessType": 0,
"AccessRights": 0
}
]
}
Set Collection Acl
Updates the access control list for the collection.
Request
PUT /api/v1/tenants/{tenantId}/namespaces/{namespaceId}/accesscontrol/clientfailover/groups
Parameters
string tenantId
string namespaceId
Request Body
The new access control list.
{
"RoleTrusteeAccessControlEntries": [
{
"Trustee": {
"Type": 1,
"ObjectId": "string",
"TenantId": "string"
},
"AccessType": 0,
"AccessRights": 0
}
]
}
Response
| Status Code | Body Type | Description |
|---|---|---|
| 204 | None | The access control list was updated. |
| 400 | ErrorResponse | Request is not valid. See the response body for additional details. |
| 403 | ErrorResponse | Request is not authorized. |
| 503 | ErrorResponse | Service unavailable. |
Definitions
AccessControlList
Properties
| Property Name | Data Type | Required | Nullable | Description |
|---|---|---|---|---|
| RoleTrusteeAccessControlEntries | [AccessControlEntry] | false | true | None |
{
"RoleTrusteeAccessControlEntries": [
{
"Trustee": {
"Type": 1,
"ObjectId": "string",
"TenantId": "string"
},
"AccessType": 0,
"AccessRights": 0
}
]
}
AccessControlEntry
Properties
| Property Name | Data Type | Required | Nullable | Description |
|---|---|---|---|---|
| Trustee | Trustee | false | true | None |
| AccessType | AccessType | false | false | None |
| AccessRights | int64 | false | false | None |
{
"Trustee": {
"Type": 1,
"ObjectId": "string",
"TenantId": "string"
},
"AccessType": 0,
"AccessRights": 0
}
Trustee
Properties
| Property Name | Data Type | Required | Nullable | Description |
|---|---|---|---|---|
| Type | TrusteeType | false | false | None |
| ObjectId | string | false | true | None |
| TenantId | string | false | true | None |
{
"Type": 1,
"ObjectId": "string",
"TenantId": "string"
}
TrusteeType
Enumerated Values
| Property | Value |
|---|---|
| User | 1 |
| Client | 2 |
| Role | 3 |
AccessType
Enumerated Values
| Property | Value |
|---|---|
| Allowed | 0 |
| Denied | 1 |
ErrorResponse
Response error for controller methods.
Properties
| Property Name | Data Type | Required | Nullable | Description |
|---|---|---|---|---|
| OperationId | string | false | true | Operation identifier |
| Error | string | false | true | Error string |
| Reason | string | false | true | Error reason string |
| Resolution | string | false | true | Resolution string |
| AdditionalParameters | object | false | true | Additional parameters to add to the response. |
{
"OperationId": "string",
"Error": "string",
"Reason": "string",
"Resolution": "string",
"AdditionalParameters": {
"property1": null,
"property2": null
},
"property1": null,
"property2": null
}