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

# Options

> The `/user` resource supports two custom `OPTIONS` requests, one for the resource as such
and one for individual user instances. The `OPTIONS` request allows checking for the set of
available operations that the currently authenticated user can perform on the /user resource.
If the user can perform an operation or not may depend on various things, including the user's
authorizations to interact with this resource and the internal configuration of the process
engine. `OPTIONS /user/{id}` returns available interactions on a resource instance.



## OpenAPI

````yaml /reference/rest/openapi-1.0.json options /user/{id}
openapi: 3.0.2
info:
  title: ASEE Flow Platform REST API
  description: OpenApi Spec for ASEE Flow Platform REST API.
  version: 1.0.0
  license:
    name: Apache License 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
servers:
  - url: http://{host}:{port}/{contextPath}
    description: The API server for the default process engine
    variables:
      host:
        default: localhost
      port:
        default: '8080'
      contextPath:
        default: engine-rest
  - url: http://{host}:{port}/{contextPath}/engine/{engineName}
    description: The API server for a named process engine
    variables:
      host:
        default: localhost
      port:
        default: '8080'
      contextPath:
        default: engine-rest
      engineName:
        default: default
  - url: '{url}'
    description: The API server with a custom url
    variables:
      url:
        default: ''
security:
  - basicAuth: []
tags:
  - name: Authorization
  - name: Batch
  - name: Condition
  - name: Decision Definition
  - name: Decision Requirements Definition
  - name: Deployment
  - name: Engine
  - name: Event Subscription
  - name: Execution
  - name: External Task
  - name: Filter
  - name: Group
  - name: Historic Activity Instance
  - name: Historic Batch
  - name: Historic Decision Definition
  - name: Historic Decision Instance
  - name: Historic Decision Requirements Definition
  - name: Historic Detail
  - name: Historic External Task Log
  - name: Historic Identity Link Log
  - name: Historic Incident
  - name: Historic Job Log
  - name: Historic Process Definition
  - name: Historic Process Instance
  - name: Historic Task Instance
  - name: Historic User Operation Log
  - name: Historic Variable Instance
  - name: History Cleanup
  - name: Identity
  - name: Incident
  - name: Job
  - name: Job Definition
  - name: Message
  - name: Metrics
  - name: Migration
  - name: Modification
  - name: Process Definition
  - name: Process Instance
  - name: Signal
  - name: Schema Log
  - name: Task
  - name: Task Attachment
  - name: Task Comment
  - name: Task Identity Link
  - name: Task Local Variable
  - name: Task Variable
  - name: Telemetry
  - name: Tenant
  - name: User
  - name: Variable Instance
  - name: Version
externalDocs:
  description: Find out more about ASEE Flow Rest API
  url: https://docs.aseeflow.org/reference/rest/overview/
paths:
  /user/{id}:
    options:
      tags:
        - User
      summary: Options
      description: >-
        The `/user` resource supports two custom `OPTIONS` requests, one for the
        resource as such

        and one for individual user instances. The `OPTIONS` request allows
        checking for the set of

        available operations that the currently authenticated user can perform
        on the /user resource.

        If the user can perform an operation or not may depend on various
        things, including the user's

        authorizations to interact with this resource and the internal
        configuration of the process

        engine. `OPTIONS /user/{id}` returns available interactions on a
        resource instance.
      operationId: availableUserOperations
      parameters:
        - name: id
          in: path
          schema:
            type: string
          required: true
          description: The id of the user to be deleted.
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceOptionsDto'
              examples:
                example-1:
                  summary: GET `/user/peter`
                  value:
                    links:
                      - method: GET
                        href: http://localhost:8080/engine-rest/user/peter/profile
                        rel: self
                      - method: DELETE
                        href: http://localhost:8080/engine-rest/user/peter
                        rel: delete
                      - method: PUT
                        href: http://localhost:8080/engine-rest/user/peter/profile
                        rel: update
          description: Request successful.
components:
  schemas:
    ResourceOptionsDto:
      allOf:
        - type: object
          properties: {}
        - $ref: '#/components/schemas/LinkableDto'
    LinkableDto:
      type: object
      properties:
        links:
          type: array
          nullable: true
          items:
            $ref: '#/components/schemas/AtomLink'
          description: >-
            The links associated to this resource, with `method`, `href` and
            `rel`.
    AtomLink:
      type: object
      properties:
        rel:
          type: string
          nullable: true
          description: The relation of the link to the object that belongs to.
        href:
          type: string
          nullable: true
          description: The url of the link.
        method:
          type: string
          nullable: true
          description: The http method.
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic

````