POST v2/ranches/{ranchGuid}/users/{userId}.json

Add a user to a ranch

Request Information

URI Parameters

NameDescriptionTypeAdditional information
ranchGuid

globally unique identifier

Required

userId

globally unique identifier

Required

Body Parameters

None.

Response Information

Resource Description

AspNetUserJSON
NameDescriptionTypeAdditional information
Id

string

None.

Email

string

None.

EmailConfirmed

boolean

None.

PasswordHash

string

None.

SecurityStamp

string

None.

PhoneNumber

string

None.

PhoneNumberConfirmed

boolean

None.

TwoFactorEnabled

boolean

None.

LockoutEndDateUtc

date

None.

LockoutEnabled

boolean

None.

AccessFailedCount

integer

None.

UserName

string

None.

UserDetail_Id

integer

None.

UserDetail

UserDetailJSON

None.

IsImportedUser

boolean

None.

Response Formats

application/json, text/json, text/html

Sample:
{
  "Id": "sample string 1",
  "Email": "sample string 2",
  "EmailConfirmed": true,
  "PasswordHash": "sample string 4",
  "SecurityStamp": "sample string 5",
  "PhoneNumber": "sample string 6",
  "PhoneNumberConfirmed": true,
  "TwoFactorEnabled": true,
  "LockoutEndDateUtc": "2025-02-12T05:43:36.1678213-08:00",
  "LockoutEnabled": true,
  "AccessFailedCount": 10,
  "UserName": "sample string 11",
  "UserDetail_Id": 1,
  "UserDetail": {
    "Id": 1,
    "FirstName": "sample string 2",
    "LastName": "sample string 3",
    "Title": "sample string 4",
    "FirstTimeLoggedIn": true,
    "PolicyAcceptedDate": "2025-02-12T05:43:36.1678213-08:00",
    "PolicyIPAddress": "sample string 6",
    "LanguageCodeId": 7,
    "DefaultRanchId": 1
  },
  "IsImportedUser": true
}

application/xml, text/xml

Sample:
<AspNetUserJSON xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Id>sample string 1</Id>
  <Email>sample string 2</Email>
  <EmailConfirmed>true</EmailConfirmed>
  <PasswordHash>sample string 4</PasswordHash>
  <SecurityStamp>sample string 5</SecurityStamp>
  <PhoneNumber>sample string 6</PhoneNumber>
  <PhoneNumberConfirmed>true</PhoneNumberConfirmed>
  <TwoFactorEnabled>true</TwoFactorEnabled>
  <LockoutEndDateUtc>2025-02-12T05:43:36.1678213-08:00</LockoutEndDateUtc>
  <LockoutEnabled>true</LockoutEnabled>
  <AccessFailedCount>10</AccessFailedCount>
  <UserName>sample string 11</UserName>
  <UserDetail_Id>1</UserDetail_Id>
  <UserDetail>
    <Id>1</Id>
    <FirstName>sample string 2</FirstName>
    <LastName>sample string 3</LastName>
    <Title>sample string 4</Title>
    <FirstTimeLoggedIn>true</FirstTimeLoggedIn>
    <PolicyAcceptedDate>2025-02-12T05:43:36.1678213-08:00</PolicyAcceptedDate>
    <PolicyIPAddress>sample string 6</PolicyIPAddress>
    <LanguageCodeId>7</LanguageCodeId>
    <DefaultRanchId>1</DefaultRanchId>
  </UserDetail>
  <IsImportedUser>true</IsImportedUser>
</AspNetUserJSON>