User service

A REST API towards the Pointsharp ID users.

API Description

GET User/IsLockedInDomain

Unlock the user account in the Windows domain associated to the Pointsharp user.

POST User/UnlockInDomain

Unlock the user account in the Windows domain associated to the Pointsharp user.

POST User/StorageUsers/Search

Searches for multiple users that fulfill the filter requirements specified by the request.

POST User/StorageUsers/SearchByAttributes

Retrieves a user from the user storage by matching username with other user attributes.

GET User/StorageUser?Username={Username}&UserStorageName={UserStorageName}

Retrieves a user from the user storage. The user is not required to be in the Pointsharp ID storage, and neither will it be added by this request.

GET User/Attribute?AttributeName={AttributeName}&Username={Username}&UserStorageName={UserStorageName}

Retrieves a value of a specific Pointsharp ID user’s attribute. The value may be single-valued or multivalued. It will exclude any non-string, or non-SID-data, value.

GET User/Attribute/Data?AttributeName={AttributeName}&Username={Username}&UserStorageName={UserStorageName}

Retrieves data of a specific Pointsharp ID user’s attribute. The data may be single-valued or multivalued and of any type.

POST User/Attributes

Retrieves data of a specific Pointsharp ID user’s attributes. Each attribute’s data may be single-valued or multivalued and of any type.

GET User/Details?Username={Username}&UserStorageName={UserStorageName}

Retrieves the retrievable details about the user specified by the request.

POST User

Creates a Pointsharp user to be stored in the Pointsharp ID Storage

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

Retrieves a user from the Pointsharp ID storage.

PUT User

Updates a user in the Pointsharp ID storage.

DELETE User?Username={Username}&UserStorageName={UserStorageName}

Removes a user from the Pointsharp ID storage.

GET User/IsLockedInDomain

Unlock the user account in the Windows domain associated to the Pointsharp user.

Request information

Parameters

Name Description Additional information

request

The request data specifying the user to unlock.

Define this parameter in the request body.

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.

Request body formats

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

Response information

No documentation available.

Response body formats

application/json, text/json 
{
  "FullName": "sample string 1",
  "Email": "sample string 2",
  "Photo": {
    "$type": "System.Byte[], mscorlib",
    "$value": "QEA="
  },
  "Mobile": "sample string 3",
  "LockoutTimeUtc": "2025-09-16T15:46:46.4693263+02:00",
  "IsLockedInDomain": true
}
application/xml, text/xml 
<UserData xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <FullName>sample string 1</FullName>
  <Email>sample string 2</Email>
  <Photo>QEA=</Photo>
  <Mobile>sample string 3</Mobile>
  <LockoutTimeUtc>2025-09-16T15:46:46.4693263+02:00</LockoutTimeUtc>
  <IsLockedInDomain>true</IsLockedInDomain>
</UserData>

POST User/UnlockInDomain

Unlock the user account in the Windows domain associated to the Pointsharp user.

Request information

Parameters

Name Description Additional information

request

The request data specifying the user to unlock.

Define this parameter in the request body.

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.

Request body formats

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

POST User/StorageUsers/Search

Searches for multiple users that fulfill the filter requirements specified by the request.

Request information

Parameters

Name Description Additional information

request

The request data specifying the users to search for.

Define this parameter in the request body.

Parameter information

request

Contains data specifying a filter of users to search for.

Property Description Additional information

Arguments (SearchFilterArgument[])

Specific filter values to match the user(s) by.

This parameter is optional.

Filter (SearchFilter)

The filter specifying specific state(s) or items of the requested user(s).

This parameter is optional.

UserNamePattern (String)

The pattern of the wanted username(s).

Example:

*endofusername, startofusername*, *usernamecontains*

This parameter is required.

UserStorageName (String)

The user storages to search in. Leave empty to search in all user storages.

This parameter is optional.

Request body formats

application/json, text/json 
{
  "UserNamePattern": "sample string 1",
  "UserStorageNames": {
    "$type": "System.String[], mscorlib",
    "$values": [
      "sample string 1",
      "sample string 2"
    ]
  },
  "Filter": {
    "$type": "PointSharp.WebServices.Models.User.SearchFilter, PointSharp.WebServices.Models",
    "Enabled": true,
    "Disabled": true,
    "Locked": true,
    "TimeLocked": true,
    "PSIDMember": true,
    "NotPSIDMember": true,
    "ActiveSync": true,
    "NotActiveSync": true,
    "ActiveSyncQuarantine": true,
    "ActiveSyncPending": true,
    "ActiveSyncDisabled": true,
    "ActiveSyncContentWipe": true,
    "ActiveSyncWipeConfirmed": true,
    "ActiveSyncTimeWindow": true,
    "Token": true,
    "NoToken": true,
    "PointSharpPassword": true,
    "NoPointSharpPassword": true
  },
  "Arguments": {
    "$type": "PointSharp.WebServices.Models.User.SearchFilterArgument[], PointSharp.WebServices.Models",
    "$values": [
      {
        "$type": "PointSharp.WebServices.Models.User.SearchFilterArgument, PointSharp.WebServices.Models",
        "Filter": "sample string 1",
        "Value": "sample string 2"
      },
      {
        "$type": "PointSharp.WebServices.Models.User.SearchFilterArgument, PointSharp.WebServices.Models",
        "Filter": "sample string 1",
        "Value": "sample string 2"
      }
    ]
  }
}
application/xml, text/xml 
<UsersSearchRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <UserNamePattern>sample string 1</UserNamePattern>
  <UserStorageNames>
    <string>sample string 1</string>
    <string>sample string 2</string>
  </UserStorageNames>
  <Filter>
    <Enabled>true</Enabled>
    <Disabled>true</Disabled>
    <Locked>true</Locked>
    <TimeLocked>true</TimeLocked>
    <PSIDMember>true</PSIDMember>
    <NotPSIDMember>true</NotPSIDMember>
    <ActiveSync>true</ActiveSync>
    <NotActiveSync>true</NotActiveSync>
    <ActiveSyncQuarantine>true</ActiveSyncQuarantine>
    <ActiveSyncPending>true</ActiveSyncPending>
    <ActiveSyncDisabled>true</ActiveSyncDisabled>
    <ActiveSyncContentWipe>true</ActiveSyncContentWipe>
    <ActiveSyncWipeConfirmed>true</ActiveSyncWipeConfirmed>
    <ActiveSyncTimeWindow>true</ActiveSyncTimeWindow>
    <Token>true</Token>
    <NoToken>true</NoToken>
    <PointSharpPassword>true</PointSharpPassword>
    <NoPointSharpPassword>true</NoPointSharpPassword>
  </Filter>
  <Arguments>
    <SearchFilterArgument>
      <Filter>sample string 1</Filter>
      <Value>sample string 2</Value>
    </SearchFilterArgument>
    <SearchFilterArgument>
      <Filter>sample string 1</Filter>
      <Value>sample string 2</Value>
    </SearchFilterArgument>
  </Arguments>
</UsersSearchRequest>

Response information

The found users. The list may be empty if no users were found.

Response body formats

