Manage Project Team Members
This tutorial will take you through the process of creating roles, adding team members, and retrieving team members for a given iTwin Project.
By the end of this walk-through, you will be able to utilize the API endpoints in order to create roles, add & assign permissions to the role, invite users to a project, and retrieve the list of project members.
This tutorial assumes that you already have:
- A Project
- A tool such as
Postmanthat can be used to execute http calls. These calls can also be made using the
TryItbutton in the API documentation.
- If a user is affiliated with an Organization, then the user must be an Organization Administrator in order to manage team members for a project. An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities Licensing, Cloud, and Web Services wiki page.
1. Register an Application
To build an application on the iTwin Platform, you will need to register a client.
Click the Register Application button to automatically register a client for this quick start. You can find registered application in My apps page.
Application registration process
To register a client:
- Go to the iTwin Platform home page
- Click the Sign In button and sign-in using your Bentley account credentials
- If you have not already registered, click Register now and complete the registration process.
- Click on your user icon and navigate to the My Apps page
- Click the Register New button
- Give your application a Name
- Select the Administration API
- Select application type SPA (Single Page Web Application)
- Enter Redirect URL
- For this tutorial use
- For this tutorial use
- Leave post logout redirect URIs empty.
- Click the Save button
2. Get a token
Before you can make a request to the APIs, a user token is needed. There are several ways to get it.
- Go here
- Under the
authorizationCodefrom the dropdown.
- After the signin popup closes, the
Authorizationheader with token value should be visible beneath the
- Copy & paste the
Authorizationvalue for this tutorial.
3. Create Project Role
The Create project role endpoint is used to create project roles. After role is created permissions can be assigned.
project id is required to create a role. A
display name and
description are required in the POST body.
The POST call will return a new role instance. The retruned
role id along with the
project id will be used to add permissions in the next step.
4. Update Project Role Using the Proejct Id and Role Id
permissions Role needs to be updated.
project id and
role id are required. The POST body should contain
list of permissions.
The response will contain the role details along with the list of permissions assigned.
5. Query for Roles using the Project Id
Project Id can be used to retrieve a list of project roles.
The api will return a list of roles for a given project.
6. Add Project Team Member
The Add project team member endpoint is used to add team members to a given project.
project id is a required parameter. User
list of role names are required in the POST body.
The POST call will only return the headers.
7. Query for Team Members using the Project Id
Id query parameter can be used to retrieve a list of team members using the
The api will return a list of team members for the given project.