API Documentation
Register Tenant
Use this endpoint to securely register a tenant to Upsolve and pass metadata relating to the tenant. This metadata payload will be used to secure data when the user accesses an Upsolve dashboard.
POST
/
v1
/
api
/
tenant
/
register-tenant
Authorizations
apiKey
string
queryrequiredapiKey MUST be supplied within the request body instead of query
Body
application/json
apiKey
string
requiredUpsolve API key, generated in the Deploy tab of the Upsolve Hub.
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
displayName
string
requiredDisplay name for this user. This will appear in the Upsolve Hub.
key
string
requiredUnique key to identify this tenant. Ideally something complex like a UUID.
prefilters
object
requiredResponse
200 - application/json
status
string
requiredAllowed value:
"success"
data
object
requiredWas this page helpful?