auth

Retrieve user key

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

post/v2/user-key

Request

Base URL
https://auth.<env>.citrusad.com
Auth
none declared
TypeScript
https://skmtc.dev/citrusad/apis/citrus-auth-api/docs/v2/user-key/post.ts
A function with typed inputs. Its response is checked against the schema.

usernamestring required

The username assigned to the user account.

passwordstring required

The account password for secure authentication.

namespacestring required

The namespace to which the user belongs.

{
  "username": "john.doe@example.com",
  "password": "password",
  "namespace": "app"
}

Authentication key successfully retrieved.

userKeystring

The unique authentication key that enables secure access.

userIdstring

The userId of the user.

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

No recorded changes to this operation across all 1 revision of this API.