application/json, text/json 
[
  {
    "$type": "PointSharp.WebServices.Models.User.User, PointSharp.WebServices.Models",
    "DistinguishedName": "sample string 1",
    "IsLocked": true,
    "IsTimeLocked": true,
    "IsDisabled": true,
    "FailedCache": true,
    "CreateTime": "2025-09-17T09:35:44.8132545+02:00",
    "LastLogin": "2025-09-17T09:35:44.8132545+02:00",
    "LastFailed": "2025-09-17T09:35:44.8132545+02:00",
    "EndOfTimeLocked": "2025-09-17T09:35:44.8132545+02:00",
    "OathTokens": {
      "$type": "PointSharp.WebServices.Models.User.OathToken[], PointSharp.WebServices.Models",
      "$values": [
        {
          "$type": "PointSharp.WebServices.Models.User.OathToken, PointSharp.WebServices.Models",
          "Platform": "sample string 1",
          "IsPinProtected": true,
          "IsDisabled": true,
          "Name": "sample string 4",
          "Id": "sample string 5",
          "SerialNumber": "sample string 6",
          "Description": "sample string 7",
          "LastUsed": "2025-09-17T09:35:44.8152719+02:00",
          "CreateTime": "2025-09-17T09:35:44.8152719+02:00",
          "ExpireAt": "2025-09-17T09:35:44.8152719+02:00",
          "IsExpired": true
        },
        {
          "$type": "PointSharp.WebServices.Models.User.OathToken, PointSharp.WebServices.Models",
          "Platform": "sample string 1",
          "IsPinProtected": true,
          "IsDisabled": true,
          "Name": "sample string 4",
          "Id": "sample string 5",
          "SerialNumber": "sample string 6",
          "Description": "sample string 7",
          "LastUsed": "2025-09-17T09:35:44.8152719+02:00",
          "CreateTime": "2025-09-17T09:35:44.8152719+02:00",
          "ExpireAt": "2025-09-17T09:35:44.8152719+02:00",
          "IsExpired": true
        }
      ]
    },
    "FidoTokens": {
      "$type": "PointSharp.WebServices.Models.User.OathToken[], PointSharp.WebServices.Models",
      "$values": [
        {
          "$type": "PointSharp.WebServices.Models.User.OathToken, PointSharp.WebServices.Models",
          "Platform": "sample string 1",
          "IsPinProtected": true,
          "IsDisabled": true,
          "Name": "sample string 4",
          "Id": "sample string 5",
          "SerialNumber": "sample string 6",
          "Description": "sample string 7",
          "LastUsed": "2025-09-17T09:35:44.8152719+02:00",
          "CreateTime": "2025-09-17T09:35:44.8152719+02:00",
          "ExpireAt": "2025-09-17T09:35:44.8152719+02:00",
          "IsExpired": true
        },
        {
          "$type": "PointSharp.WebServices.Models.User.OathToken, PointSharp.WebServices.Models",
          "Platform": "sample string 1",
          "IsPinProtected": true,
          "IsDisabled": true,
          "Name": "sample string 4",
          "Id": "sample string 5",
          "SerialNumber": "sample string 6",
          "Description": "sample string 7",
          "LastUsed": "2025-09-17T09:35:44.8152719+02:00",
          "CreateTime": "2025-09-17T09:35:44.8152719+02:00",
          "ExpireAt": "2025-09-17T09:35:44.8152719+02:00",
          "IsExpired": true
        }
      ]
    },
    "Devices": {
      "$type": "PointSharp.WebServices.Models.User.Device[], PointSharp.WebServices.Models",
      "$values": [
        {
          "$type": "PointSharp.WebServices.Models.User.Device, PointSharp.WebServices.Models",
          "FriendlyName": "sample string 1",
          "State": 2,
          "DeviceId": "sample string 3",
          "DeviceType": "sample string 4",
          "UserAgent": "sample string 5",
          "CreateTime": "2025-09-17T09:35:44.8162875+02:00",
          "LastOkTime": "2025-09-17T09:35:44.8162875+02:00",
          "LastErrorTime": "2025-09-17T09:35:44.8162875+02:00",
          "TimeoutConf": 9,
          "TimeoutConfAheadNotification": 10,
          "Timeout": "2025-09-17T09:35:44.8162875+02:00",
          "TimeoutNotificationSent": true,
          "EASSyncKeyPrefix": 13
        },
        {
          "$type": "PointSharp.WebServices.Models.User.Device, PointSharp.WebServices.Models",
          "FriendlyName": "sample string 1",
          "State": 2,
          "DeviceId": "sample string 3",
          "DeviceType": "sample string 4",
          "UserAgent": "sample string 5",
          "CreateTime": "2025-09-17T09:35:44.8162875+02:00",
          "LastOkTime": "2025-09-17T09:35:44.8162875+02:00",
          "LastErrorTime": "2025-09-17T09:35:44.8162875+02:00",
          "TimeoutConf": 9,
          "TimeoutConfAheadNotification": 10,
          "Timeout": "2025-09-17T09:35:44.8162875+02:00",
          "TimeoutNotificationSent": true,
          "EASSyncKeyPrefix": 13
        }
      ]
    },
    "AuthenticationCaches": {
      "$type": "PointSharp.WebServices.Models.User.AuthenticationCache[], PointSharp.WebServices.Models",
      "$values": [
        {
          "$type": "PointSharp.WebServices.Models.User.AuthenticationCache, PointSharp.WebServices.Models",
          "Method": "sample string 1",
          "CacheTime": "2025-09-17T09:35:44.8184591+02:00",
          "Counter": 3
        },
        {
          "$type": "PointSharp.WebServices.Models.User.AuthenticationCache, PointSharp.WebServices.Models",
          "Method": "sample string 1",
          "CacheTime": "2025-09-17T09:35:44.8184591+02:00",
          "Counter": 3
        }
      ]
    },
    "Passwords": {
      "$type": "PointSharp.WebServices.Models.User.PointSharpPassword[], PointSharp.WebServices.Models",
      "$values": [
        {
          "$type": "PointSharp.WebServices.Models.User.PointSharpPassword, PointSharp.WebServices.Models",
          "CreateTime": "2025-09-17T09:35:44.8184591+02:00",
          "MustChange": true,
          "ResetTime": "2025-09-17T09:35:44.8192012+02:00",
          "PasswordHistoryLength": 4
        },
        {
          "$type": "PointSharp.WebServices.Models.User.PointSharpPassword, PointSharp.WebServices.Models",
          "CreateTime": "2025-09-17T09:35:44.8184591+02:00",
          "MustChange": true,
          "ResetTime": "2025-09-17T09:35:44.8192012+02:00",
          "PasswordHistoryLength": 4
        }
      ]
    },
    "Attributes": {
      "$type": "System.Collections.Generic.List`1[[PointSharp.WebServices.Models.User.UserProperty, PointSharp.WebServices.Models]], mscorlib",
      "$values": [
        {
          "$type": "PointSharp.WebServices.Models.User.UserProperty, PointSharp.WebServices.Models",
          "Key": "sample string 1",
          "Value": "sample string 2"
        },
        {
          "$type": "PointSharp.WebServices.Models.User.UserProperty, PointSharp.WebServices.Models",
          "Key": "sample string 1",
          "Value": "sample string 2"
        }
      ]
    },
    "Mobile": "sample string 10",
    "Mail": "sample string 11",
    "Unbound": true,
    "Username": "sample string 13",
    "UserStorageName": "sample string 14"
  },
  {
    "$type": "PointSharp.WebServices.Models.User.User, PointSharp.WebServices.Models",
    "DistinguishedName": "sample string 1",
    "IsLocked": true,
    "IsTimeLocked": true,
    "IsDisabled": true,
    "FailedCache": true,
    "CreateTime": "2025-09-17T09:35:44.8132545+02:00",
    "LastLogin": "2025-09-17T09:35:44.8132545+02:00",
    "LastFailed": "2025-09-17T09:35:44.8132545+02:00",
    "EndOfTimeLocked": "2025-09-17T09:35:44.8132545+02:00",
    "OathTokens": {
      "$type": "PointSharp.WebServices.Models.User.OathToken[], PointSharp.WebServices.Models",
      "$values": [
        {
          "$type": "PointSharp.WebServices.Models.User.OathToken, PointSharp.WebServices.Models",
          "Platform": "sample string 1",
          "IsPinProtected": true,
          "IsDisabled": true,
          "Name": "sample string 4",
          "Id": "sample string 5",
          "SerialNumber": "sample string 6",
          "Description": "sample string 7",
          "LastUsed": "2025-09-17T09:35:44.8152719+02:00",
          "CreateTime": "2025-09-17T09:35:44.8152719+02:00",
          "ExpireAt": "2025-09-17T09:35:44.8152719+02:00",
          "IsExpired": true
        },
        {
          "$type": "PointSharp.WebServices.Models.User.OathToken, PointSharp.WebServices.Models",
          "Platform": "sample string 1",
          "IsPinProtected": true,
          "IsDisabled": true,
          "Name": "sample string 4",
          "Id": "sample string 5",
          "SerialNumber": "sample string 6",
          "Description": "sample string 7",
          "LastUsed": "2025-09-17T09:35:44.8152719+02:00",
          "CreateTime": "2025-09-17T09:35:44.8152719+02:00",
          "ExpireAt": "2025-09-17T09:35:44.8152719+02:00",
          "IsExpired": true
        }
      ]
    },
    "FidoTokens": {
      "$type": "PointSharp.WebServices.Models.User.OathToken[], PointSharp.WebServices.Models",
      "$values": [
        {
          "$type": "PointSharp.WebServices.Models.User.OathToken, PointSharp.WebServices.Models",
          "Platform": "sample string 1",
          "IsPinProtected": true,
          "IsDisabled": true,
          "Name": "sample string 4",
          "Id": "sample string 5",
          "SerialNumber": "sample string 6",
          "Description": "sample string 7",
          "LastUsed": "2025-09-17T09:35:44.8152719+02:00",
          "CreateTime": "2025-09-17T09:35:44.8152719+02:00",
          "ExpireAt": "2025-09-17T09:35:44.8152719+02:00",
          "IsExpired": true
        },
        {
          "$type": "PointSharp.WebServices.Models.User.OathToken, PointSharp.WebServices.Models",
          "Platform": "sample string 1",
          "IsPinProtected": true,
          "IsDisabled": true,
          "Name": "sample string 4",
          "Id": "sample string 5",
          "SerialNumber": "sample string 6",
          "Description": "sample string 7",
          "LastUsed": "2025-09-17T09:35:44.8152719+02:00",
          "CreateTime": "2025-09-17T09:35:44.8152719+02:00",
          "ExpireAt": "2025-09-17T09:35:44.8152719+02:00",
          "IsExpired": true
        }
      ]
    },
    "Devices": {
      "$type": "PointSharp.WebServices.Models.User.Device[], PointSharp.WebServices.Models",
      "$values": [
        {
          "$type": "PointSharp.WebServices.Models.User.Device, PointSharp.WebServices.Models",
          "FriendlyName": "sample string 1",
          "State": 2,
          "DeviceId": "sample string 3",
          "DeviceType": "sample string 4",
          "UserAgent": "sample string 5",
          "CreateTime": "2025-09-17T09:35:44.8162875+02:00",
          "LastOkTime": "2025-09-17T09:35:44.8162875+02:00",
          "LastErrorTime": "2025-09-17T09:35:44.8162875+02:00",
          "TimeoutConf": 9,
          "TimeoutConfAheadNotification": 10,
          "Timeout": "2025-09-17T09:35:44.8162875+02:00",
          "TimeoutNotificationSent": true,
          "EASSyncKeyPrefix": 13
        },
        {
          "$type": "PointSharp.WebServices.Models.User.Device, PointSharp.WebServices.Models",
          "FriendlyName": "sample string 1",
          "State": 2,
          "DeviceId": "sample string 3",
          "DeviceType": "sample string 4",
          "UserAgent": "sample string 5",
          "CreateTime": "2025-09-17T09:35:44.8162875+02:00",
          "LastOkTime": "2025-09-17T09:35:44.8162875+02:00",
          "LastErrorTime": "2025-09-17T09:35:44.8162875+02:00",
          "TimeoutConf": 9,
          "TimeoutConfAheadNotification": 10,
          "Timeout": "2025-09-17T09:35:44.8162875+02:00",
          "TimeoutNotificationSent": true,
          "EASSyncKeyPrefix": 13
        }
      ]
    },
    "AuthenticationCaches": {
      "$type": "PointSharp.WebServices.Models.User.AuthenticationCache[], PointSharp.WebServices.Models",
      "$values": [
        {
          "$type": "PointSharp.WebServices.Models.User.AuthenticationCache, PointSharp.WebServices.Models",
          "Method": "sample string 1",
          "CacheTime": "2025-09-17T09:35:44.8184591+02:00",
          "Counter": 3
        },
        {
          "$type": "PointSharp.WebServices.Models.User.AuthenticationCache, PointSharp.WebServices.Models",
          "Method": "sample string 1",
          "CacheTime": "2025-09-17T09:35:44.8184591+02:00",
          "Counter": 3
        }
      ]
    },
    "Passwords": {
      "$type": "PointSharp.WebServices.Models.User.PointSharpPassword[], PointSharp.WebServices.Models",
      "$values": [
        {
          "$type": "PointSharp.WebServices.Models.User.PointSharpPassword, PointSharp.WebServices.Models",
          "CreateTime": "2025-09-17T09:35:44.8184591+02:00",
          "MustChange": true,
          "ResetTime": "2025-09-17T09:35:44.8192012+02:00",
          "PasswordHistoryLength": 4
        },
        {
          "$type": "PointSharp.WebServices.Models.User.PointSharpPassword, PointSharp.WebServices.Models",
          "CreateTime": "2025-09-17T09:35:44.8184591+02:00",
          "MustChange": true,
          "ResetTime": "2025-09-17T09:35:44.8192012+02:00",
          "PasswordHistoryLength": 4
        }
      ]
    },
    "Attributes": {
      "$type": "System.Collections.Generic.List`1[[PointSharp.WebServices.Models.User.UserProperty, PointSharp.WebServices.Models]], mscorlib",
      "$values": [
        {
          "$type": "PointSharp.WebServices.Models.User.UserProperty, PointSharp.WebServices.Models",
          "Key": "sample string 1",
          "Value": "sample string 2"
        },
        {
          "$type": "PointSharp.WebServices.Models.User.UserProperty, PointSharp.WebServices.Models",
          "Key": "sample string 1",
          "Value": "sample string 2"
        }
      ]
    },
    "Mobile": "sample string 10",
    "Mail": "sample string 11",
    "Unbound": true,
    "Username": "sample string 13",
    "UserStorageName": "sample string 14"
  }
]
application/xml, text/xml 
<ArrayOfUser xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <User>
    <Username>sample string 13</Username>
    <UserStorageName>sample string 14</UserStorageName>
    <Mobile>sample string 10</Mobile>
    <Mail>sample string 11</Mail>
    <Unbound>true</Unbound>
    <DistinguishedName>sample string 1</DistinguishedName>
    <IsLocked>true</IsLocked>
    <IsTimeLocked>true</IsTimeLocked>
    <IsDisabled>true</IsDisabled>
    <FailedCache>true</FailedCache>
    <CreateTime>2025-09-17T09:35:44.8132545+02:00</CreateTime>
    <LastLogin>2025-09-17T09:35:44.8132545+02:00</LastLogin>
    <LastFailed>2025-09-17T09:35:44.8132545+02:00</LastFailed>
    <EndOfTimeLocked>2025-09-17T09:35:44.8132545+02:00</EndOfTimeLocked>
    <OathTokens>
      <OathToken>
        <Platform>sample string 1</Platform>
        <IsPinProtected>true</IsPinProtected>
        <IsDisabled>true</IsDisabled>
        <Name>sample string 4</Name>
        <Id>sample string 5</Id>
        <SerialNumber>sample string 6</SerialNumber>
        <Description>sample string 7</Description>
        <LastUsed>2025-09-17T09:35:44.8152719+02:00</LastUsed>
        <CreateTime>2025-09-17T09:35:44.8152719+02:00</CreateTime>
        <ExpireAt>2025-09-17T09:35:44.8152719+02:00</ExpireAt>
        <IsExpired>true</IsExpired>
      </OathToken>
      <OathToken>
        <Platform>sample string 1</Platform>
        <IsPinProtected>true</IsPinProtected>
        <IsDisabled>true</IsDisabled>
        <Name>sample string 4</Name>
        <Id>sample string 5</Id>
        <SerialNumber>sample string 6</SerialNumber>
        <Description>sample string 7</Description>
        <LastUsed>2025-09-17T09:35:44.8152719+02:00</LastUsed>
        <CreateTime>2025-09-17T09:35:44.8152719+02:00</CreateTime>
        <ExpireAt>2025-09-17T09:35:44.8152719+02:00</ExpireAt>
        <IsExpired>true</IsExpired>
      </OathToken>
    </OathTokens>
    <FidoTokens>
      <OathToken>
        <Platform>sample string 1</Platform>
        <IsPinProtected>true</IsPinProtected>
        <IsDisabled>true</IsDisabled>
        <Name>sample string 4</Name>
        <Id>sample string 5</Id>
        <SerialNumber>sample string 6</SerialNumber>
        <Description>sample string 7</Description>
        <LastUsed>2025-09-17T09:35:44.8152719+02:00</LastUsed>
        <CreateTime>2025-09-17T09:35:44.8152719+02:00</CreateTime>
        <ExpireAt>2025-09-17T09:35:44.8152719+02:00</ExpireAt>
        <IsExpired>true</IsExpired>
      </OathToken>
      <OathToken>
        <Platform>sample string 1</Platform>
        <IsPinProtected>true</IsPinProtected>
        <IsDisabled>true</IsDisabled>
        <Name>sample string 4</Name>
        <Id>sample string 5</Id>
        <SerialNumber>sample string 6</SerialNumber>
        <Description>sample string 7</Description>
        <LastUsed>2025-09-17T09:35:44.8152719+02:00</LastUsed>
        <CreateTime>2025-09-17T09:35:44.8152719+02:00</CreateTime>
        <ExpireAt>2025-09-17T09:35:44.8152719+02:00</ExpireAt>
        <IsExpired>true</IsExpired>
      </OathToken>
    </FidoTokens>
    <Devices>
      <Device>
        <FriendlyName>sample string 1</FriendlyName>
        <State>2</State>
        <DeviceId>sample string 3</DeviceId>
        <DeviceType>sample string 4</DeviceType>
        <UserAgent>sample string 5</UserAgent>
        <CreateTime>2025-09-17T09:35:44.8162875+02:00</CreateTime>
        <LastOkTime>2025-09-17T09:35:44.8162875+02:00</LastOkTime>
        <LastErrorTime>2025-09-17T09:35:44.8162875+02:00</LastErrorTime>
        <TimeoutConf>9</TimeoutConf>
        <TimeoutConfAheadNotification>10</TimeoutConfAheadNotification>
        <Timeout>2025-09-17T09:35:44.8162875+02:00</Timeout>
        <TimeoutNotificationSent>true</TimeoutNotificationSent>
        <EASSyncKeyPrefix>13</EASSyncKeyPrefix>
      </Device>
      <Device>
        <FriendlyName>sample string 1</FriendlyName>
        <State>2</State>
        <DeviceId>sample string 3</DeviceId>
        <DeviceType>sample string 4</DeviceType>
        <UserAgent>sample string 5</UserAgent>
        <CreateTime>2025-09-17T09:35:44.8162875+02:00</CreateTime>
        <LastOkTime>2025-09-17T09:35:44.8162875+02:00</LastOkTime>
        <LastErrorTime>2025-09-17T09:35:44.8162875+02:00</LastErrorTime>
        <TimeoutConf>9</TimeoutConf>
        <TimeoutConfAheadNotification>10</TimeoutConfAheadNotification>
        <Timeout>2025-09-17T09:35:44.8162875+02:00</Timeout>
        <TimeoutNotificationSent>true</TimeoutNotificationSent>
        <EASSyncKeyPrefix>13</EASSyncKeyPrefix>
      </Device>
    </Devices>
    <AuthenticationCaches>
      <AuthenticationCache>
        <Method>sample string 1</Method>
        <CacheTime>2025-09-17T09:35:44.8184591+02:00</CacheTime>
        <Counter>3</Counter>
      </AuthenticationCache>
      <AuthenticationCache>
        <Method>sample string 1</Method>
        <CacheTime>2025-09-17T09:35:44.8184591+02:00</CacheTime>
        <Counter>3</Counter>
      </AuthenticationCache>
    </AuthenticationCaches>
    <Passwords>
      <PointSharpPassword>
        <CreateTime>2025-09-17T09:35:44.8184591+02:00</CreateTime>
        <MustChange>true</MustChange>
        <ResetTime>2025-09-17T09:35:44.8192012+02:00</ResetTime>
        <PasswordHistoryLength>4</PasswordHistoryLength>
      </PointSharpPassword>
      <PointSharpPassword>
        <CreateTime>2025-09-17T09:35:44.8184591+02:00</CreateTime>
        <MustChange>true</MustChange>
        <ResetTime>2025-09-17T09:35:44.8192012+02:00</ResetTime>
        <PasswordHistoryLength>4</PasswordHistoryLength>
      </PointSharpPassword>
    </Passwords>
    <Attributes>
      <UserProperty>
        <Key>sample string 1</Key>
        <Value>sample string 2</Value>
      </UserProperty>
      <UserProperty>
        <Key>sample string 1</Key>
        <Value>sample string 2</Value>
      </UserProperty>
    </Attributes>
  </User>
  <User>
    <Username>sample string 13</Username>
    <UserStorageName>sample string 14</UserStorageName>
    <Mobile>sample string 10</Mobile>
    <Mail>sample string 11</Mail>
    <Unbound>true</Unbound>
    <DistinguishedName>sample string 1</DistinguishedName>
    <IsLocked>true</IsLocked>
    <IsTimeLocked>true</IsTimeLocked>
    <IsDisabled>true</IsDisabled>
    <FailedCache>true</FailedCache>
    <CreateTime>2025-09-17T09:35:44.8132545+02:00</CreateTime>
    <LastLogin>2025-09-17T09:35:44.8132545+02:00</LastLogin>
    <LastFailed>2025-09-17T09:35:44.8132545+02:00</LastFailed>
    <EndOfTimeLocked>2025-09-17T09:35:44.8132545+02:00</EndOfTimeLocked>
    <OathTokens>
      <OathToken>
        <Platform>sample string 1</Platform>
        <IsPinProtected>true</IsPinProtected>
        <IsDisabled>true</IsDisabled>
        <Name>sample string 4</Name>
        <Id>sample string 5</Id>
        <SerialNumber>sample string 6</SerialNumber>
        <Description>sample string 7</Description>
        <LastUsed>2025-09-17T09:35:44.8152719+02:00</LastUsed>
        <CreateTime>2025-09-17T09:35:44.8152719+02:00</CreateTime>
        <ExpireAt>2025-09-17T09:35:44.8152719+02:00</ExpireAt>
        <IsExpired>true</IsExpired>
      </OathToken>
      <OathToken>
        <Platform>sample string 1</Platform>
        <IsPinProtected>true</IsPinProtected>
        <IsDisabled>true</IsDisabled>
        <Name>sample string 4</Name>
        <Id>sample string 5</Id>
        <SerialNumber>sample string 6</SerialNumber>
        <Description>sample string 7</Description>
        <LastUsed>2025-09-17T09:35:44.8152719+02:00</LastUsed>
        <CreateTime>2025-09-17T09:35:44.8152719+02:00</CreateTime>
        <ExpireAt>2025-09-17T09:35:44.8152719+02:00</ExpireAt>
        <IsExpired>true</IsExpired>
      </OathToken>
    </OathTokens>
    <FidoTokens>
      <OathToken>
        <Platform>sample string 1</Platform>
        <IsPinProtected>true</IsPinProtected>
        <IsDisabled>true</IsDisabled>
        <Name>sample string 4</Name>
        <Id>sample string 5</Id>
        <SerialNumber>sample string 6</SerialNumber>
        <Description>sample string 7</Description>
        <LastUsed>2025-09-17T09:35:44.8152719+02:00</LastUsed>
        <CreateTime>2025-09-17T09:35:44.8152719+02:00</CreateTime>
        <ExpireAt>2025-09-17T09:35:44.8152719+02:00</ExpireAt>
        <IsExpired>true</IsExpired>
      </OathToken>
      <OathToken>
        <Platform>sample string 1</Platform>
        <IsPinProtected>true</IsPinProtected>
        <IsDisabled>true</IsDisabled>
        <Name>sample string 4</Name>
        <Id>sample string 5</Id>
        <SerialNumber>sample string 6</SerialNumber>
        <Description>sample string 7</Description>
        <LastUsed>2025-09-17T09:35:44.8152719+02:00</LastUsed>
        <CreateTime>2025-09-17T09:35:44.8152719+02:00</CreateTime>
        <ExpireAt>2025-09-17T09:35:44.8152719+02:00</ExpireAt>
        <IsExpired>true</IsExpired>
      </OathToken>
    </FidoTokens>
    <Devices>
      <Device>
        <FriendlyName>sample string 1</FriendlyName>
        <State>2</State>
        <DeviceId>sample string 3</DeviceId>
        <DeviceType>sample string 4</DeviceType>
        <UserAgent>sample string 5</UserAgent>
        <CreateTime>2025-09-17T09:35:44.8162875+02:00</CreateTime>
        <LastOkTime>2025-09-17T09:35:44.8162875+02:00</LastOkTime>
        <LastErrorTime>2025-09-17T09:35:44.8162875+02:00</LastErrorTime>
        <TimeoutConf>9</TimeoutConf>
        <TimeoutConfAheadNotification>10</TimeoutConfAheadNotification>
        <Timeout>2025-09-17T09:35:44.8162875+02:00</Timeout>
        <TimeoutNotificationSent>true</TimeoutNotificationSent>
        <EASSyncKeyPrefix>13</EASSyncKeyPrefix>
      </Device>
      <Device>
        <FriendlyName>sample string 1</FriendlyName>
        <State>2</State>
        <DeviceId>sample string 3</DeviceId>
        <DeviceType>sample string 4</DeviceType>
        <UserAgent>sample string 5</UserAgent>
        <CreateTime>2025-09-17T09:35:44.8162875+02:00</CreateTime>
        <LastOkTime>2025-09-17T09:35:44.8162875+02:00</LastOkTime>
        <LastErrorTime>2025-09-17T09:35:44.8162875+02:00</LastErrorTime>
        <TimeoutConf>9</TimeoutConf>
        <TimeoutConfAheadNotification>10</TimeoutConfAheadNotification>
        <Timeout>2025-09-17T09:35:44.8162875+02:00</Timeout>
        <TimeoutNotificationSent>true</TimeoutNotificationSent>
        <EASSyncKeyPrefix>13</EASSyncKeyPrefix>
      </Device>
    </Devices>
    <AuthenticationCaches>
      <AuthenticationCache>
        <Method>sample string 1</Method>
        <CacheTime>2025-09-17T09:35:44.8184591+02:00</CacheTime>
        <Counter>3</Counter>
      </AuthenticationCache>
      <AuthenticationCache>
        <Method>sample string 1</Method>
        <CacheTime>2025-09-17T09:35:44.8184591+02:00</CacheTime>
        <Counter>3</Counter>
      </AuthenticationCache>
    </AuthenticationCaches>
    <Passwords>
      <PointSharpPassword>
        <CreateTime>2025-09-17T09:35:44.8184591+02:00</CreateTime>
        <MustChange>true</MustChange>
        <ResetTime>2025-09-17T09:35:44.8192012+02:00</ResetTime>
        <PasswordHistoryLength>4</PasswordHistoryLength>
      </PointSharpPassword>
      <PointSharpPassword>
        <CreateTime>2025-09-17T09:35:44.8184591+02:00</CreateTime>
        <MustChange>true</MustChange>
        <ResetTime>2025-09-17T09:35:44.8192012+02:00</ResetTime>
        <PasswordHistoryLength>4</PasswordHistoryLength>
      </PointSharpPassword>
    </Passwords>
    <Attributes>
      <UserProperty>
        <Key>sample string 1</Key>
        <Value>sample string 2</Value>
      </UserProperty>
      <UserProperty>
        <Key>sample string 1</Key>
        <Value>sample string 2</Value>
      </UserProperty>
    </Attributes>
  </User>
