POST oauth/refresh

Request Information

URI Parameters

None.

Body Parameters

AuthorizeInput
NameDescriptionTypeAdditional information
ClientID

string

None.
AccessKey

string

None.

Request Formats

application/json, text/json

Sample: 
{
  "ClientID": "sample string 1",
  "AccessKey": "sample string 2"
}

application/xml, text/xml

Sample: 
<AuthorizeInput xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Scarlett.V2.API.DataModels.Services.Auth.ServiceUser">
  <AccessKey>sample string 2</AccessKey>
  <ClientID>sample string 1</ClientID>
</AuthorizeInput>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'AuthorizeInput'.

Response Information

Resource Description

AuthorizeOutput
NameDescriptionTypeAdditional information
UserSession

UserSessionModel

None.
AccessToken

string

None.
ReturnStatus

ReturnStatusModel

None.

Response Formats

application/json, text/json

Sample: 
{
  "UserSession": {
    "SocialMediaAccountID": 1,
    "IsServiceUser": true,
    "IsPrivateLender": true,
    "LoginAsFlag": true,
    "TwoFactorAuthFlag": true,
    "IsUW": true,
    "UserID": 7,
    "PhotoURL": "sample string 8",
    "FirstName": "sample string 9",
    "LastName": "sample string 10",
    "EmailAddress": "sample string 11",
    "OrgID": 12,
    "BranchAdmin": true,
    "DosFeatureFlag": true,
    "CoopFeatureFlag": true,
    "ApplicationIdLst": [
      1,
      2
    ],
    "OrganizationAdminAccesses": [
      {
        "OrganizationID": 1,
        "ApplicationID": 2
      },
      {
        "OrganizationID": 1,
        "ApplicationID": 2
      }
    ],
    "BranchAdminAccesses": [
      {
        "BranchID": 1,
        "ApplicationID": 2
      },
      {
        "BranchID": 1,
        "ApplicationID": 2
      }
    ],
    "DBName": "sample string 16",
    "ImpersonationList": [
      {
        "Key": 1,
        "Value": "sample string 2"
      },
      {
        "Key": 1,
        "Value": "sample string 2"
      }
    ],
    "DOSLicences": [
      1,
      2
    ],
    "LeadModuleFlag": true,
    "OrgLogo": "sample string 18",
    "OrgAlternativeLogo": "sample string 19",
    "OrgFavicon": "sample string 20",
    "BranchLogo": "sample string 21",
    "BranchAlternativeLogo": "sample string 22",
    "BranchFavicon": "sample string 23",
    "BranchFavoriteColor": "sample string 24",
    "BranchFavoriteColor2": "sample string 25",
    "BranchFirmCode": "sample string 26",
    "OrgFavoriteColor1": "sample string 27",
    "OrgFavoriteColor2": "sample string 28",
    "OrgHeaderColor": "sample string 29",
    "OrgNavigationColor": "sample string 30",
    "OrgButtonsColor": "sample string 31",
    "OrgHeaderFontColor": "sample string 32",
    "OrgHeaderIconsColor": "sample string 33",
    "LanguageID": 34,
    "TimeZoneID": "sample string 35",
    "NewtonFlag": true,
    "DOSApplicationLevels": [
      "sample string 1",
      "sample string 2"
    ],
    "CustomLeadModuleName": "sample string 37",
    "AlternaFlag": true,
    "UnsecuredLoanFlag": true,
    "MtgV2PilotUserFlag": true
  },
  "AccessToken": "sample string 1",
  "ReturnStatus": {
    "ReturnCode": 1,
    "ReturnMessage": "sample string 2",
    "Results": 1
  }
}

application/xml, text/xml

