XOMNI: Experience Omni-Channel

Last Updated: May 05, 2016

This API allows you to retrieve the basic principal information about the API User represented through the request header.

Request

HTTP Method Resource URI
GET https://{tenantName}.api.xomni.com/private/auth/principal

Request Headers

Header Field Name Description
Authorization
Access or identity token taken from oauth APIs.
Sample: Bearer dc8f1dcdbe454da8a25621839a93569337522968019e4bd7becd6e01285444da
Accept
Includes minor version header.
Sample: application/vnd.xomni.api-v4-1, */*

Response

{
    "ApiUserName": "DebugApiPrivateTestUser",
    "ApiUserEncryptedPassword": "lq0Lu4E/7alRzwU97BJHtZNHoHsHdpBBCeg5sSDBJ9g=",
    "ApiUserFirstLastName": "Debug Private Api User",
    "ApiUserRights": [
        {
            "Id": 2,
            "Description": "PrivateAPI"
        }
    ]
}

Response Body Description

Parameter Name Description Type
ApiUserName Username of the API user. String
ApiUserEncryptedPassword Encrypted Password of the API user. String
ApiUserFirstLastName First and last name of the API user. String
ApiUserRights[0..N].Id Unique ID of the API user right. Number
ApiUserRights[0..N].Description Description of the API user right. String

Response Headers

Header Field Name Description
Content-Type
Content type of the response entity. The value of this header is always application/json.

Status Codes

A successful operation returns status code 200 (OK) for GET operations.