Skip to main content Link Menu Expand (external link) Document Search Copy Copied
Auth0 CLI

auth0 roles list

List your existing roles. To create one, run: auth0 roles create.

Use ‘–schema’ to see available query parameters. Use ‘–query’ to filter results via a JSON object (any API-supported parameter works immediately).

Usage 

auth0 roles list [flags]

Examples 

  auth0 roles list
  auth0 roles ls
  auth0 roles ls --number 100
  auth0 roles ls -n 100 --json
  auth0 roles ls -n 100 --json-compact
  auth0 roles ls --csv
  auth0 roles list --schema
  auth0 roles list --schema --json
  auth0 roles list --query '{"name_filter":"admin"}'
  auth0 roles list --query '{"name_filter":"admin"}' --json

Flags 

      --csv            Output in csv format.
      --json           Output in json format.
      --json-compact   Output in compact json format.
  -n, --number int     Number of roles to retrieve. Minimum 1, maximum 1000. (default 100)
  -q, --query string   Filter results with a JSON object of query parameters. Any API-supported parameter works immediately. Run '--schema' to see documented parameters. On offset-paginated endpoints, add "include_totals":true to receive total counts and a pagination hint (without it the API returns a bare array and no hint can be given).
      --schema         Print the request payload schema for this command and exit. Use with --json or --json-compact for machine-readable output.

Inherited Flags 

      --agent-mode      Output JSON, disable prompts and colors. Auto-enabled for AI agents; set AUTH0_AGENT_MODE=false to disable.
      --debug           Enable debug mode.
      --no-color        Disable colors.
      --no-input        Disable interactivity.
      --tenant string   Specific tenant to use.