</ArrayOfUser>

POST User/StorageUsers/SearchByAttributes

Retrieves a user from the user storage by matching username with other user attributes.

Request information

Parameters

Name Description Additional information

request

Define this parameter in the request body.

Parameter information

request

Contains data required to request a specific user by search attribute.

Property Description Additional information

SearchAttributes (String[])

Attributes to match username with.

This parameter is optional.

UserAttributes (String[])

User data to be returned with.

This parameter is optional.

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 
{
  "SearchAttributes": {
    "$type": "System.String[], mscorlib",
    "$values": [
      "sample string 1",
      "sample string 2"
    ]
  },
  "UserAttributes": {
    "$type": "System.String[], mscorlib",
    "$values": [
      "sample string 1",
      "sample string 2"
    ]
  },
  "Username": "sample string 1",
  "UserStorageName": "sample string 2"
}
application/xml, text/xml 
<UserByAttributeRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Username>sample string 1</Username>
  <UserStorageName>sample string 2</UserStorageName>
  <SearchAttributes>
    <string>sample string 1</string>
    <string>sample string 2</string>
  </SearchAttributes>
  <UserAttributes>
    <string>sample string 1</string>
    <string>sample string 2</string>
  </UserAttributes>
</UserByAttributeRequest>

Response information

Response body formats

