Cyan Web API - Version 1

GET api/messageBodies/login

            Gets an example of the message body format for a "Login" message.

Response Information

Response body formats

application/json, text/json

Sample:

{
  "isExternal": true,
  "userName": "sample string 2",
  "password": "sample string 3",
  "userId": "e4f1c290-fb18-45a5-8c45-48ada26d96b7",
  "userGroupId": "8fdaea15-a688-4fe6-a2a0-7ab95611bad7",
  "tenantId": "1f3df130-10cf-4160-9116-66683b028164",
  "tenantAccessKey": "sample string 4",
  "requestData": "sample string 5",
  "responseData": "sample string 6",
  "roles": [
    "sample string 1",
    "sample string 2",
    "sample string 3"
  ]
}

application/xml, text/xml

Sample:

<LoginMessageBody xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BlueDot.Cyan.Server.Core.Models.Messaging">
  <IsExternal>true</IsExternal>
  <Password>sample string 3</Password>
  <RequestData>sample string 5</RequestData>
  <ResponseData>sample string 6</ResponseData>
  <Roles xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
    <d2p1:string>sample string 3</d2p1:string>
  </Roles>
  <TenantAccessKey>sample string 4</TenantAccessKey>
  <TenantId>1f3df130-10cf-4160-9116-66683b028164</TenantId>
  <UserGroupId>8fdaea15-a688-4fe6-a2a0-7ab95611bad7</UserGroupId>
  <UserId>e4f1c290-fb18-45a5-8c45-48ada26d96b7</UserId>
  <UserName>sample string 2</UserName>
</LoginMessageBody>