SpiraTeam: REST Web Service (v4.0)

See all operations

POST: users?password={password}&password_question={password_question}&password_answer={password_answer}&project_id={project_id}&project_role_id={project_role_id}

Description

Creates a new user in the system and adds them to the current project as the specified role

How to Execute

To access this REST web service, you need to use the following URL:

http://api.inflectra.com/Spira/Services/v4_0/RestService.svc/users?password={password}&password_question={password_question}&password_answer={password_answer}&project_id={project_id}&project_role_id={project_role_id}

Request Parameters

Name Description
password The new password for the user (leave empty if an LDAP user)
password_question The new password retrieval question for the user (leave empty if an LDAP user)
password_answer The new password retrieval answer for the user (leave empty if an LDAP user)
project_id The id of the project for the user to be added (leave as null to not add user to current project)
project_role_id The project role for the user (leave as null to not add user to current project)

Request Body

Property Description
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.

Property Description
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)