application/json, text/json 
{
  "DistinguishedName": "CN=My User,OU=Users,OU=PointSharp,DC=company,DC=com",
  "IsLocked": false,
  "IsTimeLocked": false,
  "IsDisabled": false,
  "FailedCache": false,
  "CreateTime": "2013-04-08T10:18:16",
  "LastLogin": "2015-05-27T09:52:36",
  "LastFailed": "2015-03-18T06:08:45",
  "EndOfTimeLocked": "0001-01-01T00:00:00",
  "OathTokens": [
    {
      "Platform": "Hardware",
      "IsPinProtected": false,
      "IsDisabled": false,
      "Name": "NS-PS-00000000",
      "Id": null,
      "SerialNumber": null,
      "Description": "NS-PS-00000000 (Hardware)",
      "LastUsed": "2015-05-27T09:52:36",
      "CreateTime": "0001-01-01T00:00:00",
      "ExpireAt": "0001-01-01T00:00:00",
      "IsExpired": false
    },
    {
      "Platform": "MobileToken",
      "IsPinProtected": true,
      "IsDisabled": false,
      "Name": "2015-04-07",
      "Id": null,
      "SerialNumber": null,
      "Description": "2015-04-07 (MobileToken)",
      "LastUsed": "2025-09-17T10:08:20.3786662+02:00",
      "CreateTime": "0001-01-01T00:00:00",
      "ExpireAt": "0001-01-01T00:00:00",
      "IsExpired": false
    },
    {
      "Platform": "GoogleTOTP",
      "IsPinProtected": false,
      "IsDisabled": false,
      "Name": "GoogleTOTP",
      "Id": null,
      "SerialNumber": null,
      "Description": "GoogleTOTP (GoogleTOTP)",
      "LastUsed": "2013-04-08T10:29:49",
      "CreateTime": "0001-01-01T00:00:00",
      "ExpireAt": "0001-01-01T00:00:00",
      "IsExpired": false
    }
  ],
  "FidoTokens": null,
  "Devices": [
    {
      "FriendlyName": null,
      "State": 0,
      "DeviceId": "androidc1622222222",
      "DeviceType": "SonyD5803",
      "UserAgent": "SonyD5803/5.0.2-EAS-2.0",
      "CreateTime": "2013-04-08T10:33:20",
      "LastOkTime": "2015-05-27T09:52:36",
      "LastErrorTime": "0001-01-01T00:00:00",
      "TimeoutConf": 0,
      "TimeoutConfAheadNotification": 0,
      "Timeout": "0001-01-01T00:00:00",
      "TimeoutNotificationSent": false,
      "EASSyncKeyPrefix": 0
    },
    {
      "FriendlyName": null,
      "State": 0,
      "DeviceId": "222B22DC-2D22-2C22-22FD-2CB2C2222EBD",
      "DeviceType": "IPhoneLync",
      "UserAgent": "iPhoneLync/5.7.517.0000 (iPhone iPhone OS 8.3)",
      "CreateTime": "2015-02-09T11:13:28",
      "LastOkTime": "2015-05-27T09:52:36",
      "LastErrorTime": "0001-01-01T00:00:00",
      "TimeoutConf": 0,
      "TimeoutConfAheadNotification": 0,
      "Timeout": "0001-01-01T00:00:00",
      "TimeoutNotificationSent": false,
      "EASSyncKeyPrefix": 0
    }
  ],
  "AuthenticationCaches": [
    {
      "Method": "NTLM",
      "CacheTime": "2015-05-10T16:18:55",
      "Counter": 2
    },
    {
      "Method": "PP_OTP_APPENDEND",
      "CacheTime": "2015-03-11T09:37:12",
      "Counter": 0
    }
  ],
  "Passwords": [
    {
      "CreateTime": "2013-04-08T10:29:49",
      "MustChange": false,
      "ResetTime": "0001-01-01T00:00:00",
      "PasswordHistoryLength": 2
    }
  ],
  "Attributes": [],
  "Mobile": null,
  "Mail": null,
  "Unbound": false,
  "Username": "myUser",
  "UserStorageName": "myUserStorage"
}
application/xml, text/xml 
<?xml version="1.0" encoding="utf-16"?>
<User xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Username>myUser</Username>
  <UserStorageName>myUserStorage</UserStorageName>
  <Unbound>false</Unbound>
  <DistinguishedName>CN=My User,OU=Users,OU=PointSharp,DC=company,DC=com</DistinguishedName>
  <IsLocked>false</IsLocked>
  <IsTimeLocked>false</IsTimeLocked>
  <IsDisabled>false</IsDisabled>
  <FailedCache>false</FailedCache>
  <CreateTime>2013-04-08T10:18:16</CreateTime>
  <LastLogin>2015-05-27T09:52:36</LastLogin>
  <LastFailed>2015-03-18T06:08:45</LastFailed>
  <EndOfTimeLocked>0001-01-01T00:00:00</EndOfTimeLocked>
  <OathTokens>
    <OathToken>
      <Platform>Hardware</Platform>
      <IsPinProtected>false</IsPinProtected>
      <IsDisabled>false</IsDisabled>
      <Name>NS-PS-00000000</Name>
      <Description>NS-PS-00000000 (Hardware)</Description>
      <LastUsed>2015-05-27T09:52:36</LastUsed>
      <CreateTime>0001-01-01T00:00:00</CreateTime>
      <ExpireAt>0001-01-01T00:00:00</ExpireAt>
      <IsExpired>false</IsExpired>
    </OathToken>
    <OathToken>
      <Platform>MobileToken</Platform>
      <IsPinProtected>true</IsPinProtected>
      <IsDisabled>false</IsDisabled>
      <Name>2015-04-07</Name>
      <Description>2015-04-07 (MobileToken)</Description>
      <LastUsed>2025-09-17T10:08:20.3786662+02:00</LastUsed>
      <CreateTime>0001-01-01T00:00:00</CreateTime>
      <ExpireAt>0001-01-01T00:00:00</ExpireAt>
      <IsExpired>false</IsExpired>
    </OathToken>
    <OathToken>
      <Platform>GoogleTOTP</Platform>
      <IsPinProtected>false</IsPinProtected>
      <IsDisabled>false</IsDisabled>
      <Name>GoogleTOTP</Name>
      <Description>GoogleTOTP (GoogleTOTP)</Description>
      <LastUsed>2013-04-08T10:29:49</LastUsed>
      <CreateTime>0001-01-01T00:00:00</CreateTime>
      <ExpireAt>0001-01-01T00:00:00</ExpireAt>
      <IsExpired>false</IsExpired>
    </OathToken>
  </OathTokens>
  <Devices>
    <Device>
      <State>0</State>
      <DeviceId>androidc1622222222</DeviceId>
      <DeviceType>SonyD5803</DeviceType>
      <UserAgent>SonyD5803/5.0.2-EAS-2.0</UserAgent>
      <CreateTime>2013-04-08T10:33:20</CreateTime>
      <LastOkTime>2015-05-27T09:52:36</LastOkTime>
      <LastErrorTime>0001-01-01T00:00:00</LastErrorTime>
      <TimeoutConf>0</TimeoutConf>
      <TimeoutConfAheadNotification>0</TimeoutConfAheadNotification>
      <Timeout>0001-01-01T00:00:00</Timeout>
      <TimeoutNotificationSent>false</TimeoutNotificationSent>
      <EASSyncKeyPrefix>0</EASSyncKeyPrefix>
    </Device>
    <Device>
      <State>0</State>
      <DeviceId>222B22DC-2D22-2C22-22FD-2CB2C2222EBD</DeviceId>
      <DeviceType>IPhoneLync</DeviceType>
      <UserAgent>iPhoneLync/5.7.517.0000 (iPhone iPhone OS 8.3)</UserAgent>
      <CreateTime>2015-02-09T11:13:28</CreateTime>
      <LastOkTime>2015-05-27T09:52:36</LastOkTime>
      <LastErrorTime>0001-01-01T00:00:00</LastErrorTime>
      <TimeoutConf>0</TimeoutConf>
      <TimeoutConfAheadNotification>0</TimeoutConfAheadNotification>
      <Timeout>0001-01-01T00:00:00</Timeout>
      <TimeoutNotificationSent>false</TimeoutNotificationSent>
      <EASSyncKeyPrefix>0</EASSyncKeyPrefix>
    </Device>
  </Devices>
  <AuthenticationCaches>
    <AuthenticationCache>
      <Method>NTLM</Method>
      <CacheTime>2015-05-10T16:18:55</CacheTime>
      <Counter>2</Counter>
    </AuthenticationCache>
    <AuthenticationCache>
      <Method>PP_OTP_APPENDEND</Method>
      <CacheTime>2015-03-11T09:37:12</CacheTime>
      <Counter>0</Counter>
    </AuthenticationCache>
  </AuthenticationCaches>
  <Passwords>
    <PointSharpPassword>
      <CreateTime>2013-04-08T10:29:49</CreateTime>
      <MustChange>false</MustChange>
      <ResetTime>0001-01-01T00:00:00</ResetTime>
      <PasswordHistoryLength>2</PasswordHistoryLength>
    </PointSharpPassword>
  </Passwords>
  <Attributes />
