Set up a new customer organization
You (the vendor) define the information on your B2B customers in 10Duke Enterprise under the concept of an organization. If you wish to automate the onboarding of B2B customers by integrating 10Duke APIs with your other systems, such as a customer relationship management (CRM) or e-commerce system, you can rely on the 10Duke Identity Management REST API. You also have the option of onboarding customers manually using the SysAdmin tool.
Using the Identity Management REST API, you can create a new customer organization with the following basic setup, ready for inviting end users:
-
Their first administrator user with access to the OrgAdmin tool, if you’re providing it for your B2B customers
-
A default entitlement to hold the organization’s licenses
-
An “employees” user group for the organization, authorized to access the default entitlement
How about your B2C customers? Onboarding consumer customers is simpler: create a user account, for example, by invitation, after which you can provision licenses to them. A personal entitlement is created for them automatically to hold their licenses.
Create a basic setup for a new organization
For an easy setup of a new organization:
-
First, a user account is needed for the organization’s first administrator user. You can use an invitation that only creates a user account for this.
-
Next, use POST
/organizations/organization-setup
to set up the organization.-
Specify the user you just created to grant them administrator access to the organization.
-
The setup request automatically creates an “OrgAdmin” organization role for the organization, and assigns this role to the administrator user you specified. The role grants administrator-level access to this organization and allows access to the OrgAdmin tool.
-
The setup request also automatically creates a user group “employees” for the organization, intended to be used for the organization’s employees, and adds the specified administrator user to this user group.
-
You can choose to have a default entitlement created for the organization. The setup request then automatically authorizes the “employees” user group to access licenses in that entitlement.
If you don’t create the default entitlement at this point, it will be automatically created later when the first license is provisioned for the organization. In this case you need to separately authorize access to the entitlement.
-
Next steps
After the initial setup, the next steps of onboarding a new B2B customer typically include the following:
-
Connect the client application that is calling the Identity Management REST API using OAuth 2.0.
-
In identity federation cases where your B2B customer’s users must be authenticated using the customer’s own identity provider, connect the identity provider to 10Duke Enterprise.
-
Provision licenses to the organization in the default entitlement using the 10Duke Entitlement Management REST API. Also make sure the “employees” user group is authorized to access the default entitlement, if the entitlement wasn’t already created at the setup.
-
Now everything is ready for the organization to start inviting their end users to the “employees” group to give them access to the licenses.
Alternatives for organization setup
Depending on your use case, you can also use separate API operations to create a new organization and the other items needed such as entitlements, user groups, and organization roles, and then invite or create the administrator user to the organization.
You can handle most of the above using the Identity Management REST API, but entitlements are created using the Entitlement Management REST API.