RegistrationToken

Summary

Organization Registration Token.

Description

Allows users to onboard themselves (self registration) into an organization. It is possible to create a registration token which can be provided to a user. The user then presents this code when they register with the API Manager. When the user is approved, the user will be provisioned by the API Manager into the organization associated with the registration token.

Fields

Field Name Type Since Version Description
token String The registration code
organizationId String Unique identifier for the organization who the registration code applies to
expiry Long Epoch/Unix time stamp when the registration code will expire
createdOn Long Epoch/Unix time stamp when the registration code was created
createdBy String The unique identifier for user that create the registration code
userQuota Int The remaining number of users that can use the registration code for self registration to an organization
maxUsers Int The total number of users that can use the registration code for self registration to an organization since the code has been created
enabled Boolean Flag disables registration code so that it can no longer be used for registration

Example JSON

{
  "token" : "257690",
  "organizationId" : "3e21b76a-defa-49ab-9682-a9cd60387e37",
  "expiry" : 1366930800000,
  "createdOn" : 1364407145121,
  "createdBy" : "de077cd8-83b7-46d1-b06f-2eaaf1548898",
  "userQuota" : 10,
  "maxUsers" : 10,
  "enabled" : true
}