Search
K
Cipherscale API

Resend User Invitation

Sends a new invitation email to a user with a pending invitation. This is useful when the original invitation email was not received, expired, or was accidentally deleted. Only users with pending invitation status can be reinvited.

post
https://public-api.cipherscale.com/qa/tenants/users/{id}/invite

Path Parameters

idstring(uuid)required

The unique identifier (UUID) of the user to reinvite

Response

Successfully sent invitation email to the user

post/tenants/users/{id}/invite
 

Get User Role Assignments

Retrieves all roles currently assigned to a specific user, including both direct role assignments and roles inherited through group memberships. This information is crucial for understanding user permissions and access levels.

get
https://public-api.cipherscale.com/qa/tenants/users/{id}/roles

Query Parameters

groupsOnlyboolean
rolesOnlyboolean

Path Parameters

idstringrequired

Response

200 application/json

User role definition with specific permissions and capabilities

idstring(uuid)required

Unique identifier for the role

createdAtstring(date-time)required

Timestamp when the role was created

updatedAtstring(date-time)required

Timestamp when the role was last modified

namestringrequired

Human-readable name of the role

descriptionstring

Detailed description of the role’s purpose and permissions

deleteablebooleanrequired

Whether this role can be deleted (system roles are typically not deletable)

typestringrequired

Predefined role type that determines the base permissions

Allowed values:OWNERADMINDEFAULTBASICBILLINGAUDITORSUPPORT

get/tenants/users/{id}/roles
 
200 application/json

Modify User Role Assignments

Adds or removes roles from a user’s account. This operation allows administrators to dynamically adjust user permissions by modifying their role assignments. Changes take effect immediately and affect the user’s access to system resources.

patch
https://public-api.cipherscale.com/qa/tenants/users/{id}/roles

Path Parameters

idstringrequired

Body

application/json

UpdateUserRoles

Data for adding or removing roles from a user

addedRolesarray[string]required

Array of role IDs to add to the user

Example:["550e8400-e29b-41d4-a716-446655440000"]

removedRolesarray[string]required

Array of role IDs to remove from the user

Example:["550e8400-e29b-41d4-a716-446655440001"]

Response

200
patch/tenants/users/{id}/roles

Body

{ "addedRoles": [ "550e8400-e29b-41d4-a716-446655440000" ], "removedRoles": [ "550e8400-e29b-41d4-a716-446655440001" ] }
 
200

Add User to Group

Associates a user with a specific group, which may grant them additional roles and permissions based on the group’s configuration. Group membership can affect access policies and resource availability.

post
https://public-api.cipherscale.com/qa/tenants/users/{id}/groups

Path Parameters

idstringrequired

Response

201
post/tenants/users/{id}/groups
 
201

Remove User from Group

Disassociates a user from a specific group, which may revoke roles and permissions that were granted through group membership. This operation helps maintain proper access control and organizational structure.

delete
https://public-api.cipherscale.com/qa/tenants/users/{id}/groups/{groupId}

Path Parameters

idstringrequired
groupIdstringrequired

Response

204
delete/tenants/users/{id}/groups/{groupId}
 
204