Users and API keys

Identify the two user types in Inkit Render: End-users and API keys

To use the Inkit Render API to its full potential, you must understand the difference between user types. As a result, you will make better integration design decisions because you have a clear mental model of how Inkit Render handles users.

If you want to determine how many API keys you need for your organization, please click on this link:

Users and API keys

Inkit Render has two user 'types.'

Users sometimes referred to as 'End-Users' primarily access the Inkit Render management and security layer. Meaning, they store documents, manage data access, and decide on user roles, permissions, and other such activities.

The other type, API keys, are principally used for rendering at scale, without depending on your own distributed infrastructure. Conceptually, this is the system-to-API side.

Users

Any person that signs up through https://app.inkit.com/ is a user. But, you can also sign up through email. For example, when a manager or acting superior invites you and other team members to the platform. Depending on your role in your organization, you might have to invite your team.

You are considered a user when you use the web environment of Inkit Render. As a user, you are part of and utilize the management & security layer of the Inkit platform.

Important note: the default admin role

Although this topic is not an in-depth overview of user management, you must understand the default admin role.
If you are the person who signs your organization up to Inkit, then you are automatically assigned the admin user role.

Admins can invite users and have access to all user roles and permissions available on Inkit Render.

As an admin, it is within your scope to create new roles, assign permissions, and determine who in your organization has what roles. It is also the default role from which you can create API keys.

Automatic admin assignment does not happen when you invite team members. Meaning anyone who signs up by your invitation gets the specific role you assign to them.

Automatic admin assignment only occurs to users who sign up for their organization through the app.inkit.com page without an email invitation.*

API keys

Any user who has permission to create API keys, like the default admin role, can generate new API keys.

You could view an API key as one of your 'systems.'

Your system can connect to the Inkit Render API and perform the actions they are granted to do.

Users with API key modification authority can alter system-specific allowed behaviors. Meaning, these users can give some systems different authorization than others.

Like the users, API keys are part of the management & security layer of the Inkit platform.

  • Click here to learn about the different API key permissions and their uses (coming soon)

In conclusion, API keys are your access points to the Render API. They must be stored securely and safely. Whenever you send a request to the API, you must include your API key.


Did this page help you?