REST API OCST - Get User Details

URI

/users/-

Http Method

GET

Short Description

CC Login / Gets the profile details of a currently authenticated user (Account Representative)

Query Parameters

Example Requests

/users/-

HTTP Status Codes

200 OK

400 Bad Request

possible values for "error-key":

401 Unauthorized

403 Forbidden

organization.invalidorganization.domain.invalid

Description

Gets the profile details of a currently authenticated user (Account Representative). This call should be used for user login.

To authenticate the user for the first time:
Either

  • Add header fields
    • " Authorization "; with Value: String "Basic " +Base64-encoded credentials separated by ':' (login + ":" + password)
    • " UserOrganization "with value login (plaintext)

or

  • Add header fields
    • " UserLogin " with value login (plaintext)
    • " UserPassword " with value login (plaintext)
    • " UserOrganization "with value login (plaintext)

The response of this call will contain an " authentication-token " which should be used to authenticate the user in all further calls.

For repeated access:

  • Add Header fields
    • " authentication-token "; value: generated token from the first response header
    • " UserOrganization "with value login (plaintext) - used for permission check

Cartridge

app_sf_contactcenter_rest

Application

ContactCenter

Product Version

7.5.1

Product To Version

Status

final

JSON

Request Data Format

Request related java object

n/a

Request Example

n/a

Response Data Format

application/json

Response related java object

com.intershop.application.contactcenter.capi.rest.resource.UserResource
com.intershop.application.contactcenter.capi.rest.resourceobject.UserRO

Response Example

{
    "type": "User",
    "firstName": "Alvaro",
    "lastName": "Acevedo"
}

XML

XML Request Data Format

XML Request Java Objects

n/a

XML Request Example

n/a

XML Response Data Format

text/xml

XML Response Java Objects

com.intershop.application.contactcenter.capi.rest.resource.UserResource
com.intershop.application.contactcenter.capi.rest.resourceobject.UserRO

XML Response Example

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<User type="User">
    <firstName>Alvaro</firstName>
    <lastName>Acevedo</lastName>
</User>

Disclaimer

The information provided in the Knowledge Base may not be applicable to all systems and situations. Intershop Communications will not be liable to any party for any direct or indirect damages resulting from the use of the Customer Support section of the Intershop Corporate Web site, including, without limitation, any lost profits, business interruption, loss of programs or other data on your information handling system.

Customer Support
Knowledge Base
Product Resources
Support Tickets