GET v1/user-info/{externalPartner}?token={token}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
token

string

Required

externalPartner

string

None.

Body Parameters

None.

Response Information

Resource Description

UserDTO
NameDescriptionTypeAdditional information
Password

string

None.

LastLoginDate

date

None.

IsLocked

boolean

None.

IsEditable

boolean

None.

GrantedRoles

Collection of UserGrantedRoleDTO

None.

SystemRoles

Collection of RoleKeyDTO

None.

MobileNumber

string

None.

MFALoginPolicy

MFALoginPolicy

None.

IPAddresses

Collection of IPWhitelistDTO

None.

ExternalPartners

Collection of integer

None.

Id

globally unique identifier

None.

UserName

string

None.

DomainName

string

None.

Name

string

None.

FirstName

string

None.

MiddleInitial

character

None.

LastName

string

None.

Email

string

None.

Response Formats

application/json, text/json

Sample:
{
  "password": "sample string 1",
  "lastLoginDate": "0001-02-03",
  "isLocked": true,
  "isEditable": true,
  "grantedRoles": [
    {
      "organizationKey": {
        "id": "dc9d1048-28c3-40e2-b727-9a84ea28acd5",
        "code": "sample string 2",
        "description": "sample string 3"
      },
      "roleKey": {
        "id": "c048ce20-987e-452f-8f60-9f28a84b9a11",
        "code": "sample string 1",
        "description": "sample string 2"
      },
      "isEditable": true
    },
    {
      "organizationKey": {
        "id": "dc9d1048-28c3-40e2-b727-9a84ea28acd5",
        "code": "sample string 2",
        "description": "sample string 3"
      },
      "roleKey": {
        "id": "c048ce20-987e-452f-8f60-9f28a84b9a11",
        "code": "sample string 1",
        "description": "sample string 2"
      },
      "isEditable": true
    }
  ],
  "systemRoles": [
    {
      "id": "c048ce20-987e-452f-8f60-9f28a84b9a11",
      "code": "sample string 1",
      "description": "sample string 2"
    },
    {
      "id": "c048ce20-987e-452f-8f60-9f28a84b9a11",
      "code": "sample string 1",
      "description": "sample string 2"
    }
  ],
  "mobileNumber": "sample string 4",
  "mfaLoginPolicy": "Always",
  "ipAddresses": null,
  "externalPartners": [
    1,
    2
  ],
  "id": "a9a450e3-e188-4b00-a3bd-8909318bdd67",
  "userName": "sample string 5",
  "domainName": "sample string 6",
  "name": "sample string 7",
  "firstName": "sample string 8",
  "middleInitial": "A",
  "lastName": "sample string 9",
  "email": "sample string 10"
}

text/xml

Sample:
<UserDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BDBPayroll.Core.ServiceContracts.Data.Models">
  <DomainName>sample string 6</DomainName>
  <Email>sample string 10</Email>
  <FirstName>sample string 8</FirstName>
  <Id>a9a450e3-e188-4b00-a3bd-8909318bdd67</Id>
  <LastName>sample string 9</LastName>
  <MiddleInitial>65</MiddleInitial>
  <Name>sample string 7</Name>
  <UserName>sample string 5</UserName>
  <ExternalPartners xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </ExternalPartners>
  <GrantedRoles>
    <UserGrantedRoleDTO>
      <IsEditable>true</IsEditable>
      <OrganizationKey>
        <Code>sample string 2</Code>
        <Description>sample string 3</Description>
        <Id>dc9d1048-28c3-40e2-b727-9a84ea28acd5</Id>
      </OrganizationKey>
      <RoleKey>
        <Code>sample string 1</Code>
        <Description>sample string 2</Description>
        <Id>c048ce20-987e-452f-8f60-9f28a84b9a11</Id>
      </RoleKey>
    </UserGrantedRoleDTO>
    <UserGrantedRoleDTO>
      <IsEditable>true</IsEditable>
      <OrganizationKey>
        <Code>sample string 2</Code>
        <Description>sample string 3</Description>
        <Id>dc9d1048-28c3-40e2-b727-9a84ea28acd5</Id>
      </OrganizationKey>
      <RoleKey>
        <Code>sample string 1</Code>
        <Description>sample string 2</Description>
        <Id>c048ce20-987e-452f-8f60-9f28a84b9a11</Id>
      </RoleKey>
    </UserGrantedRoleDTO>
  </GrantedRoles>
  <IPAddresses i:nil="true" />
  <IsEditable>true</IsEditable>
  <IsLocked>true</IsLocked>
  <LastLoginDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/EntireOne.Shared.Dates">
    <d2p1:Year>1</d2p1:Year>
    <d2p1:Month>2</d2p1:Month>
    <d2p1:Day>3</d2p1:Day>
  </LastLoginDate>
  <MFALoginPolicy>Always</MFALoginPolicy>
  <MobileNumber>sample string 4</MobileNumber>
  <Password>sample string 1</Password>
  <SystemRoles>
    <RoleKeyDTO>
      <Code>sample string 1</Code>
      <Description>sample string 2</Description>
      <Id>c048ce20-987e-452f-8f60-9f28a84b9a11</Id>
    </RoleKeyDTO>
    <RoleKeyDTO>
      <Code>sample string 1</Code>
      <Description>sample string 2</Description>
      <Id>c048ce20-987e-452f-8f60-9f28a84b9a11</Id>
    </RoleKeyDTO>
  </SystemRoles>
</UserDTO>