API ReferenceUsers

Create User

Creates a new user in the specified organization and assigns the requested permissions roles.

🚧 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.

Headers

X-Polytomic-VersionstringRequired

Request

This endpoint expects an object.
emailstringRequired
Email address used to sign the user in and receive notifications.
role_idslist of stringsOptional
Identifiers of the permissions roles to assign to the user. Must contain at least one entry when provided.
rolestringOptionalDeprecated

Deprecated legacy role name. Use role_ids instead; setting both role and role_ids in the same request is rejected.

Response

OK
dataobject

Errors

401
Unauthorized Error
403
Forbidden Error
422
Unprocessable Entity Error
500
Internal Server Error