POST api/AuthorisedUser/auth

No documentation available.

Request Information

Parameters

Name	Description	Additional information
loginViewModel	No documentation available.	Define this parameter in the request body.

Request body formats

application/json, text/json

Sample:

{
  "Email": "sample string 1",
  "Password": "sample string 2",
  "ClientIPAddress": "sample string 3",
  "Stakeholder": {
    "$id": "2",
    "ConfirmEmail": "sample string 1",
    "SavedEmail": "sample string 2",
    "HasBeenAdded": true,
    "StakeholderCategory": {
      "$id": "3",
      "PK": 1,
      "ActiveFlagNullable": true
    },
    "StakeholderOrganisation": {
      "$id": "4",
      "PK": 1,
      "OrganisationCategory": {
        "$ref": "3"
      },
      "OrganisationStakeholders": {
        "$id": "5",
        "$values": [
          {
            "$ref": "2"
          },
          {
            "$ref": "2"
          },
          {
            "$ref": "2"
          }
        ]
      },
      "OrganisationStakeholdersNames": "sample string 15"
    },
    "PK": 4
  },
  "LastPasswordChangedDate": "2024-11-09T12:58:50.7723972+11:00",
  "AvailableAuthorisedOrganisations": {
    "$id": "6",
    "$values": [
      {
        "$id": "7",
        "AuthorisedUserOrganisationId": 1,
        "AuthorisedUserId": 2,
        "StakeholderId": 3,
        "Name": "sample string 4",
        "Email": "sample string 5",
        "OrganisationId": 1,
        "Organisation": "sample string 6",
        "PK": "sample string 6"
      },
      {
        "$ref": "7"
      },
      {
        "$ref": "7"
      }
    ]
  },
  "AuthorisedUserRoleType": "sample string 4",
  "AuthorisedUserSelectScreenNote": "sample string 5",
  "IsFailedRequest": true,
  "Validation": {
    "$id": "8",
    "SuccessOutput": {
      "$id": "9"
    },
    "Success": true,
    "ErrorMessages": null,
    "WarningMessages": {
      "$id": "10",
      "$values": [
        "sample string 1",
        "sample string 2",
        "sample string 3"
      ]
    },
    "InfoMessages": {
      "$id": "11",
      "$values": [
        "sample string 1",
        "sample string 2",
        "sample string 3"
      ]
    },
    "DatabaseErrorMessage": "sample string 3",
    "SuccessMessage": "sample string 4",
    "RelatedKeyId": "sample string 5"
  },
  "PageAccess": {
    "$id": "12",
    "PageCode": "sample string 1",
    "StepAccesses": {
      "$id": "13",
      "$values": [
        {
          "$id": "14",
          "StageCode": "sample string 1",
          "StepCode": "sample string 2"
        },
        {
          "$ref": "14"
        },
        {
          "$ref": "14"
        }
      ]
    },
    "Positions": {
      "$id": "15",
      "$values": [
        "sample string 1",
        "sample string 2",
        "sample string 3"
      ]
    }
  },
  "UserRole": 0
}

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 'UserAccountLoginViewModel'.

Response Information

Response body formats

application/json, text/json

Sample:

{
  "Email": "sample string 1",
  "Password": "sample string 2",
  "ClientIPAddress": "sample string 3",
  "Stakeholder": {
    "$id": "2",
    "ConfirmEmail": "sample string 1",
    "SavedEmail": "sample string 2",
    "HasBeenAdded": true,
    "StakeholderCategory": {
      "$id": "3",
      "PK": 1,
      "ActiveFlagNullable": true
    },
    "StakeholderOrganisation": {
      "$id": "4",
      "PK": 1,
      "OrganisationCategory": {
        "$ref": "3"
      },
      "OrganisationStakeholders": {
        "$id": "5",
        "$values": [
          {
            "$ref": "2"
          },
          {
            "$ref": "2"
          },
          {
            "$ref": "2"
          }
        ]
      },
      "OrganisationStakeholdersNames": "sample string 15"
    },
    "PK": 4
  },
  "LastPasswordChangedDate": "2024-11-09T12:58:50.8036489+11:00",
  "AvailableAuthorisedOrganisations": {
    "$id": "6",
    "$values": [
      {
        "$id": "7",
        "AuthorisedUserOrganisationId": 1,
        "AuthorisedUserId": 2,
        "StakeholderId": 3,
        "Name": "sample string 4",
        "Email": "sample string 5",
        "OrganisationId": 1,
        "Organisation": "sample string 6",
        "PK": "sample string 6"
      },
      {
        "$ref": "7"
      },
      {
        "$ref": "7"
      }
    ]
  },
  "AuthorisedUserRoleType": "sample string 4",
  "AuthorisedUserSelectScreenNote": "sample string 5",
  "IsFailedRequest": true,
  "Validation": {
    "$id": "8",
    "SuccessOutput": {
      "$id": "9"
    },
    "Success": true,
    "ErrorMessages": null,
    "WarningMessages": {
      "$id": "10",
      "$values": [
        "sample string 1",
        "sample string 2",
        "sample string 3"
      ]
    },
    "InfoMessages": {
      "$id": "11",
      "$values": [
        "sample string 1",
        "sample string 2",
        "sample string 3"
      ]
    },
    "DatabaseErrorMessage": "sample string 3",
    "SuccessMessage": "sample string 4",
    "RelatedKeyId": "sample string 5"
  },
  "PageAccess": {
    "$id": "12",
    "PageCode": "sample string 1",
    "StepAccesses": {
      "$id": "13",
      "$values": [
        {
          "$id": "14",
          "StageCode": "sample string 1",
          "StepCode": "sample string 2"
        },
        {
          "$ref": "14"
        },
        {
          "$ref": "14"
        }
      ]
    },
    "Positions": {
      "$id": "15",
      "$values": [
        "sample string 1",
        "sample string 2",
        "sample string 3"
      ]
    }
  },
  "UserRole": 0
}