Adds a user to project
Parameter Type Description api_token string You can get the REST API from Settings > Advanced > API tokens. Body Parameters
Parameter Required Type Description email_id Yes string Email address of the new user invited_by Yes string The ID of the user that will be marked as an inviter associated_portal_role_id Yes string The portal role ID. To get the available roles in the project use the GET /roles endpoint. content_permissions Yes object Content permission of the user is_sso_user No boolean Specify if the user is a Single Sign-On user or not skip_sso_invitation_email No boolean If set to 'true', the invitation email will not be sent to the user. Applicable only for a Single Sign-On user. associated_groups No string List of group IDs the user is associated with. Body Parameters > content_permissions
Parameter Required Type Description associated_content_role_id Yes string The content role ID. To get the available roles in the project use the GET /roles endpoint. access_scope Yes object The access scope of the user Body Parameters > content_permissions > access_scope
Parameter Required Type Description access_level Yes number The access level for the user. 0-None, 1-Category, 2-Version, 3-Project, 4-Language categories Conditionally object List of category scope objects. The field is required when access_level is set to 1-Category project_versions Conditionally string List of project version IDs the reader has access to. Mandatory when access_level is set to 2-Version. languages Conditionally object List of language scope objects. The field is required when access_level is set to 4-Language. Body Parameters > content_permissions > access_scope > categories
Parameter Required Type Description category_id Yes string The category ID to which the user should be given access. project_version_id Yes string The project version id to which the category belongs. language_code Yes string The language to which the user should be given access. Body Parameters > content_permissions > access_scope > languages
Parameter Required Type Description project_version_id Yes string The project version ID to which the user should be given access. language_code Yes string The language to which the user should be given access. Sample Request
The ID returned will be the user_id. In the case of SSO users, the id returned will be a temporary invitation id. Only when the user logs into the application a user account will be created.
Was this article helpful?
Thank you for your feedback! Our team will get back to you