Onboard a User into an Org and Team

Onboard a User into an Org and Team

Create a Grafana user and grant them org and team membership.

1. Create the user account. This is a Grafana server admin operation and it returns the numeric user id that the team membership step needs.
2. Add the user to the organization with an explicit role. Grafana identifies the user here by login or email rather than by id, so the login supplied above is reused.
3. Resolve the team by name. Teams are referenced by numeric id everywhere else in the API, and those ids differ per instance, so looking the team up by its human name is what makes this workflow portable.
4. Add the new user to the resolved team. Team membership is what folder and dashboard permissions are usually granted against, so this is the step that actually gives the user access to anything.
5. List the team's members to prove the user is on it, closing the loop before the onboarding ticket is marked done.

What you'll need to have ready

• name: Display name of the person (e.g. "Ada Lovelace").
• login: Login username for the account.
• email: Email address for the account.
• password: Initial password for the account.
• orgId: Organization the user is created in and granted a role on.
• role: Org role to grant; typically Viewer, Editor, or Admin.
• teamName: Name of the existing team to add the user to.

For your developer

Arazzo workflow grafana:onboard-user, 5 operations: adminCreateUser → addOrgUser → searchTeams → addTeamMember → getTeamMembers. Specs on APIs.io.