Set user password

Set user password

post

Sets a new password for the user. Intended for password-based users; updates are applied immediately. Returns the updated user object.

Path parameters

uniqueFilterstringRequired

User identifier (USR-...) or user email address.

Body

application/jsontext/jsonapplication/*+json

passwordstring · min: 1Required

currentPasswordstring · nullableOptional

Responses

200

OK

application/json

idstringOptional

namestringOptional

iconstring · nullableOptional

revisioninteger · int32Optional

emailstringOptional

statusstringOptional

firstNamestringOptional

lastNamestringOptional

lastLoginAtstring · date-time · nullableOptional

400

Bad Request

application/json

404

Not Found

application/json

post

/public/v1/accounts/users/{uniqueFilter}/set-password

HTTPcURLJavaScriptPython

POST /public/v1/accounts/users/{uniqueFilter}/set-password HTTP/1.1
Host: api.platform.softwareone.com
Content-Type: application/json
Accept: */*
Content-Length: 65

{
  "currentPassword": "OldPassword123",
  "password": "NewPassword123!"
}

application/jsontext/jsonapplication/*+json

{
  "id": "text",
  "audit": {
    "created": {
      "at": "2026-06-11T15:22:41.200Z",
      "by": "[Circular Reference]"
    },
    "updated": {
      "at": "2026-06-11T15:22:41.200Z",
      "by": "[Circular Reference]"
    },
    "invitationAcceptedAt": "2026-06-11T15:22:41.200Z"
  },
  "$meta": {
    "omitted": [
      "text"
    ]
  },
  "name": "text",
  "icon": "text",
  "revision": 1,
  "email": "text",
  "status": "text",
  "phone": {
    "prefix": "text",
    "number": "text"
  },
  "firstName": "text",
  "lastName": "text",
  "lastLoginAt": "2026-06-11T15:22:41.200Z",
  "settings": {
    "cultureCode": "text",
    "dateFormat": "text",
    "languageCode": "text",
    "numberFormat": {
      "decimalSeparator": "text",
      "groupSeparator": "text"
    },
    "timeFormat": "text",
    "timeZone": "text"
  },
  "accounts": [
    {
      "id": "text",
      "audit": {
        "created": "[Circular Reference]",
        "updated": "[Circular Reference]"
      },
      "$meta": {
        "omitted": [
          "text"
        ]
      },
      "name": "text",
      "icon": "text",
      "revision": 1,
      "type": "Client",
      "status": "Active",
      "externalIds": {
        "pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
      },
      "externalId": "text",
      "externalName": "text",
      "address": {
        "addressLine1": "text",
        "addressLine2": "text",
        "postCode": "text",
        "city": "text",
        "state": "text",
        "country": "text"
      },
      "technicalSupportEmail": "text",
      "website": "text",
      "description": "text",
      "groups": [
        {
          "id": "text",
          "audit": "[Circular Reference]",
          "$meta": {
            "omitted": [
              "text"
            ]
          },
          "name": "text",
          "revision": 1,
          "description": "text",
          "account": "[Circular Reference]",
          "modules": [
            "[Circular Reference]"
          ],
          "logo": "text",
          "isDefault": true,
          "users": [
            "[Circular Reference]"
          ],
          "extensions": [
            "[Circular Reference]"
          ],
          "buyers": [
            "[Circular Reference]"
          ]
        }
      ],
      "eligibility": {
        "client": true,
        "partner": true
      },
      "defaultLanguageCode": "text"
    }
  ],
  "currentAccount": {
    "id": "text",
    "audit": {
      "created": "[Circular Reference]",
      "updated": "[Circular Reference]"
    },
    "$meta": {
      "omitted": [
        "text"
      ]
    },
    "name": "text",
    "icon": "text",
    "revision": 1,
    "type": "Client",
    "status": "Active",
    "externalIds": {
      "pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
    },
    "externalId": "text",
    "externalName": "text",
    "address": {
      "addressLine1": "text",
      "addressLine2": "text",
      "postCode": "text",
      "city": "text",
      "state": "text",
      "country": "text"
    },
    "technicalSupportEmail": "text",
    "website": "text",
    "description": "text",
    "groups": [
      {
        "id": "text",
        "audit": "[Circular Reference]",
        "$meta": {
          "omitted": [
            "text"
          ]
        },
        "name": "text",
        "revision": 1,
        "description": "text",
        "account": "[Circular Reference]",
        "modules": [
          "[Circular Reference]"
        ],
        "logo": "text",
        "isDefault": true,
        "users": [
          "[Circular Reference]"
        ],
        "extensions": [
          "[Circular Reference]"
        ],
        "buyers": [
          "[Circular Reference]"
        ]
      }
    ],
    "eligibility": {
      "client": true,
      "partner": true
    },
    "defaultLanguageCode": "text"
  }
}