Stytch · Schema

api_b2b_rbac_v1_PolicyResource

AuthenticationIdentityPasswordlessSecurityB2BConnected AppsMCPAI AgentsDeveloper Tools

Properties

Name Type Description
resource_id string A unique identifier of the RBAC Resource, provided by the developer and intended to be human-readable. A `resource_id` is not allowed to start with `stytch`, which is a special prefix used for Stytch
description string The description of the RBAC Resource.
actions array A list of all possible actions for a provided Resource. Reserved `actions` that are predefined by Stytch include: * `*` * For the `stytch.organization` Resource: * `update.info.name` * `update.info.sl
View JSON Schema on GitHub

JSON Schema

stytch-api-b2b-rbac-v1-policyresource-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/api_b2b_rbac_v1_PolicyResource",
  "title": "api_b2b_rbac_v1_PolicyResource",
  "type": "object",
  "properties": {
    "resource_id": {
      "type": "string",
      "description": "A unique identifier of the RBAC Resource, provided by the developer and intended to be human-readable.\n\n  A `resource_id` is not allowed to start with `stytch`, which is a special prefix used for Stytch default Resources with reserved `resource_id`s. These include:\n\n  * `stytch.organization`\n  * `stytch.member`\n  * `stytch.sso`\n  * `stytch.self`\n\n  Check out the [guide on Stytch default Resources](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 Resource."
    },
    "actions": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "A list of all possible actions for a provided Resource.\n\n  Reserved `actions` that are predefined by Stytch include:\n\n  * `*`\n  * For the `stytch.organization` Resource:\n    * `update.info.name`\n    * `update.info.slug`\n    * `update.info.untrusted_metadata`\n    * `update.info.email_jit_provisioning`\n    * `update.info.logo_url`\n    * `update.info.email_invites`\n    * `update.info.allowed_domains`\n    * `update.info.default_sso_connection`\n    * `update.info.sso_jit_provisioning`\n    * `update.info.mfa_policy`\n    * `update.info.implicit_roles`\n    * `delete`\n  * For the `stytch.member` Resource:\n    * `create`\n    * `update.info.name`\n    * `update.info.untrusted_metadata`\n    * `update.info.mfa-phone`\n    * `update.info.delete.mfa-phone`\n    * `update.settings.is-breakglass`\n    * `update.settings.mfa_enrolled`\n    * `update.settings.roles`\n    * `search`\n    * `delete`\n  * For the `stytch.sso` Resource:\n    * `create`\n    * `update`\n    * `delete`\n  * For the `stytch.self` Resource:\n    * `update.info.name`\n    * `update.info.untrusted_metadata`\n    * `update.info.mfa-phone`\n    * `update.info.delete.mfa-phone`\n    * `update.info.delete.password`\n    * `update.settings.mfa_enrolled`\n    * `delete`\n  "
    }
  },
  "required": [
    "resource_id",
    "description",
    "actions"
  ]
}