/
Contact usSee pricingStart building
    Introduction
    Overview
    Postman
    Users
      Create user
      Search users
      Get user
      Update user
      Exchange primary factor

    • Delete

        • Delete user
        Delete user email
        Delete user phone number
        Delete user WebAuthn registration
        Delete user biometric registration
        Delete user TOTP
        Delete user crypto wallet
        Delete user password
        Delete user OAuth registration
    Magic links

    • Via email

        • Send magic link
        Log in or create user
        Invite
        Revoke pending invite

    • Embeddable

        • Create
      Authenticate
    OAuth
      Attach
      Authenticate

    • Start

        • Google
        Amazon
        Apple
        Bitbucket
        Coinbase
        Discord
        Facebook
        Figma
        GitHub
        GitLab
        Linkedin
        Microsoft
        Salesforce
        Slack
        Snapchat
        TikTok
        Twitch
        Twitter
        Yahoo
    Passwords
      Create
      Authenticate
      Strength check
      Migrate

    • Reset options

        • Password reset by email start
        Password reset by email
        Password reset by existing password
        Password reset by session
    One-time passcodes (OTP)

    • Via SMS

        • Send
        Login or create user

    • Via Whatsapp

        • Send
        Login or create user

    • Via email

        • Send
        Login or create user
      Authenticate
    Session management
      Session object
      Get JWKS
      Get sessions
      Authenticate Session
      Revoke session
      Migrate session
      Attest Session
      Exchange Access Token
    Passkeys & WebAuthn

    • Register

        • Start
        Register

    • Authenticate

        • Start
        Authenticate
      Update
      List WebAuthn Credentials
    Time-based one-time passcodes (TOTP)
      Create
      Authenticate
      Get recovery codes
      Recover
    Crypto wallets
      Authenticate start
      Authenticate
    M2M Authentication
      M2M Client Object

    • Token

        • Get Access Token
        Authenticate Access Token

    • M2M Client

        • Create M2M client
        Get M2M client
        Search M2M clients
        Update M2M client
        Delete M2M client

    • Rotate secret

        • Start secret rotation
        Rotate secret
        Cancel secret rotation
    Connected Apps
      Exchange Authorization Code
      Exchange Refresh Token

    • Tokens

        • Connected App ID Token Object
        Connected App Access Token Object

    • Configuration

        • Get JWKS
        Get OpenID Configuration

    • Methods

        • Introspect Token
        Authenticate Access Token (Local)
        Revoke Token
        Get UserInfo

    • Consent Management

        • Start OAuth Authorization
        Submit OAuth Authorization
        Get Authorized Connected Apps for a User
        Revoke Connected App Access to a User

    • Application Management

        • Dynamic Client Registration
        Create Connected App
        Get Connected App
        Search Connected Apps
        Update Connected App
        Delete Connected App

    • Rotate secret

        • Start secret rotation
        Rotate secret
        Cancel secret rotation
    RBAC
      Resource object
      Role object
      Scope object
      Get RBAC Policy
    User Impersonation
      Authenticate Token
    Resources
      Email templates
      URL validation
      Metadata
      User states
    Errors
      Overview
      Error object
      400
      401
      403
      404
      405
      429
      499
      500
      503
Get support on SlackVisit our developer forum

Contact us

Consumer Authentication

/

API reference

/

RBAC

/

Role object

Role object

A Role is a named collection of permissions that links actions to a Resource. Roles are assigned to Users by direct assignment, which grants them permissions.

Role assignment can be programmatically managed through certain Stytch API endpoints. Refer to this guide for details on controls for delegating Roles to Users.

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.

Fields

role_id string

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

The stytch_user role_id is predefined by Stytch. Check out the RBAC guide for a more detailed explanation.

description string

The description of the RBAC Role.

permissions array[objects]

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

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 default Resources with reserved resource_ids.

actions array[strings]

A list of permitted actions the Role is authorized to take with the provided Resource. You can use * as a wildcard to grant a Role permission to use all possible actions related to the Resource.

OBJECT 200
{
  "roles": [
    {
      "description": "",
      "permissions": [
        {
          "actions": [
            "read",
            "write"
          ],
          "resource_id": "documents"
        },
        {
          "actions": [
            "read",
            "export",
            "share"
          ],
          "resource_id": "images"
        }
      ],
      "role_id": "editor"
    },
    {
      "description": "",
      "permissions": [
        {
          "actions": [
            "read"
          ],
          "resource_id": "documents"
        },
        {
          "actions": [
            "read"
          ],
          "resource_id": "images"
        }
      ],
      "role_id": "reader"
    }
  ]
}