</User>

GET User/StorageUser?Username={Username}&UserStorageName={UserStorageName}

Retrieves a user from the user storage.The user is not required to be in the Pointsharp ID storage, and neither will it be added by this request.

Request information

Parameters

Name Description Additional information

request

The request data specifying the user to retrieve.

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 retrieved user.

Response body formats

application/json, text/json 
{
  "DistinguishedName": "CN=My User,OU=Users,OU=PointSharp,DC=company,DC=com",
  "IsLocked": false,
  "IsTimeLocked": false,
  "IsDisabled": false,
  "FailedCache": false,
  "CreateTime": "2013-04-08T10:18:16",
  "LastLogin": "2015-05-27T09:52:36",
  "LastFailed": "2015-03-18T06:08:45",
  "EndOfTimeLocked": "0001-01-01T00:00:00",
  "OathTokens": [
    {
      "Platform": "Hardware",
      "IsPinProtected": false,
      "IsDisabled": false,
      "Name": "NS-PS-00000000",
      "Id": null,
      "SerialNumber": null,
      "Description": "NS-PS-00000000 (Hardware)",
      "LastUsed": "2015-05-27T09:52:36",
      "CreateTime": "0001-01-01T00:00:00",
      "ExpireAt": "0001-01-01T00:00:00",
      "IsExpired": false
    },
    {
      "Platform": "MobileToken",
      "IsPinProtected": true,
      "IsDisabled": false,
      "Name": "2015-04-07",
      "Id": null,
      "SerialNumber": null,
      "Description": "2015-04-07 (MobileToken)",
      "LastUsed": "2025-09-17T10:08:20.3786662+02:00",
      "CreateTime": "0001-01-01T00:00:00",
      "ExpireAt": "0001-01-01T00:00:00",
      "IsExpired": false
    },
    {
      "Platform": "GoogleTOTP",
      "IsPinProtected": false,
      "IsDisabled": false,
      "Name": "GoogleTOTP",
      "Id": null,
      "SerialNumber": null,
      "Description": "GoogleTOTP (GoogleTOTP)",
      "LastUsed": "2013-04-08T10:29:49",
      "CreateTime": "0001-01-01T00:00:00",
      "ExpireAt": "0001-01-01T00:00:00",
      "IsExpired": false
    }
  ],
  "FidoTokens": null,
  "Devices": [
    {
      "FriendlyName": null,
      "State": 0,
      "DeviceId": "androidc1622222222",
      "DeviceType": "SonyD5803",
      "UserAgent": "SonyD5803/5.0.2-EAS-2.0",
      "CreateTime": "2013-04-08T10:33:20",
      "LastOkTime": "2015-05-27T09:52:36",
      "LastErrorTime": "0001-01-01T00:00:00",
      "TimeoutConf": 0,
      "TimeoutConfAheadNotification": 0,
      "Timeout": "0001-01-01T00:00:00",
      "TimeoutNotificationSent": false,
      "EASSyncKeyPrefix": 0
    },
    {
      "FriendlyName": null,
      "State": 0,
      "DeviceId": "222B22DC-2D22-2C22-22FD-2CB2C2222EBD",
      "DeviceType": "IPhoneLync",
      "UserAgent": "iPhoneLync/5.7.517.0000 (iPhone iPhone OS 8.3)",
      "CreateTime": "2015-02-09T11:13:28",
      "LastOkTime": "2015-05-27T09:52:36",
      "LastErrorTime": "0001-01-01T00:00:00",
      "TimeoutConf": 0,
      "TimeoutConfAheadNotification": 0,
      "Timeout": "0001-01-01T00:00:00",
      "TimeoutNotificationSent": false,
      "EASSyncKeyPrefix": 0
    }
  ],
  "AuthenticationCaches": [
    {
      "Method": "NTLM",
      "CacheTime": "2015-05-10T16:18:55",
      "Counter": 2
    },
    {
      "Method": "PP_OTP_APPENDEND",
      "CacheTime": "2015-03-11T09:37:12",
      "Counter": 0
    }
  ],
  "Passwords": [
    {
      "CreateTime": "2013-04-08T10:29:49",
      "MustChange": false,
      "ResetTime": "0001-01-01T00:00:00",
      "PasswordHistoryLength": 2
    }
  ],
  "Attributes": [],
  "Mobile": null,
  "Mail": null,
  "Unbound": false,
  "Username": "myUser",
  "UserStorageName": "myUserStorage"
}
application/xml, text/xml 
<?xml version="1.0" encoding="utf-16"?>
<User xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Username>myUser</Username>
  <UserStorageName>myUserStorage</UserStorageName>
  <Unbound>false</Unbound>
  <DistinguishedName>CN=My User,OU=Users,OU=PointSharp,DC=company,DC=com</DistinguishedName>
  <IsLocked>false</IsLocked>
  <IsTimeLocked>false</IsTimeLocked>
  <IsDisabled>false</IsDisabled>
  <FailedCache>false</FailedCache>
  <CreateTime>2013-04-08T10:18:16</CreateTime>
  <LastLogin>2015-05-27T09:52:36</LastLogin>
  <LastFailed>2015-03-18T06:08:45</LastFailed>
  <EndOfTimeLocked>0001-01-01T00:00:00</EndOfTimeLocked>
  <OathTokens>
    <OathToken>
      <Platform>Hardware</Platform>
      <IsPinProtected>false</IsPinProtected>
      <IsDisabled>false</IsDisabled>
      <Name>NS-PS-00000000</Name>
      <Description>NS-PS-00000000 (Hardware)</Description>
      <LastUsed>2015-05-27T09:52:36</LastUsed>
      <CreateTime>0001-01-01T00:00:00</CreateTime>
      <ExpireAt>0001-01-01T00:00:00</ExpireAt>
      <IsExpired>false</IsExpired>
    </OathToken>
    <OathToken>
      <Platform>MobileToken</Platform>
      <IsPinProtected>true</IsPinProtected>
      <IsDisabled>false</IsDisabled>
      <Name>2015-04-07</Name>
      <Description>2015-04-07 (MobileToken)</Description>
      <LastUsed>2025-09-17T10:08:20.3786662+02:00</LastUsed>
      <CreateTime>0001-01-01T00:00:00</CreateTime>
      <ExpireAt>0001-01-01T00:00:00</ExpireAt>
      <IsExpired>false</IsExpired>
    </OathToken>
    <OathToken>
      <Platform>GoogleTOTP</Platform>
      <IsPinProtected>false</IsPinProtected>
      <IsDisabled>false</IsDisabled>
      <Name>GoogleTOTP</Name>
      <Description>GoogleTOTP (GoogleTOTP)</Description>
      <LastUsed>2013-04-08T10:29:49</LastUsed>
      <CreateTime>0001-01-01T00:00:00</CreateTime>
      <ExpireAt>0001-01-01T00:00:00</ExpireAt>
      <IsExpired>false</IsExpired>
    </OathToken>
  </OathTokens>
  <Devices>
    <Device>
      <State>0</State>
      <DeviceId>androidc1622222222</DeviceId>
      <DeviceType>SonyD5803</DeviceType>
      <UserAgent>SonyD5803/5.0.2-EAS-2.0</UserAgent>
      <CreateTime>2013-04-08T10:33:20</CreateTime>
      <LastOkTime>2015-05-27T09:52:36</LastOkTime>
      <LastErrorTime>0001-01-01T00:00:00</LastErrorTime>
      <TimeoutConf>0</TimeoutConf>
      <TimeoutConfAheadNotification>0</TimeoutConfAheadNotification>
      <Timeout>0001-01-01T00:00:00</Timeout>
      <TimeoutNotificationSent>false</TimeoutNotificationSent>
      <EASSyncKeyPrefix>0</EASSyncKeyPrefix>
    </Device>
    <Device>
      <State>0</State>
      <DeviceId>222B22DC-2D22-2C22-22FD-2CB2C2222EBD</DeviceId>
      <DeviceType>IPhoneLync</DeviceType>
      <UserAgent>iPhoneLync/5.7.517.0000 (iPhone iPhone OS 8.3)</UserAgent>
      <CreateTime>2015-02-09T11:13:28</CreateTime>
      <LastOkTime>2015-05-27T09:52:36</LastOkTime>
      <LastErrorTime>0001-01-01T00:00:00</LastErrorTime>
      <TimeoutConf>0</TimeoutConf>
      <TimeoutConfAheadNotification>0</TimeoutConfAheadNotification>
      <Timeout>0001-01-01T00:00:00</Timeout>
      <TimeoutNotificationSent>false</TimeoutNotificationSent>
      <EASSyncKeyPrefix>0</EASSyncKeyPrefix>
    </Device>
  </Devices>
  <AuthenticationCaches>
    <AuthenticationCache>
      <Method>NTLM</Method>
      <CacheTime>2015-05-10T16:18:55</CacheTime>
      <Counter>2</Counter>
    </AuthenticationCache>
    <AuthenticationCache>
      <Method>PP_OTP_APPENDEND</Method>
      <CacheTime>2015-03-11T09:37:12</CacheTime>
      <Counter>0</Counter>
    </AuthenticationCache>
  </AuthenticationCaches>
  <Passwords>
    <PointSharpPassword>
      <CreateTime>2013-04-08T10:29:49</CreateTime>
      <MustChange>false</MustChange>
      <ResetTime>0001-01-01T00:00:00</ResetTime>
      <PasswordHistoryLength>2</PasswordHistoryLength>
    </PointSharpPassword>
  </Passwords>
  <Attributes />
</User>

GET User/Attribute?AttributeName={AttributeName}&Username={Username}&UserStorageName={UserStorageName}

Retrieves a value of a specific Pointsharp ID user’s attribute.The value may be single-valued or multivalued.It will exclude any non-string, or non-SID-data, value.

Request information

Parameters

Name Description Additional information

request

The request data specifying the attribute value to retrieve.

Define this parameter in the request URI.

Parameter information

request

Contains data specifying the attribute of a user to retrieve a value from.

Property Description Additional information

AttributeName (String)

The name of the attribute.

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.

Response information

The value(s) of the requested attribute.

Response body formats

application/json, text/json 
[
  "sample string 1",
  "sample string 2"
]
application/xml, text/xml 
<ArrayOfString xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <string>sample string 1</string>
  <string>sample string 2</string>
</ArrayOfString>

GET User/Attribute/Data?AttributeName={AttributeName}&Username={Username}&UserStorageName={UserStorageName}

Retrieves data of a specific Pointsharp ID user’s attribute.The data may be single-valued or multivalued and of any type.

