Siemens PLM

Siemens PLM Administration API

The Administration API from Siemens PLM — 2 operation(s) for administration.

GitHub OpenAPI

Operations 3

GET /api/v1/administration/users/{userName} Fetch a user User by {userName}. Only allowed for admins. #
PATCH /api/v1/administration/users/{userName} Activates or deactivate a user #
GET /api/v1/administration/application-version Gets the current version of TcPCM. Available since version 2412 #

Documentation

📖
Documentation
https://developer.siemens.com/tcpcm/overview.html
📖
GettingStarted
https://developer.siemens.com/tcpcm/getting-started.html
📖
Authentication
https://developer.siemens.com/tcpcm/getting-started.html
📖
Documentation
https://developer.siemens.com/polarion/rest-api-spec.html
📖
Authentication
https://developer.siemens.com/polarion/authentication.html
📖
Documentation
https://developer.siemens.com/product-information-api/rest-api-spec.html

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/siemens-plm/refs/heads/main/openapi/siemens-plm-administration-api-openapi.yml

Other Resources

🔗
ChangeLog
https://developer.siemens.com/product-information-api/changelog.html

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/siemens-plm-administration-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

siemens-plm-administration-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: v1.5
  title: TcPCM Gateway Administration API
  description: TcPCM Gateway API
  license:
    name: Privacy Policy
    url: https://www.plm.automation.siemens.com/global/en/legal/privacy-policy.html
tags:
- name: Administration
paths:
  /api/v1/administration/users/{userName}:
    get:
      tags:
      - Administration
      summary: Fetch a user User by {userName}. Only allowed for admins.
      operationId: GetUser_GetUser
      security:
      - bearerHttpAuthentication: []
      parameters:
      - name: userName
        in: path
        description: User name
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Response_of_UserResponseModel'
            text/json:
              schema:
                $ref: '#/components/schemas/Response_of_UserResponseModel'
            application/xml:
              schema:
                $ref: '#/components/schemas/Response_of_UserResponseModel'
            text/xml:
              schema:
                $ref: '#/components/schemas/Response_of_UserResponseModel'
        '401':
          description: Unauthorized
        '404':
          description: NotFound
      deprecated: false
      description: ''
    patch:
      tags:
      - Administration
      summary: Activates or deactivate a user
      operationId: ToggleUserActivation_ToggleActivation
      security:
      - bearerHttpAuthentication: []
      parameters:
      - name: userName
        in: path
        description: User name
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ToggleActivationRequestModel'
          text/json:
            schema:
              $ref: '#/components/schemas/ToggleActivationRequestModel'
          application/xml:
            schema:
              $ref: '#/components/schemas/ToggleActivationRequestModel'
          text/xml:
            schema:
              $ref: '#/components/schemas/ToggleActivationRequestModel'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/ToggleActivationRequestModel'
        description: The request represents that {userName} will be either activated or deactivated.
        required: true
      responses:
        '204':
          description: NoContent
        '400':
          description: BadRequest
          content:
            application/json:
              schema:
                type: object
                properties:
                  Errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ErrorLegacy'
                readOnly: true
            text/json:
              schema:
                type: object
                properties:
                  Errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ErrorLegacy'
                readOnly: true
            application/xml:
              schema:
                type: object
                properties:
                  Errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ErrorLegacy'
                readOnly: true
            text/xml:
              schema:
                type: object
                properties:
                  Errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ErrorLegacy'
                readOnly: true
        '401':
          description: Unauthorized
        '404':
          description: NotFound
        '500':
          description: InternalServerError
      deprecated: false
  /api/v1/administration/application-version:
    get:
      tags:
      - Administration
      summary: Gets the current version of TcPCM. Available since version 2412
      description: Gets the current version of TcPCM
      operationId: Administration_GetApplicationVersion
      parameters: []
      responses:
        '200':
          description: Success. Returns the current running version of TcPCM
          headers: {}
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      version:
                        type: string
                        description: TcPCM version
                    required:
                    - version
                description: 'data

                  '
                required:
                - data
              example:
                data:
                  version: '2406.0001'
        '400':
          $ref: '#/components/responses/ErrorBadRequestLegacy'
        '401':
          $ref: '#/components/responses/ErrorUnauthorizedLegacy'
        '406':
          $ref: '#/components/responses/ErrorNotAcceptableLegacy'
        '500':
          $ref: '#/components/responses/ErrorInternalServerErrorLegacy'
      security:
      - bearerHttpAuthentication: []
components:
  schemas:
    UserResponseModelAttributes:
      type: object
      properties:
        userName:
          type: string
          readOnly: true
        emailAddress:
          type: string
          readOnly: true
        firstName:
          type: string
          readOnly: true
        lastName:
          type: string
          readOnly: true
        active:
          type: boolean
          readOnly: true
        roleAssignments:
          type: array
          items:
            $ref: '#/components/schemas/RoleAssignmentResponseModel'
          readOnly: true
    ToggleActivationRequestModel:
      required:
      - active
      type: object
      properties:
        active:
          type: boolean
          example: false
    UserResponseModel:
      type: object
      properties:
        type:
          type: string
          readOnly: true
        attributes:
          $ref: '#/components/schemas/UserResponseModelAttributes'
    RoleAssignmentResponseModel:
      type: object
      properties:
        client:
          type: string
          readOnly: true
        role:
          type: string
          readOnly: true
    Response_of_UserResponseModel:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/UserResponseModel'
    ErrorLegacy:
      type: object
      properties:
        Detail:
          type: string
          readOnly: true
  responses:
    ErrorNotAcceptableLegacy:
      description: The service is not able to respond using the request media-type or representation asked by the client in the Accept header.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorLegacy'
          examples:
            Example:
              value:
                Detail: Media type not accepted
        application/xml:
          schema:
            $ref: '#/components/schemas/ErrorLegacy'
    ErrorInternalServerErrorLegacy:
      description: An unexpected error occurred and the server is not fulfilling the request.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorLegacy'
          examples:
            Example:
              value:
                Detail: Internal error
        application/xml:
          schema:
            $ref: '#/components/schemas/ErrorLegacy'
    ErrorUnauthorizedLegacy:
      description: The client is not providing valid authentication credentials for the target resource.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorLegacy'
          examples:
            Example:
              value:
                Detail: Invalid user or password
        application/xml:
          schema:
            $ref: '#/components/schemas/ErrorLegacy'
    ErrorBadRequestLegacy:
      description: The request could not be processed by the server because the request is perceived as client error (such as, malformed request syntax, invalid request message framing, or deceptive request routing).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorLegacy'
          examples:
            Example:
              value:
                Detail: Invalid JSON format
        application/xml:
          schema:
            $ref: '#/components/schemas/ErrorLegacy'
  securitySchemes:
    bearerHttpAuthentication:
      type: http
      scheme: bearer
      bearerFormat: JWT