Creates an instance of the RoleAssignmentsApi.
The configuration object for the Permit SDK.
The logger instance for logging.
Assigns a role to a user in the scope of a given tenant.
The role assignment details.
A promise that resolves with the assigned role.
PermitApiError If the API returns an error HTTP status code.
PermitContextError If the configured ApiContext does not match the required endpoint context.
Assigns multiple roles in bulk using the provided role assignments data. Each role assignment is a tuple of (user, role, tenant).
The role assignments to be performed in bulk.
A promise that resolves with the bulk assignment report.
PermitApiError If the API returns an error HTTP status code.
PermitContextError If the configured ApiContext does not match the required endpoint context.
Removes multiple role assignments in bulk using the provided unassignment data. Each role to unassign is a tuple of (user, role, tenant).
The role unassignments to be performed in bulk.
A promise that resolves with the bulk unassignment report.
PermitApiError If the API returns an error HTTP status code.
PermitContextError If the configured ApiContext does not match the required endpoint context.
Ensure that the API Key has the necessary permissions to successfully call the API endpoint. Note that this check is not foolproof, and the API may still throw 401.
The required API Key Access level for the endpoint.
PermitContextError If the currently set API key access level does not match the required access level.
Ensure that the API context matches the required endpoint context.
The required API context level for the endpoint.
PermitContextError If the currently set API context level does not match the required context level.
Retrieves a list of role assignments based on the specified filters.
The filters and pagination options for listing role assignments.
A promise that resolves with an array of role assignments.
PermitApiError If the API returns an error HTTP status code.
PermitContextError If the configured ApiContext does not match the required endpoint context.
Unassigns a role from a user in the scope of a given tenant.
The role unassignment details.
A promise that resolves when the role is successfully unassigned.
PermitApiError If the API returns an error HTTP status code.
PermitContextError If the configured ApiContext does not match the required endpoint context.
Wait for the facts to be synchronized with the PDP. Available only when proxyFactsViaPdp
is set to true
.
The maximum number of seconds to wait for the synchronization to complete. Set to null to wait indefinitely.
Generated using TypeDoc
The RoleAssignmentsApi class provides methods for interacting with Role Assignments.