GET V1 ems/apiUser/{apiKey}

Gets the API User with the specified API key.

Request Information

Parameters

NameDescriptionAdditional information
apiKey 
The API key of the user to get.

Define this parameter in the request URI.

Example Request

To get the API user with API key API1, make the following API call: GET /ems/apiUser/API1

Response Information

HTTP Status Codes

Status CodeMeaning
200 (OK) The request has completed successfully. The API User will be contained in the response body (see below).
401 (Unauthorised) You do not have permission to get the details of the user due to one of the reasons given below.
API Key is not found. Data received apiKey
Secret Key is wrong. Data received apiKey
Username not found. Data received apiKey
Received token not found in EMS issuer. Data received username, version
Lifetime validation failed. The token is expired. ValidTo (UTC): expiry, Current time (UTC): UTC DateTime
Token creation failed. Reason: The given username or password is wrong. For input: username, version

Response Body Formats

application/json, text/json

Sample: 
{
  "APIKey": "API_User_Key",
  "InstrumentCategories": [
    "Instrument Category 1",
    "Instrument Category 2"
  ]
}

application/xml, text/xml

Sample: 
<APIUser xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Unilever.Urdps.Hts.EmsApi.EntityRepresentations.EMS.V1">
  <APIKey>API_User_Key</APIKey>
  <InstrumentCategories xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>Instrument Category 1</d2p1:string>
    <d2p1:string>Instrument Category 2</d2p1:string>
  </InstrumentCategories>
</APIUser>