Skip to main content

Role

A role is a set of abilities members have within an organisation. Roles allow permissions to be granted to members of an organisation. Adding a role to a member will grant the member the permissions of that role.

Role Object

FieldTypeDescription
idsnowflakethe role's id
organisation_idsnowflakethe role's organisation id
namestringthe role's name (2-20 characters)
descriptionstringa description of the role

Get Role

GET /roles/{role.id}

Update Role

PATCH /roles/{role.id}

Delete Role

DELETE /roles/{role.id}