Platform
Number of APIs: 12
1. 01 Authenticate PLATFORM
POST https://{{IPAddr}}/api/v1/authenticate
Authenticate a user. You can pass either a siteId or a siteName (not both) along with the email/password to log in to a specific site. If you pass neither the user will be logged into the site for which they have the oldest membership. Alternatively, set the siteName as platform
to authenticate to the platform.
2. 02 Activate License
POST https://{{IPAddr}}/api/v1/licenses
Add licenses to the platform. Can be a single license (i.e. Engine Worker) or a list of keys.
3. 03 Set Base Address
PATCH https://{{IPAddr}}/api/v1/platform/settings
4. 03 Create Site
POST https://{{IPAddr}}/api/v1/sites
5. 03.1 Assign Platform Admin User License (OPTIONAL)
POST https://{{IPAddr}}/api/v1/platform/seats
Use this if you want to have the Platform admin also be a Site Admin on your site (see 04.8)
6. 04.1a Get Site Admin Activation Token
GET https://{{IPAddr}}/api/v1/users/{{SiteAdminUserId}}/activationLink
7. 04.3 Create Consumer
POST https://{{IPAddr}}/api/v1/platform/users
8. 04.1a Get Consumer Activation Token
GET https://{{IPAddr}}/api/v1/users/{{ConsumerUserId}}/activationLink
9. 04.4 Activate Consumer
POST https://{{IPAddr}}/api/v1/users/setPassword
10. 04.5 Get Roles
GET https://{{IPAddr}}/api/v1/roles
11. 04.8 PlatformAdmin to Site
POST https://{{IPAddr}}/api/v1/sites/{{siteId}}/users
12. Cancel Job
POST https://{{IPAddr}}/api/v1/platform/jobs/d1664be0-46b8-4e43-aa33-d61f6b58ae3c/cancel
ENDPOINTS