Stytch · Schema

api_b2b_rbac_v1_PolicyRole

AuthenticationIdentityPasswordlessSecurityB2BConnected AppsMCPAI AgentsDeveloper Tools

Properties

Name	Type	Description
role_id	string	The unique identifier of the RBAC Role, provided by the developer and intended to be human-readable. Reserved `role_id`s that are predefined by Stytch include: * `stytch_member` * `stytch_admin` Check
description	string	The description of the RBAC Role.
permissions	array	A list of permissions that link a [Resource](https://stytch.com/docs/b2b/api/rbac-resource-object) to a list of actions.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/api_b2b_rbac_v1_PolicyRole",
  "title": "api_b2b_rbac_v1_PolicyRole",
  "type": "object",
  "properties": {
    "role_id": {
      "type": "string",
      "description": "The unique identifier of the RBAC Role, provided by the developer and intended to be human-readable.\n\n  Reserved `role_id`s that are predefined by Stytch include:\n\n  * `stytch_member`\n  * `stytch_admin`\n\n  Check out the [guide on Stytch default Roles](https://stytch.com/docs/b2b/guides/rbac/stytch-default) for a more detailed explanation.\n\n  "
    },
    "description": {
      "type": "string",
      "description": "The description of the RBAC Role."
    },
    "permissions": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/api_b2b_rbac_v1_PolicyRolePermission"
      },
      "description": "A list of permissions that link a [Resource](https://stytch.com/docs/b2b/api/rbac-resource-object) to a list of actions."
    }
  },
  "required": [
    "role_id",
    "description",
    "permissions"
  ]
}