POST api/v2/users/organizations/create

CreateOrganizationUser

Request Information

URI Parameters

None.

Body Parameters

The command

CreateOrganizationUserCommand
NameDescriptionTypeAdditional information
OrganizationId

universally unique identifier

Required

Email

string

Required

Data type: EmailAddress

Max length: 256

RoleIds

Collection of universally unique identifier

Required

Settings

CreateUserCommandSettings

Required

Request Formats

application/json

Sample:
{
  "OrganizationId": "00000000-0000-0000-0000-000000000000",
  "Email": "sample string 1",
  "RoleIds": [
    "00000000-0000-0000-0000-000000000000",
    "00000000-0000-0000-0000-000000000000"
  ],
  "Settings": {
    "DisplayName": "sample string 1",
    "SignatureText": "sample string 2",
    "FirstName": "sample string 3",
    "MiddleName": "sample string 4",
    "LastName": "sample string 5",
    "Department": "sample string 6",
    "JobTitleDescription": "sample string 7",
    "PhoneNumber": "sample string 8"
  }
}

Response Information

Resource Description

CreateOrganizationUserCommandResult

CreateUserCommandResult
NameDescriptionTypeAdditional information
Result

CreateUserCommandResultKind

Required

UserId

universally unique identifier

None.

Response Formats

application/json

Sample:
{
  "Result": "Success",
  "UserId": "00000000-0000-0000-0000-000000000000"
}