> ## 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.

# Set Workspace Jurisdiction

> Place a whole workspace under a regime.

**Who may call it:** governance-officer or admin. A workspace API key is refused here: this is an act that belongs to a named person.



## OpenAPI

````yaml /api/openapi.json put /v1/workspace/jurisdiction
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/workspace/jurisdiction:
    put:
      tags:
        - Identity
      summary: Set Workspace Jurisdiction
      description: >-
        Place a whole workspace under a regime.


        **Who may call it:** governance-officer or admin. A workspace API key is
        refused here: this is an act that belongs to a named person.
      operationId: set_workspace_jurisdiction_v1_workspace_jurisdiction_put
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WorkspaceJurisdictionIn'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JurisdictionOut'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - bearerToken: []
components:
  schemas:
    WorkspaceJurisdictionIn:
      properties:
        market_profile_id:
          anyOf:
            - type: string
              maxLength: 32
            - type: 'null'
          title: Market Profile Id
      type: object
      title: WorkspaceJurisdictionIn
      description: Which built-in profile governs, or null to inherit from the level above.
    JurisdictionOut:
      properties:
        level:
          type: string
          title: Level
        market_profile_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Market Profile Id
        resolves_to:
          type: string
          title: Resolves To
        resolved_from:
          type: string
          title: Resolved From
      type: object
      required:
        - level
        - resolves_to
        - resolved_from
      title: JurisdictionOut
      description: Where the regime now comes from, and what it resolves to.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  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.