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

# Create a custom role

> Creates a role with the permissions you choose. Use permissions that `GET /v2/teams/permissions` lists with `availableForRBAC: true`, at most one per resource type. Needs the `team.manage` permission.



## OpenAPI

````yaml /spec/platform-teams.yaml post /v2/teams/{teamID}/custom-role
openapi: 3.0.1
info:
  title: Teams & Access
  version: 1.0.0
  description: >
    Create teams, invite people, and control what each member can do.


    A team is a separate account that owns its own resources and billing.

    Members work on the team's resources with their own API token by adding

    `teamID` to their requests. Access comes from two places:


    - **Role permissions** apply across the whole team. Every member has
      exactly one role.
    - **Resource permissions** give one member access to one specific
      resource, such as a single app or database.

    A request is allowed if either source grants a required permission.


    Every team starts with these built-in roles:


    | Role | Permissions |

    |------|-------------|

    | مالک | `manage` and `create` on every resource type, plus `billing.manage`
    and `team.manage`. The team creator always has this role. |

    | مدیر | `manage` and `create` on every resource type |

    | گرداننده | `operate` on every resource type |

    | بازرس | `view` on every resource type |

    | حسابدار | `billing.manage` |

    | مهمان | No permissions |


    The number of members, custom roles and resource permissions per team,

    and the number of teams per user, are limited.
servers:
  - url: https://api.liara.ir
security:
  - bearerAuth: []
tags:
  - name: Teams
    description: Create, list, rename and delete teams.
  - name: Invitations
    description: Invite people to a team and accept invitations.
  - name: Members
    description: List members, remove them, change their role, or leave a team.
  - name: Roles
    description: List roles and manage custom roles.
  - name: Resource Permissions
    description: Give members access to specific resources.
paths:
  /v2/teams/{teamID}/custom-role:
    post:
      tags:
        - Roles
      summary: Create a custom role
      description: >-
        Creates a role with the permissions you choose. Use permissions that
        `GET /v2/teams/permissions` lists with `availableForRBAC: true`, at most
        one per resource type. Needs the `team.manage` permission.
      operationId: createCustomRole
      parameters:
        - $ref: '#/components/parameters/TeamIDPath'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - name
                - permissions
              properties:
                name:
                  type: string
                  minLength: 3
                  maxLength: 50
                  description: Role name. It's stored in lowercase.
                permissions:
                  type: array
                  minItems: 1
                  description: Each `type` can appear only once.
                  items:
                    $ref: '#/components/schemas/PermissionRef'
            example:
              name: deployer
              permissions:
                - type: project
                  name: deploy
                - type: database
                  name: view
      responses:
        '201':
          description: The role was created. The response body is empty.
        '400':
          description: >-
            The body or `teamID` is invalid (including unknown, unavailable or
            repeated permissions), or the team already has the maximum number of
            custom roles (`max_custom_roles_reached`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                statusCode: 400
                error: Bad Request
                message: Max custom roles reached
                data:
                  code: max_custom_roles_reached
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/TeamForbidden'
        '409':
          description: The team already has a role with this name.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                statusCode: 409
                error: Conflict
                message: Custom role already exists
                data:
                  code: custom_role_already_exists
components:
  parameters:
    TeamIDPath:
      name: teamID
      in: path
      required: true
      description: The team's ID.
      schema:
        $ref: '#/components/schemas/ObjectID'
      example: '000000000000000000000002'
  schemas:
    PermissionRef:
      type: object
      required:
        - type
        - name
      properties:
        type:
          $ref: '#/components/schemas/PermissionType'
        name:
          type: string
          description: >-
            Permission name, for example `view`, `deploy`, `operate` or
            `manage`.
    Error:
      type: object
      description: Standard error body.
      properties:
        statusCode:
          type: integer
        error:
          type: string
          description: HTTP status text.
        message:
          type: string
          description: What went wrong.
        data:
          type: object
          nullable: true
          description: >-
            Extra details. When present, `code` is a stable, machine-readable
            error code.
          properties:
            code:
              type: string
    ObjectID:
      type: string
      pattern: ^[0-9a-fA-F]{24}$
      description: 24-character hexadecimal ID.
    PermissionType:
      type: string
      description: The kind of resource or area a permission applies to.
      enum:
        - project
        - database
        - zone
        - bucket
        - mailServer
        - vm
        - ai
        - billing
        - team
    AuthError:
      type: object
      description: Error body returned when the API token is rejected.
      properties:
        error:
          type: string
  responses:
    Unauthorized:
      description: The API token is missing, invalid or expired.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/AuthError'
          example:
            error: Unauthorized.
    TeamForbidden:
      description: >-
        You aren't a member of this team (`team_not_found`), or your role
        doesn't have the required permission (`no_permission`).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          examples:
            teamNotFound:
              summary: Not a team member
              value:
                statusCode: 403
                error: Forbidden
                message: Team not found
                data:
                  code: team_not_found
            noPermission:
              summary: Missing permission
              value:
                statusCode: 403
                error: Forbidden
                message: You do not have permission to access this resource.
                data:
                  code: no_permission
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'Send your API token as `Authorization: Bearer <api-token>`.'

````

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