Create API Key

Issues a new API key for the specified user.

🚧 Requires partner key

User endpoints are only accessible using partner keys.

Authentication

AuthorizationBasic

This is the Polytomic deployment key (on-premises only)

OR
AuthorizationBearer
This is the Polytomic API key

Path parameters

org_idstringRequiredformat: "uuid"
Unique identifier of the organization the user belongs to.
idstringRequiredformat: "uuid"
Unique identifier of the user the key will be issued for.

Headers

X-Polytomic-VersionstringRequired

Query parameters

forcebooleanOptional
If true, revoke any existing API key for the user before creating a new one.

Response

OK
dataobject

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error