SpiraPlan: REST Web Service (v5.0)

See all operations

PUT: projects/{project_id}/users


Updates the user's role on a specific project

How to Execute

To access this REST web service, you need to use the following URL (make sure to replace any parameters (eg {project_id}) with the relevant value (eg 1):


Request Parameters

Name Description
project_id The id of the current project

Request Body

Property Description
ProjectId The ID of the project
ProjectRoleId The ID of the role the user has on the project
ProjectRoleName The name of the role the user has on the project Read-only
UserId The id of the user
FirstName The first (given) name of the user
LastName The last name (surname) of the user
MiddleInitial The middle initials of the user
UserName The login used by the user
LdapDn The LDAP Distinguished Name for the user (null for non-LDAP users)
EmailAddress The email address of the user
Admin Whether the user is a system administrator
Active Whether the user is active in the system
Department The department of the user
Approved Is this user approved by the system administrator
Locked Is this user locked-out of their account
RssToken This is the RSS token for this user For security reasons, you have to access the API as a system administrator to retrieve this field
FullName The full name of the user concatenated (First + Middle + Last)

Return Data

The JSON and XML examples below show the shape of one entry that will be returned. It does not show an example of how that entry will be populated.