Retrieve user key

This endpoint allows partners to get an authentication key by providing username and password.

Epsilon Retail Media's documentation is now centralized with our knowledgebase!

For up to date guides, please view this page in the new Partner APIs space of our documentation.

---

description: "This endpoint allows partners to get an authentication key by providing username and password."

Retrieve user key

️ Important

The requestTeamId is required for supplier/advertiser users. Omitting it will result in a 400 Bad Request.

Retrieve user key

post

This endpoint allows partners to get an authentication key by providing username and password.

Body

namespacestringRequired

The namespace to which the user belongs.

Example: app

passwordstringRequired

The account password for secure authentication.

Example: password

usernamestringRequired

The username assigned to the user account.

Example: [e-mail]

Responses

200

Authentication key successfully retrieved.

application/json

userIdstringOptional

The userId of the user.

Example: user-456

userKeystringOptional

The unique authentication key that enables secure access.

Example: user-456

400

There was a problem with input.

application/json

401

Login failed or token not valid.

application/json

403

Access denied due to insufficient permissions.

application/json

default

An unexpected error response.

application/json

post/v2/user-key

POST /v2/user-key HTTP/1.1
Host: auth.<env>.citrusad.com
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 75

"namespace='app'&password='password'&username='[e-mail]'"

{
  "userId": "user-456",
  "userKey": "user-456"
}