Create User Auth Ticket

Authenticates a user for a particular tenant given a set of user credentials and a tenantId.

POST /platform/adminuser/authtickets/tenants

Error

A valid request URL is required to generate request examples

200

{
  "accessToken": "<string>",
  "accessTokenExpiration": "2023-11-07T05:31:56Z",
  "availableTenants": [
    {
      "attributes": [
        {
          "createBy": "<string>",
          "createDate": "2023-11-07T05:31:56Z",
          "name": "<string>",
          "updateBy": "<string>",
          "updateDate": "2023-11-07T05:31:56Z",
          "value": null
        }
      ],
      "domain": "<string>",
      "expiry": "2023-11-07T05:31:56Z",
      "id": 123,
      "isDevTenant": true,
      "isUnified": true,
      "lastLoginDate": "2023-11-07T05:31:56Z",
      "masterCatalogs": [
        {
          "catalogs": [
            {
              "defaultCurrencyCode": "<string>",
              "defaultLocaleCode": "<string>",
              "id": 123,
              "masterCatalogId": 123,
              "name": "<string>",
              "tenantId": 123
            }
          ],
          "defaultCurrencyCode": "<string>",
          "defaultLocaleCode": "<string>",
          "id": 123,
          "name": "<string>",
          "supportedLocaleCodes": [
            "<string>"
          ],
          "tenantId": 123
        }
      ],
      "name": "<string>",
      "sites": [
        {
          "attributes": [
            {
              "createBy": "<string>",
              "createDate": "2023-11-07T05:31:56Z",
              "name": "<string>",
              "updateBy": "<string>",
              "updateDate": "2023-11-07T05:31:56Z",
              "value": null
            }
          ],
          "catalogId": 123,
          "countryCode": "<string>",
          "currencyCode": "<string>",
          "domain": "<string>",
          "id": 123,
          "localeCode": "<string>",
          "name": "<string>",
          "primaryCustomDomain": "<string>",
          "tenantId": 123
        }
      ]
    }
  ],
  "createdOn": "2023-11-07T05:31:56Z",
  "grantedBehaviors": [
    123
  ],
  "jwtAccessToken": "<string>",
  "redirect": "<string>",
  "refreshToken": "<string>",
  "refreshTokenExpiration": "2023-11-07T05:31:56Z",
  "ssoNameId": "<string>",
  "ssoSession": "<string>",
  "tenant": {
    "attributes": [
      {
        "createBy": "<string>",
        "createDate": "2023-11-07T05:31:56Z",
        "name": "<string>",
        "updateBy": "<string>",
        "updateDate": "2023-11-07T05:31:56Z",
        "value": null
      }
    ],
    "domain": "<string>",
    "expiry": "2023-11-07T05:31:56Z",
    "id": 123,
    "isDevTenant": true,
    "isUnified": true,
    "lastLoginDate": "2023-11-07T05:31:56Z",
    "masterCatalogs": [
      {
        "catalogs": [
          {
            "defaultCurrencyCode": "<string>",
            "defaultLocaleCode": "<string>",
            "id": 123,
            "masterCatalogId": 123,
            "name": "<string>",
            "tenantId": 123
          }
        ],
        "defaultCurrencyCode": "<string>",
        "defaultLocaleCode": "<string>",
        "id": 123,
        "name": "<string>",
        "supportedLocaleCodes": [
          "<string>"
        ],
        "tenantId": 123
      }
    ],
    "name": "<string>",
    "sites": [
      {
        "attributes": [
          {
            "createBy": "<string>",
            "createDate": "2023-11-07T05:31:56Z",
            "name": "<string>",
            "updateBy": "<string>",
            "updateDate": "2023-11-07T05:31:56Z",
            "value": null
          }
        ],
        "catalogId": 123,
        "countryCode": "<string>",
        "currencyCode": "<string>",
        "domain": "<string>",
        "id": 123,
        "localeCode": "<string>",
        "name": "<string>",
        "primaryCustomDomain": "<string>",
        "tenantId": 123
      }
    ]
  },
  "user": {
    "emailAddress": "<string>",
    "firstName": "<string>",
    "lastName": "<string>",
    "userId": "<string>",
    "userName": "<string>"
  }
}

Authorizations

Authorization · string · header · required

JWT Authorization header using the Bearer scheme.

Query Parameters

tenantId · integer<int32>

Optional tenant Id parameter

responseFields · string

limits which fields are returned in the response body

Body

application/json

User's email address and password.

emailAddress · string | null

password · string | null

userName · string | null

Response

200

application/json

OK

accessToken · string | null

accessTokenExpiration · string<date-time>

availableTenants · object[] | null

Show child attributes

createdOn · string<date-time>

grantedBehaviors · integer<int32>[] | null

jwtAccessToken · string | null

redirect · string | null

refreshToken · string | null

refreshTokenExpiration · string<date-time>

ssoNameId · string | null

ssoSession · string | null

tenant · object

Show child attributes

user · object

Show child attributes