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

# Claim a role

> Claims a role on a session server for a user and returns the normalized claim.



## OpenAPI

````yaml post /sessions/v2/{sessionId}/servers/{serverId}/claims
openapi: 3.1.0
info:
  title: ReAdmin API
  version: 1.0.0
  description: ReAdmin developer api
  termsOfService: http://panel.readmin.app/legal/terms/
  contact:
    email: help@readmin.app
  x-fiddle-import-file: true
servers:
  - url: https://api.readmin.app
  - url: https://api.readmin.dev
    description: ReAdmin development API, only usable by ReAdmin developers.
security: []
tags:
  - name: Ranking Key
    description: Information about a key
  - name: Group Shout
    description: Update the group shout
  - name: Join Requests
    description: Get and manage join requests
  - name: Members
    description: Rank and exile members
  - name: Orders
    description: Operations related to orders management
  - name: Workspace
    description: Operations related to orders management
  - description: ''
    name: games
  - description: ''
    name: staff history
  - name: Activity
    description: Staff activity and minutes
  - name: Running Games
    description: Live tracked game servers
  - name: Time Off
    description: View and review time off requests
  - name: Teams
    description: Teams and team membership
  - name: Promotion Requests
    description: View promotion (nomination) requests
  - name: Calls
    description: In-game support calls and live chat
  - name: Sessions v2
    description: >-
      Modern, fully-normalized sessions API. Resources are flat and predictable,
      names are resolved, and lists are filterable and cursor-paginated.
externalDocs:
  description: ReAdmin docs
  url: http://docs.readmin.app
paths:
  /sessions/v2/{sessionId}/servers/{serverId}/claims:
    post:
      tags:
        - Sessions v2
      summary: Claim a role
      description: >-
        Claims a role on a session server for a user and returns the normalized
        claim.
      operationId: claimSessionRoleV2
      parameters:
        - name: sessionId
          in: path
          required: true
          description: The session id.
          schema:
            type: string
        - name: serverId
          in: path
          required: true
          description: The server id.
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/V2ClaimRoleRequest'
      responses:
        '201':
          description: Role claimed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2ClaimResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/ServerError'
      security:
        - loader-id: []
components:
  schemas:
    V2ClaimRoleRequest:
      type: object
      required:
        - userId
        - roleGroupId
        - roleId
      properties:
        userId:
          type: string
          description: Roblox user id claiming the role.
        roleGroupId:
          type: string
          description: Id of the role group (see GET /sessions/v2/roles).
        roleId:
          type: string
          description: Id of the subrole within the role group.
    V2ClaimResponse:
      type: object
      properties:
        success:
          type: boolean
          default: true
        data:
          $ref: '#/components/schemas/V2Claim'
    V2Claim:
      type: object
      properties:
        userId:
          type: string
        roleId:
          type: string
          nullable: true
          description: The claimed subrole id.
        roleName:
          type: string
          nullable: true
          description: Human-readable name of the claimed role.
        state:
          type: string
          enum:
            - none
            - current
            - completed
            - passed
            - failed
        claimedBy:
          type: string
        claimedAt:
          type: string
          format: date-time
        claimId:
          type: string
          nullable: true
  responses:
    BadRequest:
      description: Bad request, invalid parameters
      content:
        application/json:
          schema:
            type: object
            properties:
              success:
                type: boolean
                default: false
              reason:
                type: string
    NotFound:
      description: The specified resource was not found
      content:
        application/json:
          schema:
            type: object
            properties:
              success:
                type: boolean
                default: false
              reason:
                type: string
    ServerError:
      description: Internal server error
      content:
        application/json:
          schema:
            type: object
            properties:
              success:
                type: boolean
                default: false
              reason:
                type: string
  securitySchemes:
    loader-id:
      type: apiKey
      name: loader-id
      in: header

````