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

# See what you may use in the registry

> Whether you are limited (and by what), the items given to you or your
roles, and the service identities you may run schedules as.



## OpenAPI

````yaml get /api/registry/access/me
openapi: 3.1.0
info:
  title: Nx1 AI API
  description: |

    AI API for Nx1 Data Platform Management and Automated Data Tasks.

    Authentication is required via PSK in Authorization header.

    Default PSK is | [ask a friend] |
  version: 0.10.2
servers: []
security: []
paths:
  /api/registry/access/me:
    get:
      tags:
        - Registry
      summary: See what you may use in the registry
      description: |-
        Whether you are limited (and by what), the items given to you or your
        roles, and the service identities you may run schedules as.
      operationId: my_registry_access_api_registry_access_me_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MyAccessResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Conflict
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Unprocessable Content
      security:
        - OAuth2AuthorizationCodeBearer: []
        - APIKeyHeader: []
components:
  schemas:
    MyAccessResponse:
      properties:
        is_admin:
          type: boolean
          title: Is Admin
          description: Registry admins are never limited.
        limited:
          type: boolean
          title: Limited
          description: >-
            False: everything Global is open to you. True: only the items
            listed.
        limited_by:
          items:
            $ref: '#/components/schemas/PrincipalRef'
          type: array
          title: Limited By
          description: You by name, or your roles that are limited.
        items:
          items:
            $ref: '#/components/schemas/MyItem'
          type: array
          title: Items
          description: Items given to you or your roles (what you have, when limited).
        identities:
          items:
            $ref: '#/components/schemas/MyIdentity'
          type: array
          title: Identities
      type: object
      required:
        - is_admin
        - limited
      title: MyAccessResponse
      description: What the caller may see and use in the registry.
    ErrorResponse:
      properties:
        error:
          type: string
          title: Error
          description: A brief description of the error that occurred.
        code:
          type: integer
          title: Code
          description: The HTTP status code associated with the error.
          default: 500
      type: object
      required:
        - error
      title: ErrorResponse
    PrincipalRef:
      properties:
        kind:
          type: string
          enum:
            - user
            - role
            - identity
          title: Kind
        name:
          type: string
          title: Name
      type: object
      required:
        - kind
        - name
      title: PrincipalRef
      description: A user, role or service identity, by name (an identity by its slug).
    MyItem:
      properties:
        artifact_id:
          type: string
          format: uuid
          title: Artifact Id
        kind:
          $ref: '#/components/schemas/ArtifactKind'
        name:
          type: string
          title: Name
        display_name:
          type: string
          title: Display Name
        level:
          type: string
          enum:
            - view
            - use
          title: Level
        via:
          items:
            $ref: '#/components/schemas/PrincipalRef'
          type: array
          title: Via
          description: You by name, or the roles it is given to.
      type: object
      required:
        - artifact_id
        - kind
        - name
        - display_name
        - level
      title: MyItem
      description: An item given to you, and through whom.
    MyIdentity:
      properties:
        slug:
          type: string
          title: Slug
        description:
          type: string
          title: Description
          default: ''
        limited:
          type: boolean
          title: Limited
        items:
          type: integer
          title: Items
          default: 0
      type: object
      required:
        - slug
        - limited
      title: MyIdentity
      description: A service identity you may run schedules as.
    ArtifactKind:
      type: string
      enum:
        - agent
        - skill
        - mcp_server
        - tool
        - context_pack
        - ontology
        - prompt
        - workflow
        - brand
        - code_repo
      title: ArtifactKind
      description: What an artifact is.
  securitySchemes:
    OAuth2AuthorizationCodeBearer:
      type: oauth2
      flows:
        authorizationCode:
          scopes: {}
          authorizationUrl: >-
            https://sso-rapid.rapid.nx1cloud.com/realms/rapid/protocol/openid-connect/auth
          tokenUrl: >-
            https://sso-rapid.rapid.nx1cloud.com/realms/rapid/protocol/openid-connect/token
    APIKeyHeader:
      type: apiKey
      in: header
      name: Authorization-PSK

````

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