SpaceBlocks.Permissions.WebServices.Main.Api Public (v1)
Download OpenAPI specification:Download
This is the public API.
Upsert all members of an existing resource on a specific role in a PATCH bulk operation. An existing member gets their role updated; a new member gets the role assigned on the resource.
Authorizations:
path Parameters
| resourceTypeId required | string The resourceTypeId |
| resourceId required | string The resourceId |
Request Body schema:
the UpsertMemberRequest object
object or null | |
object or null |
Responses
Request samples
- Payload
Response samples
- 200
- 401
- 404
Stop subjects from accessing a specific resource.
Authorizations:
path Parameters
| resourceTypeId required | string The resourceTypeId |
| resourceId required | string The resourceId |
Request Body schema:
the DeleteMemberRequest object
| subjectIds | Array of strings unique |
Responses
Request samples
- Payload
Response samples
- 200
- 401
- 404
Get all resources within the given tenantId where the subject has the requested permissions.
Authorizations:
path Parameters
| resourceTypeId required | string The key to the corresponding permission-level of the resource |
query Parameters
| permissionScope | string The slug of the resource type on which the permission to check is defined |
| permission | Array of strings unique The permission slug to check (can occur multiple times) |
Responses
Response samples
- 200
- 401
Get the permissions of the subject on the requested resource.
Authorizations:
path Parameters
| resourceTypeId required | string The ID of the resource type |
| resourceId required | string The ID of the resource |
| subjectId required | string The ID of the subject to check permissions for |
Responses
Response samples
- 200
- 401
Check if the subject has the requested sub-level permissions on the requested resource.
Authorizations:
path Parameters
| resourceTypeId required | string The ID of the resource type |
| resourceId required | string The ID of the resource |
| subjectId required | string The ID of the subject for which the permissions should be checked |
query Parameters
| permissionScope | string The slug of the resource type on which the permission to check is defined |
| permission | Array of strings unique The permission slug to check (can occur multiple times) |
Responses
Response samples
- 200
- 401
Update a role
This triggers a recalculation of the permission tree.
Authorizations:
path Parameters
| id required | string The ID of the role to update |
Request Body schema:
The updateRoleRequest DTO
| name | string or null |
| description | string or null |
object or null |
Responses
Request samples
- Payload
Response samples
- 200
- 401
- 404
Upsert Tenant Members
Upsert all members of an existing resource on a specific role in a PATCH bulk operation. An existing member gets their role updated; a new member gets the role assigned on the resource. This triggers a recalculation of the permission tree.
Authorizations:
Request Body schema:
the UpsertMemberRequest object
object or null | |
object or null |
Responses
Request samples
- Payload
Response samples
- 200
- 401
- 404
Stop subjects from accessing a specific resource.
This triggers a recalculation of the permission tree.
Authorizations:
Request Body schema:
the DeleteMemberRequest object
| subjectIds | Array of strings unique |
Responses
Request samples
- Payload
Response samples
- 200
- 401
- 404
Check if the subject has the requested sub-level permissions on the requested resource.
Authorizations:
path Parameters
| subjectId required | string The ID of the subject for which the permissions should be checked |
query Parameters
| permissionScope | string The slug of the resource type on which the permission to check is defined |
| permission | Array of strings unique The permission slug to check (can occur multiple times) |
Responses
Response samples
- 200
- 401