Request information

Parameters

Name Description Additional information

request

The request data specifying the attribute data to retrieve.

Define this parameter in the request URI.

Parameter information

request

Contains data specifying the attribute of a user to retrieve a value from.

Property Description Additional information

AttributeName (String)

The name of the attribute.

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.

Response information

The value(s) of the requested attribute.

Response body formats

application/json, text/json 
[
  {
    "$type": "System.Object, mscorlib"
  },
  {
    "$type": "System.Object, mscorlib"
  }
]
application/xml, text/xml 
<ArrayOfAnyType xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <anyType />
  <anyType />
</ArrayOfAnyType>

POST User/Attributes

Retrieves data of a specific Pointsharp ID user’s attributes.Each attribute’s data may be single-valued or multivalued and of any type.

Request information

Parameters

Name Description Additional information

request

The request data specifying the attributes data to retrieve.

Define this parameter in the request body.

Parameter information

request

Contains data specifying attributes of a user to retrieve a values from.

Property Description Additional information

AttributeNames (String[])

The name of the attributes.

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 
{
  "AttributeNames": {
    "$type": "System.String[], mscorlib",
    "$values": [
      "sample string 1",
      "sample string 2"
    ]
  },
  "Username": "sample string 1",
  "UserStorageName": "sample string 2"
}
application/xml, text/xml 
<MultipleAttributeValuesRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Username>sample string 1</Username>
  <UserStorageName>sample string 2</UserStorageName>
  <AttributeNames>
    <string>sample string 1</string>
    <string>sample string 2</string>
  </AttributeNames>
</MultipleAttributeValuesRequest>

Response information

The list of attributes with values of the requested attributes.

Response body formats

application/json, text/json 
{
  "sample string 1": {
    "$type": "System.Collections.Generic.List`1[[System.Object, mscorlib]], mscorlib",
    "$values": [
      {
        "$type": "System.Object, mscorlib"
      },
      {
        "$type": "System.Object, mscorlib"
      }
    ]
  },
  "sample string 2": {
    "$type": "System.Collections.Generic.List`1[[System.Object, mscorlib]], mscorlib",
    "$values": [
      {
        "$type": "System.Object, mscorlib"
      },
      {
        "$type": "System.Object, mscorlib"
      }
    ]
  }
}

GET User/Details?Username={Username}&UserStorageName={UserStorageName}

Retrieves the retrievable details about the user specified by the request.

Request information

Parameters

Name Description Additional information

request

The request data specifying the user whose details to retrieve.

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 user’s details.

Response body formats

application/json, text/json 
{
  "FullName": "sample string 1",
  "Email": "sample string 2",
  "Photo": {
    "$type": "System.Byte[], mscorlib",
    "$value": "QEA="
  },
  "Mobile": "sample string 3",
  "LockoutTimeUtc": "2025-09-17T11:13:03.9572809+02:00",
  "IsLockedInDomain": true
}
application/xml, text/xml 
<UserData xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <FullName>sample string 1</FullName>
  <Email>sample string 2</Email>
  <Photo>QEA=</Photo>
  <Mobile>sample string 3</Mobile>
  <LockoutTimeUtc>2025-09-17T11:13:03.9572809+02:00</LockoutTimeUtc>
  <IsLockedInDomain>true</IsLockedInDomain>
</UserData>

POST User

Creates a Pointsharp user to be stored in the Pointsharp ID Storage.

Request information

Parameters

Name Description Additional information

request

The request specifying the user to create.

Define this parameter in the request body.

Parameter information

request

Contains data required to create a user.

Property Description Additional information

Mail (String)

This user’s email address.

This parameter is optional.

Mobile (String)

This user’s mobile phone number.

This parameter is optional.

Unbound (Boolean)

Indicates whether the user is located in the Pointsharp storage only or not.

This parameter is optional.

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 
{
  "Mobile": "sample string 1",
  "Mail": "sample string 2",
  "Unbound": true,
  "Username": "sample string 4",
  "UserStorageName": "sample string 5"
}
application/xml, text/xml 
<CreateUserRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Username>sample string 4</Username>
  <UserStorageName>sample string 5</UserStorageName>
  <Mobile>sample string 1</Mobile>
  <Mail>sample string 2</Mail>
  <Unbound>true</Unbound>
</CreateUserRequest>

Response information

The created user.

Response body formats

application/json, text/json 
{
  "DistinguishedName": "CN=My User,OU=Users,OU=PointSharp,DC=company,DC=com",
  "IsLocked": false,
  "IsTimeLocked": false,
  "IsDisabled": false,
  "FailedCache": false,
  "CreateTime": "2013-04-08T10:18:16",
  "LastLogin": "2015-05-27T09:52:36",
  "LastFailed": "2015-03-18T06:08:45",
  "EndOfTimeLocked": "0001-01-01T00:00:00",
  "OathTokens": [
    {
      "Platform": "Hardware",
      "IsPinProtected": false,
      "IsDisabled": false,
      "Name": "NS-PS-00000000",
      "Id": null,
      "SerialNumber": null,
      "Description": "NS-PS-00000000 (Hardware)",
      "LastUsed": "2015-05-27T09:52:36",
      "CreateTime": "0001-01-01T00:00:00",
      "ExpireAt": "0001-01-01T00:00:00",
      "IsExpired": false
    },
    {
      "Platform": "MobileToken",
      "IsPinProtected": true,
      "IsDisabled": false,
      "Name": "2015-04-07",
      "Id": null,
      "SerialNumber": null,
      "Description": "2015-04-07 (MobileToken)",
      "LastUsed": "2025-09-17T11:00:56.0716583+02:00",
      "CreateTime": "0001-01-01T00:00:00",
      "ExpireAt": "0001-01-01T00:00:00",
      "IsExpired": false
    },
    {
      "Platform": "GoogleTOTP",
      "IsPinProtected": false,
      "IsDisabled": false,
      "Name": "GoogleTOTP",
      "Id": null,
      "SerialNumber": null,
      "Description": "GoogleTOTP (GoogleTOTP)",
      "LastUsed": "2013-04-08T10:29:49",
      "CreateTime": "0001-01-01T00:00:00",
      "ExpireAt": "0001-01-01T00:00:00",
      "IsExpired": false
    }
  ],
  "FidoTokens": null,
  "Devices": [
    {
      "FriendlyName": null,
      "State": 0,
      "DeviceId": "androidc1622222222",
      "DeviceType": "SonyD5803",
      "UserAgent": "SonyD5803/5.0.2-EAS-2.0",
      "CreateTime": "2013-04-08T10:33:20",
      "LastOkTime": "2015-05-27T09:52:36",
      "LastErrorTime": "0001-01-01T00:00:00",
      "TimeoutConf": 0,
      "TimeoutConfAheadNotification": 0,
      "Timeout": "0001-01-01T00:00:00",
      "TimeoutNotificationSent": false,
      "EASSyncKeyPrefix": 0
    },
    {
      "FriendlyName": null,
      "State": 0,
      "DeviceId": "222B22DC-2D22-2C22-22FD-2CB2C2222EBD",
      "DeviceType": "IPhoneLync",
      "UserAgent": "iPhoneLync/5.7.517.0000 (iPhone iPhone OS 8.3)",
      "CreateTime": "2015-02-09T11:13:28",
      "LastOkTime": "2015-05-27T09:52:36",
      "LastErrorTime": "0001-01-01T00:00:00",
      "TimeoutConf": 0,
      "TimeoutConfAheadNotification": 0,
      "Timeout": "0001-01-01T00:00:00",
      "TimeoutNotificationSent": false,
      "EASSyncKeyPrefix": 0
    }
  ],
  "AuthenticationCaches": [
    {
      "Method": "NTLM",
      "CacheTime": "2015-05-10T16:18:55",
      "Counter": 2
    },
    {
      "Method": "PP_OTP_APPENDEND",
      "CacheTime": "2015-03-11T09:37:12",
      "Counter": 0
    }
  ],
  "Passwords": [
    {
      "CreateTime": "2013-04-08T10:29:49",
      "MustChange": false,
      "ResetTime": "0001-01-01T00:00:00",
      "PasswordHistoryLength": 2
    }
  ],
  "Attributes": [],
  "Mobile": null,
  "Mail": null,
  "Unbound": false,
  "Username": "myUser",
  "UserStorageName": "myUserStorage"
}
application/xml, text/xml 
<?xml version="1.0" encoding="utf-16"?>
<User xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Username>myUser</Username>
  <UserStorageName>myUserStorage</UserStorageName>
  <Unbound>false</Unbound>
  <DistinguishedName>CN=My User,OU=Users,OU=PointSharp,DC=company,DC=com</DistinguishedName>
  <IsLocked>false</IsLocked>
  <IsTimeLocked>false</IsTimeLocked>
  <IsDisabled>false</IsDisabled>
  <FailedCache>false</FailedCache>
  <CreateTime>2013-04-08T10:18:16</CreateTime>
  <LastLogin>2015-05-27T09:52:36</LastLogin>
  <LastFailed>2015-03-18T06:08:45</LastFailed>
  <EndOfTimeLocked>0001-01-01T00:00:00</EndOfTimeLocked>
  <OathTokens>
    <OathToken>
      <Platform>Hardware</Platform>
      <IsPinProtected>false</IsPinProtected>
      <IsDisabled>false</IsDisabled>
      <Name>NS-PS-00000000</Name>
      <Description>NS-PS-00000000 (Hardware)</Description>
      <LastUsed>2015-05-27T09:52:36</LastUsed>
      <CreateTime>0001-01-01T00:00:00</CreateTime>
      <ExpireAt>0001-01-01T00:00:00</ExpireAt>
      <IsExpired>false</IsExpired>
    </OathToken>
    <OathToken>
      <Platform>MobileToken</Platform>
      <IsPinProtected>true</IsPinProtected>
      <IsDisabled>false</IsDisabled>
      <Name>2015-04-07</Name>
      <Description>2015-04-07 (MobileToken)</Description>
      <LastUsed>2025-09-17T11:00:56.0716583+02:00</LastUsed>
      <CreateTime>0001-01-01T00:00:00</CreateTime>
      <ExpireAt>0001-01-01T00:00:00</ExpireAt>
      <IsExpired>false</IsExpired>
    </OathToken>
    <OathToken>
      <Platform>GoogleTOTP</Platform>
      <IsPinProtected>false</IsPinProtected>
      <IsDisabled>false</IsDisabled>
      <Name>GoogleTOTP</Name>
      <Description>GoogleTOTP (GoogleTOTP)</Description>
      <LastUsed>2013-04-08T10:29:49</LastUsed>
      <CreateTime>0001-01-01T00:00:00</CreateTime>
      <ExpireAt>0001-01-01T00:00:00</ExpireAt>
      <IsExpired>false</IsExpired>
    </OathToken>
  </OathTokens>
  <Devices>
    <Device>
      <State>0</State>
      <DeviceId>androidc1622222222</DeviceId>
      <DeviceType>SonyD5803</DeviceType>
      <UserAgent>SonyD5803/5.0.2-EAS-2.0</UserAgent>
      <CreateTime>2013-04-08T10:33:20</CreateTime>
      <LastOkTime>2015-05-27T09:52:36</LastOkTime>
      <LastErrorTime>0001-01-01T00:00:00</LastErrorTime>
      <TimeoutConf>0</TimeoutConf>
      <TimeoutConfAheadNotification>0</TimeoutConfAheadNotification>
      <Timeout>0001-01-01T00:00:00</Timeout>
      <TimeoutNotificationSent>false</TimeoutNotificationSent>
      <EASSyncKeyPrefix>0</EASSyncKeyPrefix>
    </Device>
    <Device>
      <State>0</State>
      <DeviceId>222B22DC-2D22-2C22-22FD-2CB2C2222EBD</DeviceId>
      <DeviceType>IPhoneLync</DeviceType>
      <UserAgent>iPhoneLync/5.7.517.0000 (iPhone iPhone OS 8.3)</UserAgent>
      <CreateTime>2015-02-09T11:13:28</CreateTime>
      <LastOkTime>2015-05-27T09:52:36</LastOkTime>
      <LastErrorTime>0001-01-01T00:00:00</LastErrorTime>
      <TimeoutConf>0</TimeoutConf>
      <TimeoutConfAheadNotification>0</TimeoutConfAheadNotification>
      <Timeout>0001-01-01T00:00:00</Timeout>
      <TimeoutNotificationSent>false</TimeoutNotificationSent>
      <EASSyncKeyPrefix>0</EASSyncKeyPrefix>
    </Device>
  </Devices>
  <AuthenticationCaches>
    <AuthenticationCache>
      <Method>NTLM</Method>
      <CacheTime>2015-05-10T16:18:55</CacheTime>
      <Counter>2</Counter>
    </AuthenticationCache>
    <AuthenticationCache>
      <Method>PP_OTP_APPENDEND</Method>
      <CacheTime>2015-03-11T09:37:12</CacheTime>
      <Counter>0</Counter>
    </AuthenticationCache>
  </AuthenticationCaches>
  <Passwords>
    <PointSharpPassword>
      <CreateTime>2013-04-08T10:29:49</CreateTime>
      <MustChange>false</MustChange>
      <ResetTime>0001-01-01T00:00:00</ResetTime>
      <PasswordHistoryLength>2</PasswordHistoryLength>
    </PointSharpPassword>
  </Passwords>
  <Attributes />
