POST api/v1/VisualReports/Login/PostLoginForSAML2User?tenantName={tenantName}&udid={udid}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
tenantName

string

Required

udid

string

Required

version

string

None.

Body Parameters

User
NameDescriptionTypeAdditional information
ID

integer

None.

FirstName

string

None.

Password

string

None.

OldPassword

string

None.

LastName

string

None.

MiddleName

string

None.

Zip

string

None.

LoginId

string

None.

PhoneNo

string

None.

EmailId

string

None.

OldEmailId

string

None.

Address1

string

None.

Address2

string

None.

ProfileImageUrl

string

None.

TotalCreditsEarned

decimal number

None.

TotalCourseCompleted

integer

None.

CityId

integer

None.

Isactive

boolean

None.

ManagerEmailID

string

None.

GenderId

integer

None.

Device

string

None.

ClassesCompleted

integer

None.

Credits

integer

None.

Gender

string

None.

City

string

None.

Store

Collection of Store

None.

Category

Collection of ProductCategory

None.

TenantFeatures

Collection of FeatureTenant

None.

AssociatedRoles

Collection of Role

None.

CountryId

integer

None.

CountryName

string

None.

StateId

integer

None.

StateName

string

None.

Action

string

None.

UserGroups

Collection of UserGroupModel

None.

IsSuperAdmin

integer

None.

DataSource

DataSource

None.

AccountEnabled

boolean

None.

DisplayName

string

None.

JobTitle

string

None.

PreferredLanguage

string

None.

TelephoneNumber

string

None.

Source

string

None.

SourceId

string

None.

ImportType

string

None.

IsSAMLUser

boolean

None.

IsHybridUser

boolean

None.

IsHybridCustom

boolean

None.

PwCreatedOn

date

None.

IsResetRequired

boolean

None.

UserScore

Object

None.

IsBBICUser

boolean

None.

ImageData

string

None.

ContentType

string

None.

IsLocked

boolean

None.

IsPrivacyPolicyAccepted

boolean

None.

Request Formats

application/json

Sample:

Sample not available.

text/json

Sample:

Sample not available.

text/html

Sample:

Sample not available.

text/xml

Sample:

Sample not available.

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Token
NameDescriptionTypeAdditional information
TokenValue

string

None.

ContainerName

string

None.

IsResetRequired

boolean

None.

HasOnBoarded

boolean

None.

EncryptionKey

string

None.

PGHuburl

string

None.

PGMobileappInsightsKey

string

None.

PGGdprlink

string

None.

PrivacyPolicyInfo

PrivacyPolicy

None.

Response Formats

application/json, text/json

Sample:
{
  "TokenValue": "sample string 1",
  "ContainerName": "sample string 2",
  "IsResetRequired": true,
  "HasOnBoarded": true,
  "EncryptionKey": "sample string 5",
  "PGHuburl": "sample string 6",
  "PGMobileappInsightsKey": "sample string 7",
  "PGGdprlink": "sample string 8",
  "PrivacyPolicyInfo": {
    "IsProductPrivacyEnable": true,
    "IsPrivacyPolicy": true,
    "PolicyUrl": "sample string 3"
  }
}

text/html

Sample:
{"TokenValue":"sample string 1","ContainerName":"sample string 2","IsResetRequired":true,"HasOnBoarded":true,"EncryptionKey":"sample string 5","PGHuburl":"sample string 6","PGMobileappInsightsKey":"sample string 7","PGGdprlink":"sample string 8","PrivacyPolicyInfo":{"IsProductPrivacyEnable":true,"IsPrivacyPolicy":true,"PolicyUrl":"sample string 3"}}

text/xml

Sample:
<Token xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ShotClassCore.Models">
  <ContainerName>sample string 2</ContainerName>
  <EncryptionKey>sample string 5</EncryptionKey>
  <HasOnBoarded>true</HasOnBoarded>
  <IsResetRequired>true</IsResetRequired>
  <PGGdprlink>sample string 8</PGGdprlink>
  <PGHuburl>sample string 6</PGHuburl>
  <PGMobileappInsightsKey>sample string 7</PGMobileappInsightsKey>
  <PrivacyPolicyInfo>
    <IsPrivacyPolicy>true</IsPrivacyPolicy>
    <IsProductPrivacyEnable>true</IsProductPrivacyEnable>
    <PolicyUrl>sample string 3</PolicyUrl>
  </PrivacyPolicyInfo>
  <TokenValue>sample string 1</TokenValue>
</Token>