List Roles

curl --request GET \
  --url https://identity.sandbox.lerian.net/v1/roles \
  --header 'Authorization: Bearer <token>'

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://identity.sandbox.lerian.net/v1/roles"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://identity.sandbox.lerian.net/v1/roles', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "items": [
    {
      "createdAt": "2026-06-24T10:00:00Z",
      "description": "A custom editor role",
      "groups": [
        "<string>"
      ],
      "id": "custom-editor",
      "isEnabled": true,
      "isSystem": false,
      "name": "Custom Editor",
      "roles": [
        "<string>"
      ],
      "users": [
        "<string>"
      ]
    }
  ],
  "limit": 10,
  "page": 1,
  "total": 10
}

{
  "code": "<string>",
  "entityType": "<string>",
  "err": "<unknown>",
  "message": "<string>",
  "title": "<string>"
}

{
  "code": "<string>",
  "entityType": "<string>",
  "err": "<unknown>",
  "message": "<string>",
  "title": "<string>"
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "entityType": "<string>",
  "err": "<unknown>",
  "message": "<string>",
  "title": "<string>"
}

{
  "code": "<string>",
  "entityType": "<string>",
  "err": "<unknown>",
  "message": "<string>",
  "title": "<string>"
}

List Roles

Returns your organization’s roles, one page at a time.

A role is a named bundle of permissions. It is what you grant to a group (or, less commonly, straight to a person); the permissions inside it are what the holder may then do. Called whenever the role list is shown, and after any create or delete to refresh it.

The filters are relational, not text matching: userId narrows to the roles that user holds and groupId to the roles granted to that group, which is how you answer “what does this person have?” without walking every role. name is the substring match.

Read-only: nothing changes.

Failures:

400 IDE-0018 — limit is above the deployment’s maximum (100 by default).
400 IDE-0019 — page is below 1.
503 IDE-0066 — the identity provider is unavailable (unreachable, too slow to answer, or failing). Nothing about the request was wrong; retry it later.

GET

roles

List Roles

curl --request GET \
  --url https://identity.sandbox.lerian.net/v1/roles \
  --header 'Authorization: Bearer <token>'

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://identity.sandbox.lerian.net/v1/roles"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://identity.sandbox.lerian.net/v1/roles', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "items": [
    {
      "createdAt": "2026-06-24T10:00:00Z",
      "description": "A custom editor role",
      "groups": [
        "<string>"
      ],
      "id": "custom-editor",
      "isEnabled": true,
      "isSystem": false,
      "name": "Custom Editor",
      "roles": [
        "<string>"
      ],
      "users": [
        "<string>"
      ]
    }
  ],
  "limit": 10,
  "page": 1,
  "total": 10
}

{
  "code": "<string>",
  "entityType": "<string>",
  "err": "<unknown>",
  "message": "<string>",
  "title": "<string>"
}

{
  "code": "<string>",
  "entityType": "<string>",
  "err": "<unknown>",
  "message": "<string>",
  "title": "<string>"
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "entityType": "<string>",
  "err": "<unknown>",
  "message": "<string>",
  "title": "<string>"
}

{
  "code": "<string>",
  "entityType": "<string>",
  "err": "<unknown>",
  "message": "<string>",
  "title": "<string>"
}

Autorizações

Authorization

string

header

obrigatório

JWT bearer token issued by the identity provider.

Parâmetros de consulta

page

integer<int64>

padrão:1

Page number.

Exemplo:

1

limit

integer<int64>

padrão:10

Items per page.

Exemplo:

10

name

string

Filter by name (case-insensitive substring).

userId

string

Filter by user ID (relational listing): only roles the user holds.

groupId

string

Filter by group ID (relational listing): only roles granted to the group.

Resposta

items

object[]

The page of roles.

Show child attributes

limit

integer<int64>

The page size that was applied.

Exemplo:

10

page

integer<int64>

The 1-based page this response corresponds to.

Exemplo:

1

total

integer<int64>

Total number of roles, across all pages.

Exemplo:

10

Visão geral

Autenticação

Login único

Autorização

Informações do usuário

MFA de login

Passkey de login

Visão geral de identidade

Grupos

Aplicações

Parceiros

Usuários

MFA da conta

Passkey da conta

Provedores de identidade

Provedores de aplicações

Permissões

Funções

Políticas de segurança

Declarações de plugins

Tratamento de erros

List Roles

Autorizações

Parâmetros de consulta

Resposta