Password service

A REST API towards the Pointsharp ID user’s password(s).

API Description

POST Password/Send

Creates a new Pointsharp Password and sends it to the user specified by the request.

PUT Password/Change

Updates a Pointsharp Password specified by the request.

DELETE Password?PasswordId={PasswordId}&Username={Username}&UserStorageName={UserStorageName}

Remove the Pointsharp Password specified by the request.

GET Password?Username={Username}&UserStorageName={UserStorageName}

Retrieves the Pointsharp Password(s) for a user specified by the request.

POST Password/Send

Creates a new Pointsharp Password and sends it to the user specified by the request.

Request information

Parameters

Name Description Additional information

request

The request data specifying the user to retrieve the new password and the required actions (if any)

Define this parameter in the request body.

Parameter information

request

Contains data specifying a Pointsharp Password to create and send. A request can specify whether a particular action should be applied after creation of the password. Any implemented action is enabled by settings its corresponding flag to "1" in the ActionFlags property.

Property Description Additional information

ActionFlags (Int32)

The bit flags specifying the enabled actions to perform after creation of the new password. The actions are specified using Big-Endian.

  • User Must Change

    User must change his/her created password on next logon. The flag is given by the 1st right-most bit.

  • Reset Password History

    All passwords stored in the password history for this user are removed from the history. The flag is given by the 2nd right-most bit.

  • Reserved flags

    The flags given by the 3rd and 4th right most bit are reserved for future use.

Example 1. User must change
var request = new SendPasswordRequest()
{
Username = "user1"
};
if (userMustChange)
{
request.ActionFlags = request.ActionFlags | 0x01;
}
Example 2. Reset password history
var change = true;  // User Must Change
var clear = false;  // Don't Clear Password History
var request = new SendPasswordRequest(change, clear)
{
Username = "user1"
};

Username (String)

The name of the user.

This parameter is required.

UserStorageName (String)

The name of the storage where the user resides. If this value is NULL (not set) then Pointsharp ID tries to find the unique user by searching through all configured user storages.

This parameter is optional.

Request body formats

application/json, text/json 
{
  "ActionFlags": 1,
  "Username": "sample string 2",
  "UserStorageName": "sample string 3"
}
application/xml, text/xml 
<SendPasswordRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Username>sample string 2</Username>
  <UserStorageName>sample string 3</UserStorageName>
  <ActionFlags>1</ActionFlags>
</SendPasswordRequest>

PUT Password/Change

Updates a Pointsharp Password specified by the request.

Request information

Parameters

Name Description Additional information

request

The request data specifying the password to change.

Define this parameter in the request body.

Parameter information

request

Contains data specifying a password to change, and what to change it to, for the provided user.

Property Description Additional information

CurrentPassword (String)

The current password to change from.

This parameter is required.

NewPassword (String)

The password to replace the current password with.

This parameter is required.

Username (String)

The name of the user.

This parameter is required.

UserStorageName (String)

The name of the storage where the user resides. If this value is NULL (not set) then Pointsharp ID tries to find the unique user by searching through all configured user storages.

This parameter is optional.

Request body formats

application/json, text/json 
{
  "CurrentPassword": "sample string 1",
  "NewPassword": "sample string 2",
  "Username": "sample string 3",
  "UserStorageName": "sample string 4"
}
application/xml, text/xml 
<ChangePasswordRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Username>sample string 3</Username>
  <UserStorageName>sample string 4</UserStorageName>
  <CurrentPassword>sample string 1</CurrentPassword>
  <NewPassword>sample string 2</NewPassword>
</ChangePasswordRequest>

DELETE Password?PasswordId={PasswordId}&Username={Username}&UserStorageName={UserStorageName}

Remove the Pointsharp Password specified by the request.

Request information

Parameters

Name Description Additional information

request

The request data specifying the password to remove.

Define this parameter in the request URI.

Parameter information

request

Contains data specifying a user’s password.

Property Description Additional information

PasswordId (DateTime)

The identifier of the password. It corresponds to the date and time of creation of the password.

This parameter is required.

Username (String)

The name of the user.

This parameter is required.

UserStorageName (String)

The name of the storage where the user resides. If this value is NULL (not set) then Pointsharp ID tries to find the unique user by searching through all configured user storages.

This parameter is optional.

GET Password?Username={Username}&UserStorageName={UserStorageName}

Retrieves the Pointsharp Password(s) for a user specified by the request.

Request information

Parameters

Name Description Additional information

request

The request data specifying the user to retrieve passwords for.

Define this parameter in the request URI.

Parameter information

request

Contains data required to request any data related to a specific user.

Property Description Additional information

Username (String)

The name of the user.

This parameter is required.

UserStorageName (String)

The name of the storage where the user resides. If this value is NULL (not set) then Pointsharp ID tries to find the unique user by searching through all configured user storages.

This parameter is optional.

Response information

The password(s) for the user.

Response body formats

application/json, text/json 
[
  {
    "$type": "PointSharp.WebServices.Models.User.PointSharpPassword, PointSharp.WebServices.Models",
    "CreateTime": "2025-09-16T15:19:59.7169141+02:00",
    "MustChange": true,
    "ResetTime": "2025-09-16T15:19:59.7169141+02:00",
    "PasswordHistoryLength": 4
  },
  {
    "$type": "PointSharp.WebServices.Models.User.PointSharpPassword, PointSharp.WebServices.Models",
    "CreateTime": "2025-09-16T15:19:59.7169141+02:00",
    "MustChange": true,
    "ResetTime": "2025-09-16T15:19:59.7169141+02:00",
    "PasswordHistoryLength": 4
  }
]
application/xml, text/xml 
<ArrayOfPointSharpPassword xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <PointSharpPassword>
    <CreateTime>2025-09-16T15:19:59.7169141+02:00</CreateTime>
    <MustChange>true</MustChange>
    <ResetTime>2025-09-16T15:19:59.7169141+02:00</ResetTime>
    <PasswordHistoryLength>4</PasswordHistoryLength>
  </PointSharpPassword>
  <PointSharpPassword>
    <CreateTime>2025-09-16T15:19:59.7169141+02:00</CreateTime>
    <MustChange>true</MustChange>
    <ResetTime>2025-09-16T15:19:59.7169141+02:00</ResetTime>
    <PasswordHistoryLength>4</PasswordHistoryLength>
  </PointSharpPassword>
</ArrayOfPointSharpPassword>