User

For the impatient

You may explore this data model via the API Playground, by clicking here

Endpoints

• /users[/{email}]
• /tenants/{tenant-name}/users[/{email}]
• /domains/{domain-name}/users[/{email}]

The Cloudonix user model describes administrative users with access to the management and control APIs.

This is not what is called a "subscriber" in the Cloudonix Platform, and should not be created for "end users". A "user" can has administrative access to various parts of the Cloudonix Platform and access should be granted with care.

The Cloudonix Dashboard is the preferred way to create users, after which such users may log in to the Cloudonix Dashboard using the OAuth 2.0 login process.

Different users endpoints may have different requirements from the API key used to authorize access:

• The top level endpoint provides access to all user accounts for which the current user has access.
• The /tenants endpoint provides access to all user accounts for a specific tenant (as per access permissions).
• The /domains endpoint provides access to all user accounts for a specific domain (as per access permissions).

Properties

Property	Type	Editable	Description
tenantId	Number	No	Numeric identifier of the tenant that this user is an administrator of.
domainId	Number	No	Numeric identifier of the domain that this user is an administrator of. If this field is set to null, then the user is a tenant administrator.
email	String	Create	Email address of the user.
active	Boolean	Update	Whether the admin user is active and can authenticate and generate keys. Default: true.
authProvider	String	No	OAuth 2.0 authentication provider for the user. Currently the only supported value is google.
auth	String	Update	Last authorization token received from provider.