> ## Documentation Index
> Fetch the complete documentation index at: https://docs.lerian.studio/llms.txt
> Use this file to discover all available pages before exploring further.

# Create a Role

> Creates a role. `name` is the identifier you will address it by everywhere else — it is NOT a generated UUID and cannot be changed afterwards.

A new role grants nothing until you put permissions in it (`POST /v1/roles/{id}/permissions`) and give it to someone (`POST /v1/roles/{id}/groups` or `POST /v1/roles/{id}/users`). Prefer granting to a GROUP.

Failures:
- `400` — a required member is missing or malformed.
- `409` — a role with that `name` already exists in your organization.
- `422 IDE-1062` — `description` starts with `ri-declared:`, which is reserved for the roles Lerian services declare.
- `503 IDE-0066` — the identity provider is unavailable (unreachable, too slow to answer, or failing). Nothing about the request was wrong; retry it later.



## OpenAPI

````yaml /en/openapi/v3-current/AM-identity.yaml post /v1/roles
openapi: 3.1.0
info:
  contact:
    name: Lerian Studio
    url: https://lerian.studio
  description: OpenAPI 3.1 surface for the Access Manager identity component.
  license:
    name: Lerian Studio General License
  title: Plugin Access Manager — Identity API
  version: v1
servers:
  - url: https://identity.sandbox.lerian.net
security: []
tags:
  - description: >-
      M2M-only: each plugin declares its own permissions, roles and M2M
      contract, and the server reconciles them.
    name: Declarations
  - description: >-
      A tenant administrator's customers. Each partner holds what its
      credentials may DO (permissions, per product) and WHERE they may do it
      (scope, per product and dimension); an M2M application attached to one is
      confined to that intersection. Administrator-only: authorized on the
      "partners" resource, and every route resolves the owning organization from
      the caller's token.
    name: Partners
paths:
  /v1/roles:
    post:
      tags:
        - Roles
      summary: Create a Role
      description: >-
        Creates a role. `name` is the identifier you will address it by
        everywhere else — it is NOT a generated UUID and cannot be changed
        afterwards.


        A new role grants nothing until you put permissions in it (`POST
        /v1/roles/{id}/permissions`) and give it to someone (`POST
        /v1/roles/{id}/groups` or `POST /v1/roles/{id}/users`). Prefer granting
        to a GROUP.


        Failures:

        - `400` — a required member is missing or malformed.

        - `409` — a role with that `name` already exists in your organization.

        - `422 IDE-1062` — `description` starts with `ri-declared:`, which is
        reserved for the roles Lerian services declare.

        - `503 IDE-0066` — the identity provider is unavailable (unreachable,
        too slow to answer, or failing). Nothing about the request was wrong;
        retry it later.
      operationId: createRole
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RoleInput'
              description: The role to create.
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RoleResponse'
          description: Created
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPError'
          description: Bad Request
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPError'
          description: Conflict
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPError'
          description: Unprocessable Entity
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPError'
          description: Internal Server Error
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPError'
          description: Service Unavailable
      security:
        - BearerAuth: []
components:
  schemas:
    RoleInput:
      additionalProperties: false
      properties:
        description:
          examples:
            - A custom editor role
          type: string
        displayName:
          examples:
            - Custom Editor
          type: string
        name:
          examples:
            - custom-editor
          type: string
      required:
        - name
        - displayName
      type: object
    RoleResponse:
      additionalProperties: false
      properties:
        createdAt:
          examples:
            - '2026-06-24T10:00:00Z'
          type: string
        description:
          examples:
            - A custom editor role
          type: string
        groups:
          items:
            type: string
          type: array
        id:
          examples:
            - custom-editor
          type: string
        isEnabled:
          examples:
            - true
          type: boolean
        isSystem:
          examples:
            - false
          type: boolean
        name:
          examples:
            - Custom Editor
          type: string
        roles:
          items:
            type: string
          type: array
        users:
          items:
            type: string
          type: array
      type: object
    HTTPError:
      additionalProperties: false
      properties:
        code:
          type: string
        entityType:
          type: string
        err: {}
        message:
          type: string
        title:
          type: string
      type: object
  securitySchemes:
    BearerAuth:
      bearerFormat: JWT
      description: JWT bearer token issued by the identity provider.
      scheme: bearer
      type: http

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.