Cisco Crosswork Password API

The password API from Cisco Crosswork — 1 operation(s) for password.

OpenAPI Specification

cisco-crosswork-password-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Crosswork Management Password API
  contact:
    name: Crosswork Team, Cisco
    email: support@cisco.com
  license:
    name: Cisco Software License Agreement
    url: http://www.cisco.com/public/sw-license-agreement.html
  version: 1.0.0
  description: Crosswork Password Management APIs are used to manage passwords for user accounts created on the local authentication store. Currently only supports the password change operation.
  x-provenance:
    method: harvested
    authored_by: Cisco Crosswork
    harvested_by: API Evangelist
    harvested_on: '2026-08-19'
    first_party: true
    note: Published by Cisco. Retrieved unmodified except for this x-provenance block.
    provider_published: true
  x-evidence:
  - type: source
    url: https://github.com/CiscoDevNet/crosswork-openapi-spec/blob/master/NCAHI/3.1APIs/password.swagger.json
  - type: raw
    url: https://raw.githubusercontent.com/CiscoDevNet/crosswork-openapi-spec/master/NCAHI/3.1APIs/password.swagger.json
servers:
- url: /crosswork/password
security:
- bearerAuth: []
tags:
- name: password
paths:
  /v1:
    put:
      summary: Change the password for a user account on local authentication store.
      description: The user ID of the account being updated is embedded in the bearer token in the authorization header.
      operationId: ChangePassword
      responses:
        '204':
          description: No Content. The request was successful and there is no additional content in the response body.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/passwordEmpty'
        '400':
          description: Bad Request. The request is malformed in some way and the server cannot process it.
        '403':
          description: Forbidden. The server recognizes the authentication credentials, but the client is not authorized to perform this request
        '500':
          description: Internal Server Error. The server could not fulfill the request.
      tags:
      - password
      requestBody:
        content:
          application/json; charset=UTF-8:
            schema:
              $ref: '#/components/schemas/passwordPasswordChangeReq'
        required: true
components:
  schemas:
    passwordEmpty:
      type: object
    passwordPasswordChangeReq:
      type: object
      properties:
        OldPassword:
          type: string
          description: Current password
        NewPassword:
          type: string
          description: New password
      example:
        OldPassword: CurrentPassword
        NewPassword: NewPassword
      title: Change password request
  securitySchemes:
    bearerAuth:
      type: apiKey
      name: Authorization
      in: header