Access
- Last UpdatedJan 24, 2024
- 2 minute read
Get Collection Acl
Returns the AccessControlList of the softwaremanagement collection.
Request
GET /api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/accesscontrol/softwaremanagement
Parameters
string tenantId
Tenant identifier.string namespaceId
Namespace identifier.
Response
| Status Code | Body Type | Description |
|---|---|---|
| 200 | AccessControlList | Success. |
| 403 | ErrorResponse | Forbidden. |
| 500 | ErrorResponse | Internal server error. |
Example response body
200 Response
{
"RoleTrusteeAccessControlEntries": [
{
"Trustee": {
"Type": 3,
"ObjectId": "00000000-0000-0000-0000-000000000000"
},
"AccessType": 0,
"AccessRights": 15
}
]
}
403 Response (ErrorResponse)
{
"OperationId": "string",
"Error": "string",
"Reason": "string",
"Resolution": "string",
"DynamicProperties": {
"property1": null,
"property2": null
},
"property1": null,
"property2": null
}
Set Acl
Replaces the AccessControlList of the softwaremanagement collection.
Request
PUT /api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/accesscontrol/softwaremanagement
Parameters
string tenantId
Tenant identifier.string namespaceId
Namespace identifier.
Request Body
The ACL object.
{
"RoleTrusteeAccessControlEntries": [
{
"Trustee": {
"Type": 1,
"ObjectId": "string",
"TenantId": "string"
},
"AccessType": 0,
"AccessRights": 0
}
]
}
Response
| Status Code | Body Type | Description |
|---|---|---|
| 200 | AccessControlList | The new AccessControlList. |
| 400 | ErrorResponse | Missing or invalid inputs. |
| 403 | ErrorResponse | Forbidden. |
| 404 | ErrorResponse | None |
| 500 | ErrorResponse | Internal server error. |
Example response body
200 Response
{
"RoleTrusteeAccessControlEntries": [
{
"Trustee": {
"Type": 3,
"ObjectId": "00000000-0000-0000-0000-000000000000"
},
"AccessType": 0,
"AccessRights": 15
}
]
}
400 Response (ErrorResponse)
{
"OperationId": "string",
"Error": "string",
"Reason": "string",
"Resolution": "string",
"DynamicProperties": {
"property1": null,
"property2": null
},
"property1": null,
"property2": null
}
List Access Rights
Returns a list of the CommonAccessRights the requesting Identity has on the assetrules collection.
Request
GET /api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/accessrights/softwaremanagement
Parameters
string tenantId
Tenant identifier.string namespaceId
Namespace identifier.
Response
| Status Code | Body Type | Description |
|---|---|---|
| 200 | Inline | The CommonAccessRights the requesting Identity has on the softwaremanagement collection. |
| 403 | ErrorResponse | Forbidden. |
| 404 | ErrorResponse | None |
| 500 | ErrorResponse | Internal server error. |
Example response body
200 Response
[
"Read",
"Write",
"Delete",
"ManageAccessControl"
]
403 Response (ErrorResponse)
{
"OperationId": "string",
"Error": "string",
"Reason": "string",
"Resolution": "string",
"DynamicProperties": {
"property1": null,
"property2": null
},
"property1": null,
"property2": null
}
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
Properties
| Property Name | Data Type | Required | Nullable | Description |
|---|---|---|---|---|
| OperationId | string | true | false | None |
| Error | string | true | false | None |
| Reason | string | true | false | None |
| Resolution | string | true | false | None |
| DynamicProperties | object | false | true | None |
{
"OperationId": "string",
"Error": "string",
"Reason": "string",
"Resolution": "string",
"DynamicProperties": {
"property1": null,
"property2": null
},
"property1": null,
"property2": null
}