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

# Me

> The caller's identity, entitlements, and the regime they are operating under.

**Who may call it:** any role. A workspace API key is refused here: this is an act that belongs to a named person.



## OpenAPI

````yaml /api/openapi.json get /v1/me
openapi: 3.1.0
info:
  title: RotaGrant API
  version: 0.1.0
  description: >-
    The HTTP API of a RotaGrant deployment, made from the product's own route
    definitions at the commit named in `x-rotascale-source`. Nothing here is
    written by hand.


    There is no shared endpoint. RotaGrant runs in your environment, and your
    deployment serves its own copy of this description at `/api/docs`. That copy
    is the authority on what your version has and which features are switched
    on; this one is the reference for one commit of the main line. The version
    is 0.1.0: routes and shapes can still change.


    Every route says who may call it. Most need a bearer token from the identity
    provider your deployment uses, held by a person with the role named. The
    routes an SDK calls also accept a workspace API key. A few are open, and say
    why.
servers:
  - url: https://{deployment}
    description: Your own deployment. There is no shared endpoint.
    variables:
      deployment:
        default: rotagrant.internal.example
        description: The host your deployment answers on.
security: []
paths:
  /v1/me:
    get:
      tags:
        - Identity
      summary: Me
      description: >-
        The caller's identity, entitlements, and the regime they are operating
        under.


        **Who may call it:** any role. A workspace API key is refused here: this
        is an act that belongs to a named person.
      operationId: me_v1_me_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MeOut'
      security:
        - bearerToken: []
components:
  schemas:
    MeOut:
      properties:
        identity:
          $ref: '#/components/schemas/IdentityOut'
        roles:
          items:
            $ref: '#/components/schemas/RoleOut'
          type: array
          title: Roles
        teams:
          items:
            type: string
          type: array
          title: Teams
        workspace:
          anyOf:
            - $ref: '#/components/schemas/WorkspaceOut'
            - type: 'null'
        market_profile:
          additionalProperties: true
          type: object
          title: Market Profile
        memberships:
          items:
            $ref: '#/components/schemas/MembershipOut'
          type: array
          title: Memberships
      type: object
      required:
        - identity
        - roles
        - teams
        - market_profile
        - memberships
      title: MeOut
      description: Who the caller is, and what that permits here.
    IdentityOut:
      properties:
        subject:
          type: string
          title: Subject
        email:
          anyOf:
            - type: string
            - type: 'null'
          title: Email
        kind:
          type: string
          title: Kind
        identity_source:
          type: string
          title: Identity Source
        authenticated:
          type: boolean
          title: Authenticated
      type: object
      required:
        - subject
        - kind
        - identity_source
        - authenticated
      title: IdentityOut
    RoleOut:
      properties:
        role:
          type: string
          title: Role
        label:
          type: string
          title: Label
        permits:
          type: string
          title: Permits
        recognised:
          type: boolean
          title: Recognised
      type: object
      required:
        - role
        - label
        - permits
        - recognised
      title: RoleOut
    WorkspaceOut:
      properties:
        id:
          type: string
          title: Id
        slug:
          type: string
          title: Slug
        name:
          type: string
          title: Name
        status:
          type: string
          title: Status
        expires_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Expires At
        organization:
          anyOf:
            - $ref: '#/components/schemas/OrganizationOut'
            - type: 'null'
      type: object
      required:
        - id
        - slug
        - name
        - status
      title: WorkspaceOut
    MembershipOut:
      properties:
        workspace_id:
          type: string
          title: Workspace Id
        workspace_slug:
          type: string
          title: Workspace Slug
        workspace_name:
          type: string
          title: Workspace Name
        roles:
          items:
            type: string
          type: array
          title: Roles
        current:
          type: boolean
          title: Current
          default: false
      type: object
      required:
        - workspace_id
        - workspace_slug
        - workspace_name
        - roles
      title: MembershipOut
    OrganizationOut:
      properties:
        id:
          type: string
          title: Id
        name:
          type: string
          title: Name
        slug:
          type: string
          title: Slug
      type: object
      required:
        - id
        - name
        - slug
      title: OrganizationOut
  securitySchemes:
    bearerToken:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        A token from the identity provider your deployment federates with. It
        identifies a person; their roles in the workspace decide what they may
        do.

````

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