Role Object - Stytch Docs

{
  "role_id": "<string>",
  "description": "<string>",
  "permissions": [
    {
      "resource_id": "<string>",
      "actions": [
        "<string>"
      ]
    }
  ]
}

A Role is a named collection of permissions that links actions to a Resource. Roles are assigned to Members, either explicitly by direct assignment or implicitly by matching attributes or conditions, which grants them permissions. Role assignment can be programmatically managed through certain Stytch API endpoints. All Roles are stored in your Project’s RBAC Policy. You can create, manage, and assign Roles in the RBAC Policies page of the Stytch Dashboard. Check out the RBAC overview to learn more about Stytch’s RBAC permissioning model.

role_id

string

required

The unique identifier of the RBAC Role, provided by the developer and intended to be human-readable.

Reserved role_ids that are predefined by Stytch include:

stytch_member
stytch_admin

Check out the guide on Stytch default Roles for a more detailed explanation.

description

string

required

The description of the RBAC Role.

permissions

object[]

required

A list of permissions that link a Resource to a list of actions.

Show child attributes

⌘I