Sample: 
<AuthorizeOutput xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Scarlett.V2.API.DataModels.Services.Auth.ServiceUser">
  <ReturnStatus xmlns="http://schemas.datacontract.org/2004/07/Scarlett.V2.API.DataModels.Core">
    <Results>1</Results>
    <ReturnCode>1</ReturnCode>
    <ReturnMessage>sample string 2</ReturnMessage>
  </ReturnStatus>
  <AccessToken>sample string 1</AccessToken>
  <UserSession xmlns:d2p1="http://schemas.datacontract.org/2004/07/Scarlett.V2.API.DataModels.Services.Auth">
    <d2p1:_x003C_AlternaFlag_x003E_k__BackingField>true</d2p1:_x003C_AlternaFlag_x003E_k__BackingField>
    <d2p1:_x003C_ApplicationIdLst_x003E_k__BackingField xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>1</d3p1:int>
      <d3p1:int>2</d3p1:int>
    </d2p1:_x003C_ApplicationIdLst_x003E_k__BackingField>
    <d2p1:_x003C_BranchAdminAccesses_x003E_k__BackingField>
      <d2p1:BranchAdminAccessModel>
        <d2p1:_x003C_ApplicationID_x003E_k__BackingField>2</d2p1:_x003C_ApplicationID_x003E_k__BackingField>
        <d2p1:_x003C_BranchID_x003E_k__BackingField>1</d2p1:_x003C_BranchID_x003E_k__BackingField>
      </d2p1:BranchAdminAccessModel>
      <d2p1:BranchAdminAccessModel>
        <d2p1:_x003C_ApplicationID_x003E_k__BackingField>2</d2p1:_x003C_ApplicationID_x003E_k__BackingField>
        <d2p1:_x003C_BranchID_x003E_k__BackingField>1</d2p1:_x003C_BranchID_x003E_k__BackingField>
      </d2p1:BranchAdminAccessModel>
    </d2p1:_x003C_BranchAdminAccesses_x003E_k__BackingField>
    <d2p1:_x003C_BranchAdmin_x003E_k__BackingField>true</d2p1:_x003C_BranchAdmin_x003E_k__BackingField>
    <d2p1:_x003C_BranchAlternativeLogo_x003E_k__BackingField>sample string 22</d2p1:_x003C_BranchAlternativeLogo_x003E_k__BackingField>
    <d2p1:_x003C_BranchFavicon_x003E_k__BackingField>sample string 23</d2p1:_x003C_BranchFavicon_x003E_k__BackingField>
    <d2p1:_x003C_BranchFavoriteColor2_x003E_k__BackingField>sample string 25</d2p1:_x003C_BranchFavoriteColor2_x003E_k__BackingField>
    <d2p1:_x003C_BranchFavoriteColor_x003E_k__BackingField>sample string 24</d2p1:_x003C_BranchFavoriteColor_x003E_k__BackingField>
    <d2p1:_x003C_BranchFirmCode_x003E_k__BackingField>sample string 26</d2p1:_x003C_BranchFirmCode_x003E_k__BackingField>
    <d2p1:_x003C_BranchLogo_x003E_k__BackingField>sample string 21</d2p1:_x003C_BranchLogo_x003E_k__BackingField>
    <d2p1:_x003C_CoopFeatureFlag_x003E_k__BackingField>true</d2p1:_x003C_CoopFeatureFlag_x003E_k__BackingField>
    <d2p1:_x003C_CustomLeadModuleName_x003E_k__BackingField>sample string 37</d2p1:_x003C_CustomLeadModuleName_x003E_k__BackingField>
    <d2p1:_x003C_DBName_x003E_k__BackingField>sample string 16</d2p1:_x003C_DBName_x003E_k__BackingField>
    <d2p1:_x003C_DOSApplicationLevels_x003E_k__BackingField xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </d2p1:_x003C_DOSApplicationLevels_x003E_k__BackingField>
    <d2p1:_x003C_DOSLicences_x003E_k__BackingField xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:long>1</d3p1:long>
      <d3p1:long>2</d3p1:long>
    </d2p1:_x003C_DOSLicences_x003E_k__BackingField>
    <d2p1:_x003C_DosFeatureFlag_x003E_k__BackingField>true</d2p1:_x003C_DosFeatureFlag_x003E_k__BackingField>
    <d2p1:_x003C_EmailAddress_x003E_k__BackingField>sample string 11</d2p1:_x003C_EmailAddress_x003E_k__BackingField>
    <d2p1:_x003C_FirstName_x003E_k__BackingField>sample string 9</d2p1:_x003C_FirstName_x003E_k__BackingField>
    <d2p1:_x003C_ImpersonationList_x003E_k__BackingField xmlns:d3p1="http://schemas.datacontract.org/2004/07/System.Collections.Generic">
      <d3p1:KeyValuePairOflongstring>
        <d3p1:key>1</d3p1:key>
        <d3p1:value>sample string 2</d3p1:value>
      </d3p1:KeyValuePairOflongstring>
      <d3p1:KeyValuePairOflongstring>
        <d3p1:key>1</d3p1:key>
        <d3p1:value>sample string 2</d3p1:value>
      </d3p1:KeyValuePairOflongstring>
    </d2p1:_x003C_ImpersonationList_x003E_k__BackingField>
    <d2p1:_x003C_IsPrivateLender_x003E_k__BackingField>true</d2p1:_x003C_IsPrivateLender_x003E_k__BackingField>
    <d2p1:_x003C_IsServiceUser_x003E_k__BackingField>true</d2p1:_x003C_IsServiceUser_x003E_k__BackingField>
    <d2p1:_x003C_IsUW_x003E_k__BackingField>true</d2p1:_x003C_IsUW_x003E_k__BackingField>
    <d2p1:_x003C_LanguageID_x003E_k__BackingField>34</d2p1:_x003C_LanguageID_x003E_k__BackingField>
    <d2p1:_x003C_LastName_x003E_k__BackingField>sample string 10</d2p1:_x003C_LastName_x003E_k__BackingField>
    <d2p1:_x003C_LeadModuleFlag_x003E_k__BackingField>true</d2p1:_x003C_LeadModuleFlag_x003E_k__BackingField>
    <d2p1:_x003C_LoginAsFlag_x003E_k__BackingField>true</d2p1:_x003C_LoginAsFlag_x003E_k__BackingField>
    <d2p1:_x003C_MtgV2PilotUserFlag_x003E_k__BackingField>true</d2p1:_x003C_MtgV2PilotUserFlag_x003E_k__BackingField>
    <d2p1:_x003C_NewtonFlag_x003E_k__BackingField>true</d2p1:_x003C_NewtonFlag_x003E_k__BackingField>
    <d2p1:_x003C_OrgAlternativeLogo_x003E_k__BackingField>sample string 19</d2p1:_x003C_OrgAlternativeLogo_x003E_k__BackingField>
    <d2p1:_x003C_OrgButtonsColor_x003E_k__BackingField>sample string 31</d2p1:_x003C_OrgButtonsColor_x003E_k__BackingField>
    <d2p1:_x003C_OrgFavicon_x003E_k__BackingField>sample string 20</d2p1:_x003C_OrgFavicon_x003E_k__BackingField>
    <d2p1:_x003C_OrgFavoriteColor1_x003E_k__BackingField>sample string 27</d2p1:_x003C_OrgFavoriteColor1_x003E_k__BackingField>
    <d2p1:_x003C_OrgFavoriteColor2_x003E_k__BackingField>sample string 28</d2p1:_x003C_OrgFavoriteColor2_x003E_k__BackingField>
    <d2p1:_x003C_OrgHeaderColor_x003E_k__BackingField>sample string 29</d2p1:_x003C_OrgHeaderColor_x003E_k__BackingField>
    <d2p1:_x003C_OrgHeaderFontColor_x003E_k__BackingField>sample string 32</d2p1:_x003C_OrgHeaderFontColor_x003E_k__BackingField>
    <d2p1:_x003C_OrgHeaderIconsColor_x003E_k__BackingField>sample string 33</d2p1:_x003C_OrgHeaderIconsColor_x003E_k__BackingField>
    <d2p1:_x003C_OrgID_x003E_k__BackingField>12</d2p1:_x003C_OrgID_x003E_k__BackingField>
    <d2p1:_x003C_OrgLogo_x003E_k__BackingField>sample string 18</d2p1:_x003C_OrgLogo_x003E_k__BackingField>
    <d2p1:_x003C_OrgNavigationColor_x003E_k__BackingField>sample string 30</d2p1:_x003C_OrgNavigationColor_x003E_k__BackingField>
    <d2p1:_x003C_OrganizationAdminAccesses_x003E_k__BackingField>
      <d2p1:OrganizationAdminAccessModel>
        <d2p1:_x003C_ApplicationID_x003E_k__BackingField>2</d2p1:_x003C_ApplicationID_x003E_k__BackingField>
        <d2p1:_x003C_OrganizationID_x003E_k__BackingField>1</d2p1:_x003C_OrganizationID_x003E_k__BackingField>
      </d2p1:OrganizationAdminAccessModel>
      <d2p1:OrganizationAdminAccessModel>
        <d2p1:_x003C_ApplicationID_x003E_k__BackingField>2</d2p1:_x003C_ApplicationID_x003E_k__BackingField>
        <d2p1:_x003C_OrganizationID_x003E_k__BackingField>1</d2p1:_x003C_OrganizationID_x003E_k__BackingField>
      </d2p1:OrganizationAdminAccessModel>
    </d2p1:_x003C_OrganizationAdminAccesses_x003E_k__BackingField>
    <d2p1:_x003C_PhotoURL_x003E_k__BackingField>sample string 8</d2p1:_x003C_PhotoURL_x003E_k__BackingField>
    <d2p1:_x003C_SocialMediaAccountID_x003E_k__BackingField>1</d2p1:_x003C_SocialMediaAccountID_x003E_k__BackingField>
    <d2p1:_x003C_TimeZoneID_x003E_k__BackingField>sample string 35</d2p1:_x003C_TimeZoneID_x003E_k__BackingField>
    <d2p1:_x003C_TwoFactorAuthFlag_x003E_k__BackingField>true</d2p1:_x003C_TwoFactorAuthFlag_x003E_k__BackingField>
    <d2p1:_x003C_UnsecuredLoanFlag_x003E_k__BackingField>true</d2p1:_x003C_UnsecuredLoanFlag_x003E_k__BackingField>
    <d2p1:_x003C_UserID_x003E_k__BackingField>7</d2p1:_x003C_UserID_x003E_k__BackingField>
  </UserSession>
</AuthorizeOutput>