Project users
Projects are isolated properties within an organization. Projects are often associated with a single website or application but can be associated with many applications across different channels such as mobile and gaming. For example, a company may have a project for their marketing website, their documentation website, and their LMS or training website. Each of these can be associated with their own project. There is no limit to the number of properties you can associate with a project. Each example above can all point to the same project if this is the preference of the organization.
API keys are isolated to a single project and can not be used to reference resources in other projects. Currently, there are no organization-level API methods publicly available to create new projects programmatically.
List all user within a project
Required attributes
| projectId | string | Your projectId |
Optional attributes
| None |
Request
Response
Retrieves a single project user based on the provided project user ID. Note that user IDs are not the same at the project level as the organization level. Project IDs are assigned to a user at the organization level and isolate permissions for that user within a specified project.
Required attributes
| projectId | string | Your project ID |
| projectUserId | string | The ID of the project user to retrieve |
Optional attributes
| None |
Request
Response
Retrieves information about the user making the request. If calling from the API, this method will return information about the API key being used.
Required attributes
| projectId | string | Your projectId |
Optional attributes
| None |
Request
Response
Add a user from your organization to a project
Required attributes
| projectId | string | Your project ID |
| _id | string | The organization user ID of the user you are adding to the project |
Optional attributes
| roles | string[] | An array of role IDs to assign to a user |
Request
Response
Update project user attributes and, groups / roles, and permissions
Required attributes
| projectId | string | Your project ID |
| projectUserId | string | The ID of the project user to update |
Optional attributes
| roles | string[] | An array of role IDs to assign to a user |
| tags | string[] | An array of tags to assign to a user |
Request
Response
Removes a user from a project. The project owner cannot be removed. To remove a project owner you must first transfer project ownership to another project user.
Required attributes
| projectId | string | Your project ID |
| projectUserId | string | The ID of the project user to remove |
Optional attributes
| None |
Request
Response