User Profile service

A REST API towards the Pointsharp ID to retrieve Pointsharp User Profiles used for Autodiscover and Device Portal.

API Description

POST UserProfile

Creates a new device window for a user if allowed by the Pointsharp ID configuration, and retrieves a Pointsharp User Profile specified by the request.

POST UserProfile

Creates a new device window for a user if allowed by the Pointsharp ID configuration, and retrieves a Pointsharp User Profile specified by the request.

Request information

Parameters

Name Description Additional information

request

The request data specifying the Pointsharp User Profile to retrieve.

Define this parameter in the request body.

Parameter information

request

Contains data specifying a Pointsharp User Profile to retrieve.

Property Description Additional information

CreatePointSharpPassword (Boolean)

Indicates whether the requested user profile should create and contain a Pointsharp Password or not (will fail if old Pointsharp Password exists).

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 
{
  "CreatePointSharpPassword": true,
  "Username": "sample string 2",
  "UserStorageName": "sample string 3"
}
application/xml, text/xml 
<UserProfileRequest 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>
  <CreatePointSharpPassword>true</CreatePointSharpPassword>
</UserProfileRequest>

Response information

A Pointsharp User Profile.

Response body formats

application/json, text/json 
{
  "Password": "sample string 1",
  "CacheExpirationTime": 2,
  "Attributes": {
    "$type": "System.Collections.Generic.List`1[[System.Collections.Generic.KeyValuePair`2[[System.String, mscorlib],[System.String, mscorlib]], mscorlib]], mscorlib",
    "$values": [
      {
        "Key": "sample string 1",
        "Value": "sample string 2"
      },
      {
        "Key": "sample string 1",
        "Value": "sample string 2"
      }
    ]
  },
  "Username": "sample string 3",
  "UserStorageName": "sample string 4"
}