</User>

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

Retrieves a user from the Pointsharp ID storage.

Request information

Parameters

Name Description Additional information

request

The request data specifying the user to retrieve.

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 requested user.

Response body formats

application/json, text/json 
{
  "DistinguishedName": "CN=My User,OU=Users,OU=PointSharp,DC=company,DC=com",
  "IsLocked": false,
  "IsTimeLocked": false,
  "IsDisabled": false,
  "FailedCache": false,
  "CreateTime": "2013-04-08T10:18:16",
  "LastLogin": "2015-05-27T09:52:36",
  "LastFailed": "2015-03-18T06:08:45",
  "EndOfTimeLocked": "0001-01-01T00:00:00",
  "OathTokens": [
    {
      "Platform": "Hardware",
      "IsPinProtected": false,
      "IsDisabled": false,
      "Name": "NS-PS-00000000",
      "Id": null,
      "SerialNumber": null,
      "Description": "NS-PS-00000000 (Hardware)",
      "LastUsed": "2015-05-27T09:52:36",
      "CreateTime": "0001-01-01T00:00:00",
      "ExpireAt": "0001-01-01T00:00:00",
      "IsExpired": false
    },
    {
      "Platform": "MobileToken",
      "IsPinProtected": true,
      "IsDisabled": false,
      "Name": "2015-04-07",
      "Id": null,
      "SerialNumber": null,
      "Description": "2015-04-07 (MobileToken)",
      "LastUsed": "2025-09-17T11:00:56.0716583+02:00",
      "CreateTime": "0001-01-01T00:00:00",
      "ExpireAt": "0001-01-01T00:00:00",
      "IsExpired": false
    },
    {
      "Platform": "GoogleTOTP",
      "IsPinProtected": false,
      "IsDisabled": false,
      "Name": "GoogleTOTP",
      "Id": null,
      "SerialNumber": null,
      "Description": "GoogleTOTP (GoogleTOTP)",
      "LastUsed": "2013-04-08T10:29:49",
      "CreateTime": "0001-01-01T00:00:00",
      "ExpireAt": "0001-01-01T00:00:00",
      "IsExpired": false
    }
  ],
  "FidoTokens": null,
  "Devices": [
    {
      "FriendlyName": null,
      "State": 0,
      "DeviceId": "androidc1622222222",
      "DeviceType": "SonyD5803",
      "UserAgent": "SonyD5803/5.0.2-EAS-2.0",
      "CreateTime": "2013-04-08T10:33:20",
      "LastOkTime": "2015-05-27T09:52:36",
      "LastErrorTime": "0001-01-01T00:00:00",
      "TimeoutConf": 0,
      "TimeoutConfAheadNotification": 0,
      "Timeout": "0001-01-01T00:00:00",
      "TimeoutNotificationSent": false,
      "EASSyncKeyPrefix": 0
    },
    {
      "FriendlyName": null,
      "State": 0,
      "DeviceId": "222B22DC-2D22-2C22-22FD-2CB2C2222EBD",
      "DeviceType": "IPhoneLync",
      "UserAgent": "iPhoneLync/5.7.517.0000 (iPhone iPhone OS 8.3)",
      "CreateTime": "2015-02-09T11:13:28",
      "LastOkTime": "2015-05-27T09:52:36",
      "LastErrorTime": "0001-01-01T00:00:00",
      "TimeoutConf": 0,
      "TimeoutConfAheadNotification": 0,
      "Timeout": "0001-01-01T00:00:00",
      "TimeoutNotificationSent": false,
      "EASSyncKeyPrefix": 0
    }
  ],
  "AuthenticationCaches": [
    {
      "Method": "NTLM",
      "CacheTime": "2015-05-10T16:18:55",
      "Counter": 2
    },
    {
      "Method": "PP_OTP_APPENDEND",
      "CacheTime": "2015-03-11T09:37:12",
      "Counter": 0
    }
  ],
  "Passwords": [
    {
      "CreateTime": "2013-04-08T10:29:49",
      "MustChange": false,
      "ResetTime": "0001-01-01T00:00:00",
      "PasswordHistoryLength": 2
    }
  ],
  "Attributes": [],
  "Mobile": null,
  "Mail": null,
  "Unbound": false,
  "Username": "myUser",
  "UserStorageName": "myUserStorage"
}
application/xml, text/xml 
<?xml version="1.0" encoding="utf-16"?>
<User xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Username>myUser</Username>
  <UserStorageName>myUserStorage</UserStorageName>
  <Unbound>false</Unbound>
  <DistinguishedName>CN=My User,OU=Users,OU=PointSharp,DC=company,DC=com</DistinguishedName>
  <IsLocked>false</IsLocked>
  <IsTimeLocked>false</IsTimeLocked>
  <IsDisabled>false</IsDisabled>
  <FailedCache>false</FailedCache>
  <CreateTime>2013-04-08T10:18:16</CreateTime>
  <LastLogin>2015-05-27T09:52:36</LastLogin>
  <LastFailed>2015-03-18T06:08:45</LastFailed>
  <EndOfTimeLocked>0001-01-01T00:00:00</EndOfTimeLocked>
  <OathTokens>
    <OathToken>
      <Platform>Hardware</Platform>
      <IsPinProtected>false</IsPinProtected>
      <IsDisabled>false</IsDisabled>
      <Name>NS-PS-00000000</Name>
      <Description>NS-PS-00000000 (Hardware)</Description>
      <LastUsed>2015-05-27T09:52:36</LastUsed>
      <CreateTime>0001-01-01T00:00:00</CreateTime>
      <ExpireAt>0001-01-01T00:00:00</ExpireAt>
      <IsExpired>false</IsExpired>
    </OathToken>
    <OathToken>
      <Platform>MobileToken</Platform>
      <IsPinProtected>true</IsPinProtected>
      <IsDisabled>false</IsDisabled>
      <Name>2015-04-07</Name>
      <Description>2015-04-07 (MobileToken)</Description>
      <LastUsed>2025-09-17T11:00:56.0716583+02:00</LastUsed>
      <CreateTime>0001-01-01T00:00:00</CreateTime>
      <ExpireAt>0001-01-01T00:00:00</ExpireAt>
      <IsExpired>false</IsExpired>
    </OathToken>
    <OathToken>
      <Platform>GoogleTOTP</Platform>
      <IsPinProtected>false</IsPinProtected>
      <IsDisabled>false</IsDisabled>
      <Name>GoogleTOTP</Name>
      <Description>GoogleTOTP (GoogleTOTP)</Description>
      <LastUsed>2013-04-08T10:29:49</LastUsed>
      <CreateTime>0001-01-01T00:00:00</CreateTime>
      <ExpireAt>0001-01-01T00:00:00</ExpireAt>
      <IsExpired>false</IsExpired>
    </OathToken>
  </OathTokens>
  <Devices>
    <Device>
      <State>0</State>
      <DeviceId>androidc1622222222</DeviceId>
      <DeviceType>SonyD5803</DeviceType>
      <UserAgent>SonyD5803/5.0.2-EAS-2.0</UserAgent>
      <CreateTime>2013-04-08T10:33:20</CreateTime>
      <LastOkTime>2015-05-27T09:52:36</LastOkTime>
      <LastErrorTime>0001-01-01T00:00:00</LastErrorTime>
      <TimeoutConf>0</TimeoutConf>
      <TimeoutConfAheadNotification>0</TimeoutConfAheadNotification>
      <Timeout>0001-01-01T00:00:00</Timeout>
      <TimeoutNotificationSent>false</TimeoutNotificationSent>
      <EASSyncKeyPrefix>0</EASSyncKeyPrefix>
    </Device>
    <Device>
      <State>0</State>
      <DeviceId>222B22DC-2D22-2C22-22FD-2CB2C2222EBD</DeviceId>
      <DeviceType>IPhoneLync</DeviceType>
      <UserAgent>iPhoneLync/5.7.517.0000 (iPhone iPhone OS 8.3)</UserAgent>
      <CreateTime>2015-02-09T11:13:28</CreateTime>
      <LastOkTime>2015-05-27T09:52:36</LastOkTime>
      <LastErrorTime>0001-01-01T00:00:00</LastErrorTime>
      <TimeoutConf>0</TimeoutConf>
      <TimeoutConfAheadNotification>0</TimeoutConfAheadNotification>
      <Timeout>0001-01-01T00:00:00</Timeout>
      <TimeoutNotificationSent>false</TimeoutNotificationSent>
      <EASSyncKeyPrefix>0</EASSyncKeyPrefix>
    </Device>
  </Devices>
  <AuthenticationCaches>
    <AuthenticationCache>
      <Method>NTLM</Method>
      <CacheTime>2015-05-10T16:18:55</CacheTime>
      <Counter>2</Counter>
    </AuthenticationCache>
    <AuthenticationCache>
      <Method>PP_OTP_APPENDEND</Method>
      <CacheTime>2015-03-11T09:37:12</CacheTime>
      <Counter>0</Counter>
    </AuthenticationCache>
  </AuthenticationCaches>
  <Passwords>
    <PointSharpPassword>
      <CreateTime>2013-04-08T10:29:49</CreateTime>
      <MustChange>false</MustChange>
      <ResetTime>0001-01-01T00:00:00</ResetTime>
      <PasswordHistoryLength>2</PasswordHistoryLength>
    </PointSharpPassword>
  </Passwords>
  <Attributes />
