POST
/
v1
/
api
/
tenant
/
register-tenant

Authorizations

​
apiKey
string
query
required

apiKey MUST be supplied within the request body instead of query

Body

application/json
​
apiKey
string
required

Upsolve API key, generated in the Deploy tab of the Upsolve Hub.

Minimum length: 1
​
displayName
string
required

Display name for this user. This will appear in the Upsolve Hub.

​
key
string
required

Unique key to identify this tenant. Ideally something complex like a UUID.

Minimum length: 1
​
prefilters
object
required
​
organizationId
string

[Optional] The ID of the org the API key is being used with. Only needed if the API key is being used for an organization other than the org that generated it.

​
user
string

TODO

Response

200 - application/json
​
data
object
required
​
status
string
required
Allowed value: "success"

Was this page helpful?

Suggest edits
Create Chart