digitaluapi

<back to all web services

UserAuthDetailEdit

Requires Authentication
Requires any of the roles:Client, Admin, Partner
The following routes are available for this service:
PUT/user_auth_detail/{Id}
UserAuthDetailEdit Parameters:
NameParameterData TypeRequiredDescription
IdpathintYes
UserAuthIdbodyintYes
ProviderbodystringNo
UserIdbodystringNo
UserNamebodystringNo
FullNamebodystringNo
DisplayNamebodystringNo
FirstNamebodystringNo
LastNamebodystringNo
CompanybodystringNo
EmailbodystringNo
PhoneNumberbodystringNo
BirthDatebodyDateTimeOffset?No
BirthDateRawbodystringNo
AddressbodystringNo
Address2bodystringNo
CitybodystringNo
StatebodystringNo
CountrybodystringNo
CulturebodystringNo
GenderbodystringNo
LanguagebodystringNo
MailAddressbodystringNo
NickNamebodystringNo
PostalCodebodystringNo
TimeZonebodystringNo
RefreshTokenbodystringNo
RefreshTokenExpirybodyDateTimeOffset?No
RequestTokenbodystringNo
RequestTokenSecretbodystringNo
ItemsbodystringNo
AccessTokenbodystringNo
AccessTokenSecretbodystringNo
CreatedDatebodyDateTimeOffsetYes
ModifiedDatebodyDateTimeOffsetYes
RefIdbodyint?No
RefIdStrbodystringNo
MetabodystringNo
UserAuthDetailEditResponse Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
UserAuthIdformintNo
ProviderformstringNo
UserIdformstringNo
UserNameformstringNo
FullNameformstringNo
DisplayNameformstringNo
FirstNameformstringNo
LastNameformstringNo
CompanyformstringNo
EmailformstringNo
PhoneNumberformstringNo
BirthDateformDateTimeOffset?No
BirthDateRawformstringNo
AddressformstringNo
Address2formstringNo
CityformstringNo
StateformstringNo
CountryformstringNo
CultureformstringNo
GenderformstringNo
LanguageformstringNo
MailAddressformstringNo
NickNameformstringNo
PostalCodeformstringNo
TimeZoneformstringNo
RefreshTokenformstringNo
RefreshTokenExpiryformDateTimeOffset?No
RequestTokenformstringNo
RequestTokenSecretformstringNo
ItemsformstringNo
AccessTokenformstringNo
AccessTokenSecretformstringNo
CreatedDateformDateTimeOffsetNo
ModifiedDateformDateTimeOffsetNo
RefIdformint?No
RefIdStrformstringNo
MetaformstringNo
ResponseStatusformResponseStatusNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

PUT /user_auth_detail/{Id} HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<UserAuthDetailEdit xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel">
  <Id>0</Id>
  <UserAuthId>0</UserAuthId>
  <Provider>String</Provider>
  <UserId>String</UserId>
  <UserName>String</UserName>
  <FullName>String</FullName>
  <DisplayName>String</DisplayName>
  <FirstName>String</FirstName>
  <LastName>String</LastName>
  <Company>String</Company>
  <Email>String</Email>
  <PhoneNumber>String</PhoneNumber>
  <BirthDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>0001-01-01T00:00:00Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
  </BirthDate>
  <BirthDateRaw>String</BirthDateRaw>
  <Address>String</Address>
  <Address2>String</Address2>
  <City>String</City>
  <State>String</State>
  <Country>String</Country>
  <Culture>String</Culture>
  <Gender>String</Gender>
  <Language>String</Language>
  <MailAddress>String</MailAddress>
  <NickName>String</NickName>
  <PostalCode>String</PostalCode>
  <TimeZone>String</TimeZone>
  <RefreshToken>String</RefreshToken>
  <RefreshTokenExpiry xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>0001-01-01T00:00:00Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
  </RefreshTokenExpiry>
  <RequestToken>String</RequestToken>
  <RequestTokenSecret>String</RequestTokenSecret>
  <Items>String</Items>
  <AccessToken>String</AccessToken>
  <AccessTokenSecret>String</AccessTokenSecret>
  <CreatedDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>0001-01-01T00:00:00Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
  </CreatedDate>
  <ModifiedDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>0001-01-01T00:00:00Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
  </ModifiedDate>
  <RefId>0</RefId>
  <RefIdStr>String</RefIdStr>
  <Meta>String</Meta>
</UserAuthDetailEdit>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<UserAuthDetailEditResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel">
  <AccessToken>String</AccessToken>
  <AccessTokenSecret>String</AccessTokenSecret>
  <Address>String</Address>
  <Address2>String</Address2>
  <BirthDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>0001-01-01T00:00:00Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
  </BirthDate>
  <BirthDateRaw>String</BirthDateRaw>
  <City>String</City>
  <Company>String</Company>
  <Country>String</Country>
  <CreatedDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>0001-01-01T00:00:00Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
  </CreatedDate>
  <Culture>String</Culture>
  <DisplayName>String</DisplayName>
  <Email>String</Email>
  <FirstName>String</FirstName>
  <FullName>String</FullName>
  <Gender>String</Gender>
  <Id>0</Id>
  <Items>String</Items>
  <Language>String</Language>
  <LastName>String</LastName>
  <MailAddress>String</MailAddress>
  <Meta>String</Meta>
  <ModifiedDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>0001-01-01T00:00:00Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
  </ModifiedDate>
  <NickName>String</NickName>
  <PhoneNumber>String</PhoneNumber>
  <PostalCode>String</PostalCode>
  <Provider>String</Provider>
  <RefId>0</RefId>
  <RefIdStr>String</RefIdStr>
  <RefreshToken>String</RefreshToken>
  <RefreshTokenExpiry xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>0001-01-01T00:00:00Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
  </RefreshTokenExpiry>
  <RequestToken>String</RequestToken>
  <RequestTokenSecret>String</RequestTokenSecret>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <State>String</State>
  <TimeZone>String</TimeZone>
  <UserAuthId>0</UserAuthId>
  <UserId>String</UserId>
  <UserName>String</UserName>
</UserAuthDetailEditResponse>