Rolemaps

Rolemaps are join objects that relate users to Workspaces, folders, or files. You can retrieve, update, delete, and list rolemaps. You create rolemaps via invitations. A rolemap grants a user access to an object via a role.

Retrieve a Rolemap

Retrieves the rolemap specified via [id].

Parameters

role_name string The effective role granted to the user.
available_roles array of strings The roles that a given Rolemap can be set to (including the current role) via an update action.
object_type string Available types are Account, Workspace, Folder and File. Account rolemaps are automatically granted to account-level users at their account role. Workspace, Folder and File rolemaps indicate access only to the object retrieved.

Return

Returns the rolemap object and a 200 if the call succeeds.

Update a Rolemap

Updates the rolemap specified via [id]. Endpoint context is assumed for all update actions. If you update an Account rolemap from the /workspaces endpoint, the API will automatically create a new Workspace rolemap on the specified Workspace, versus modifying that user’s account role.

Parameters

role_name string The effective role granted to the user.

Return

Returns an empty message body and a 200 if the call succeeds.

Delete a Rolemap

Deletes an individual rolemap specified via [id]. This revokes the user’s access to the rolemap’s object. Endpoint context is assumed for all delete actions. If you attempt to delete an Account rolemap from the /workspaces endpoint, the call will fail.

Return

Returns an empty message body and a 204 if the call succeeds. Returns a 422 error with an error in the message body if you attempt to delete an Account rolemap.

List all Rolemaps

Interacting with the rolemaps endpoint requires the ID for a specific rolemap. You can find the appropriate rolemap ID by appending /rolemap to the retrieve endpoint for a Workspace, folder, or file.

Parameters

role_name string The effective role granted to the user(s).
available_roles array of strings The roles that a given Rolemap can be set to (including the current role) via an update action.
object_type string Available types are Account, Workspace, Folder and File. Account rolemaps are automatically granted to account-level users at their account role. Workspace, Folder and File rolemaps indicate access only to the object retrieved.

Return

Returns a paged array of rolemap objects for the Workspace, folder, or file specified via [id] and a 200 if the call succeeds.