</User>

PUT User

Updates a user in the Pointsharp ID storage.

Request information

Parameters

Name Description Additional information

user

The user to update storage with.

Define this parameter in the request body.

Parameter information

user

Contains data specifying a user account.

Property Description Additional information

Attributes (List`1)

User’s attribute list.

This parameter is optional.

AuthenticationCaches (AuthenticationCache[])

The authentication cache entries for this user.

This parameter is optional.

CreateTime (DateTime)

The time when the user account was created.

This parameter is optional.

Devices (Device[])

The ActiveSync devices associated with this user.

This parameter is optional.

DistinguishedName (String)

The distinguished name (DN)

This parameter is optional.

EndOfTimeLocked (DateTime)

If the user is time locked then it will show the time when the user ends being locked.

This parameter is optional.

FailedCache (Boolean)

Indicates whether the user’s failed authentication attempts is removed from the cache or not.

This parameter is optional.

FidoTokens (OathToken[])

The list of FIDO tokens associated to this user.

This parameter is optional.

IsDisabled (Boolean)

Indicates whether the user is disabled or not.

This parameter is optional.

IsLocked (Boolean)

Indicates whether the user is locked or not.

This parameter is optional.

IsTimeLocked (Boolean)

Indicates whether the user is time-locked or not.

This parameter is optional.

LastFailed (DateTime)

The time of the last failed authentication attempt.

This parameter is optional.

LastLogin (DateTime)

The time of the last successful login.

This parameter is optional.

Mail (String)

This user’s email address.

This parameter is optional.

Mobile (String)

This user’s mobile phone number.

This parameter is optional.

OathTokens (OathToken[])

The list of OATH tokens associated to this user.

This parameter is optional.

Passwords (PointSharpPassword[])

This user’s Pointsharp Passwords.

This parameter is optional.

Unbound (Boolean)

Indicates whether the user is located in the Pointsharp storage only or not.

This parameter is optional.

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 
{
  "DistinguishedName": "CN=My User,OU=Users,OU=PointSharp,DC=company,DC=com",
  "IsLocked": false,
  "IsTimeLocked": false,
  "IsDisabled": false,
  "FailedCache": false,
  "CreateTime": "2013-04-08T10:18:16",
  "LastLogin": "2015-05-27T09:52:36",
  "LastFailed": "2015-03-18T06:08:45",
  "EndOfTimeLocked": "0001-01-01T00:00:00",
  "OathTokens": [
    {
      "Platform": "Hardware",
      "IsPinProtected": false,
      "IsDisabled": false,
      "Name": "NS-PS-00000000",
      "Id": null,
      "SerialNumber": null,
      "Description": "NS-PS-00000000 (Hardware)",
      "LastUsed": "2015-05-27T09:52:36",
      "CreateTime": "0001-01-01T00:00:00",
      "ExpireAt": "0001-01-01T00:00:00",
      "IsExpired": false
    },
    {
      "Platform": "MobileToken",
      "IsPinProtected": true,
      "IsDisabled": false,
      "Name": "2015-04-07",
      "Id": null,
      "SerialNumber": null,
      "Description": "2015-04-07 (MobileToken)",
      "LastUsed": "2025-09-17T13:31:21.3686609+02:00",
      "CreateTime": "0001-01-01T00:00:00",
      "ExpireAt": "0001-01-01T00:00:00",
      "IsExpired": false
    },
    {
      "Platform": "GoogleTOTP",
      "IsPinProtected": false,
      "IsDisabled": false,
      "Name": "GoogleTOTP",
      "Id": null,
      "SerialNumber": null,
      "Description": "GoogleTOTP (GoogleTOTP)",
      "LastUsed": "2013-04-08T10:29:49",
      "CreateTime": "0001-01-01T00:00:00",
      "ExpireAt": "0001-01-01T00:00:00",
      "IsExpired": false
    }
  ],
  "FidoTokens": null,
  "Devices": [
    {
      "FriendlyName": null,
      "State": 0,
      "DeviceId": "androidc1622222222",
      "DeviceType": "SonyD5803",
      "UserAgent": "SonyD5803/5.0.2-EAS-2.0",
      "CreateTime": "2013-04-08T10:33:20",
      "LastOkTime": "2015-05-27T09:52:36",
      "LastErrorTime": "0001-01-01T00:00:00",
      "TimeoutConf": 0,
      "TimeoutConfAheadNotification": 0,
      "Timeout": "0001-01-01T00:00:00",
      "TimeoutNotificationSent": false,
      "EASSyncKeyPrefix": 0
    },
    {
      "FriendlyName": null,
      "State": 0,
      "DeviceId": "222B22DC-2D22-2C22-22FD-2CB2C2222EBD",
      "DeviceType": "IPhoneLync",
      "UserAgent": "iPhoneLync/5.7.517.0000 (iPhone iPhone OS 8.3)",
      "CreateTime": "2015-02-09T11:13:28",
      "LastOkTime": "2015-05-27T09:52:36",
      "LastErrorTime": "0001-01-01T00:00:00",
      "TimeoutConf": 0,
      "TimeoutConfAheadNotification": 0,
      "Timeout": "0001-01-01T00:00:00",
      "TimeoutNotificationSent": false,
      "EASSyncKeyPrefix": 0
    }
  ],
  "AuthenticationCaches": [
    {
      "Method": "NTLM",
      "CacheTime": "2015-05-10T16:18:55",
      "Counter": 2
    },
    {
      "Method": "PP_OTP_APPENDEND",
      "CacheTime": "2015-03-11T09:37:12",
      "Counter": 0
    }
  ],
  "Passwords": [
    {
      "CreateTime": "2013-04-08T10:29:49",
      "MustChange": false,
      "ResetTime": "0001-01-01T00:00:00",
      "PasswordHistoryLength": 2
    }
  ],
  "Attributes": [],
  "Mobile": null,
  "Mail": null,
  "Unbound": false,
  "Username": "myUser",
  "UserStorageName": "myUserStorage"
}
application/xml, text/xml 
<?xml version="1.0" encoding="utf-16"?>
<User xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Username>myUser</Username>
  <UserStorageName>myUserStorage</UserStorageName>
  <Unbound>false</Unbound>
  <DistinguishedName>CN=My User,OU=Users,OU=PointSharp,DC=company,DC=com</DistinguishedName>
  <IsLocked>false</IsLocked>
  <IsTimeLocked>false</IsTimeLocked>
  <IsDisabled>false</IsDisabled>
  <FailedCache>false</FailedCache>
  <CreateTime>2013-04-08T10:18:16</CreateTime>
  <LastLogin>2015-05-27T09:52:36</LastLogin>
  <LastFailed>2015-03-18T06:08:45</LastFailed>
  <EndOfTimeLocked>0001-01-01T00:00:00</EndOfTimeLocked>
  <OathTokens>
    <OathToken>
      <Platform>Hardware</Platform>
      <IsPinProtected>false</IsPinProtected>
      <IsDisabled>false</IsDisabled>
      <Name>NS-PS-00000000</Name>
      <Description>NS-PS-00000000 (Hardware)</Description>
      <LastUsed>2015-05-27T09:52:36</LastUsed>
      <CreateTime>0001-01-01T00:00:00</CreateTime>
      <ExpireAt>0001-01-01T00:00:00</ExpireAt>
      <IsExpired>false</IsExpired>
    </OathToken>
    <OathToken>
      <Platform>MobileToken</Platform>
      <IsPinProtected>true</IsPinProtected>
      <IsDisabled>false</IsDisabled>
      <Name>2015-04-07</Name>
      <Description>2015-04-07 (MobileToken)</Description>
      <LastUsed>2025-09-17T13:31:21.3686609+02:00</LastUsed>
      <CreateTime>0001-01-01T00:00:00</CreateTime>
      <ExpireAt>0001-01-01T00:00:00</ExpireAt>
      <IsExpired>false</IsExpired>
    </OathToken>
    <OathToken>
      <Platform>GoogleTOTP</Platform>
      <IsPinProtected>false</IsPinProtected>
      <IsDisabled>false</IsDisabled>
      <Name>GoogleTOTP</Name>
      <Description>GoogleTOTP (GoogleTOTP)</Description>
      <LastUsed>2013-04-08T10:29:49</LastUsed>
      <CreateTime>0001-01-01T00:00:00</CreateTime>
      <ExpireAt>0001-01-01T00:00:00</ExpireAt>
      <IsExpired>false</IsExpired>
    </OathToken>
  </OathTokens>
  <Devices>
    <Device>
      <State>0</State>
      <DeviceId>androidc1622222222</DeviceId>
      <DeviceType>SonyD5803</DeviceType>
      <UserAgent>SonyD5803/5.0.2-EAS-2.0</UserAgent>
      <CreateTime>2013-04-08T10:33:20</CreateTime>
      <LastOkTime>2015-05-27T09:52:36</LastOkTime>
      <LastErrorTime>0001-01-01T00:00:00</LastErrorTime>
      <TimeoutConf>0</TimeoutConf>
      <TimeoutConfAheadNotification>0</TimeoutConfAheadNotification>
      <Timeout>0001-01-01T00:00:00</Timeout>
      <TimeoutNotificationSent>false</TimeoutNotificationSent>
      <EASSyncKeyPrefix>0</EASSyncKeyPrefix>
    </Device>
    <Device>
      <State>0</State>
      <DeviceId>222B22DC-2D22-2C22-22FD-2CB2C2222EBD</DeviceId>
      <DeviceType>IPhoneLync</DeviceType>
      <UserAgent>iPhoneLync/5.7.517.0000 (iPhone iPhone OS 8.3)</UserAgent>
      <CreateTime>2015-02-09T11:13:28</CreateTime>
      <LastOkTime>2015-05-27T09:52:36</LastOkTime>
      <LastErrorTime>0001-01-01T00:00:00</LastErrorTime>
      <TimeoutConf>0</TimeoutConf>
      <TimeoutConfAheadNotification>0</TimeoutConfAheadNotification>
      <Timeout>0001-01-01T00:00:00</Timeout>
      <TimeoutNotificationSent>false</TimeoutNotificationSent>
      <EASSyncKeyPrefix>0</EASSyncKeyPrefix>
    </Device>
  </Devices>
  <AuthenticationCaches>
    <AuthenticationCache>
      <Method>NTLM</Method>
      <CacheTime>2015-05-10T16:18:55</CacheTime>
      <Counter>2</Counter>
    </AuthenticationCache>
    <AuthenticationCache>
      <Method>PP_OTP_APPENDEND</Method>
      <CacheTime>2015-03-11T09:37:12</CacheTime>
      <Counter>0</Counter>
    </AuthenticationCache>
  </AuthenticationCaches>
  <Passwords>
    <PointSharpPassword>
      <CreateTime>2013-04-08T10:29:49</CreateTime>
      <MustChange>false</MustChange>
      <ResetTime>0001-01-01T00:00:00</ResetTime>
      <PasswordHistoryLength>2</PasswordHistoryLength>
    </PointSharpPassword>
  </Passwords>
  <Attributes />
</User>

DELETE User?Username={Username}&UserStorageName={UserStorageName}

Removes a user from the Pointsharp ID storage.

Request information

Parameters

Name Description Additional information

request

The request data specifying the user to delete.

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.