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.
If a user by the same UserName already exists, the ID of that existing user will be returned.
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):
https://api.inflectra.com/Spira/Services/v7_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
|
|
UserGuid
|
The guid 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)
|
|
LastUpdatedDate
|
|
|
LastLockoutDate
|
Last date this users account was locked out
|
|
LastActivityDate
|
Last date this users account did something
|
|
LastLoginDate
|
Last date this users account was logged in to
|
|
LastPasswordChange
|
Last date this users account password was changed
|
|
OrganizationName
|
Organization name of the user
|
|
OrganizationId
|
ID of the organization this user belongs to
|
|
EmailsEnabled
|
Whether or not a user has opted to recieve emails or not
|
|
ReportAdmin
|
Whether the user is a report admin
|
|
PortfolioViewer
|
Whether this user has permissions to view all portfolios
|
|
OAuthProvider
|
Name of the external OAuth provider being used to access this account
|
|
MutliFactorAuthentication
|
Whether this user is using Spira's integrated MFA implementation.
|
|
CustomProperties
|
The list of associated custom properties/fields for this user
Not currently used, but there for the future
|
|
ConcurrencyGuid
|
The field used to track optimistic concurrency to prevent edit conflicts
It's a GUID, but we use the string representation to make compatibility easier
|
|
CustomProperties
|
The list of associated custom properties/fields for this workspace
|
<RemoteUser xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Inflectra.SpiraTest.Web.Services.v7_0.DataObjects">
<ArtifactTypeId>0</ArtifactTypeId>
<ConcurrencyGuid i:nil="true" />
<CustomProperties i:nil="true" />
<Active>false</Active>
<Admin>false</Admin>
<Approved>false</Approved>
<CustomProperties i:nil="true" />
<Department i:nil="true" />
<EmailAddress i:nil="true" />
<EmailsEnabled>false</EmailsEnabled>
<FirstName i:nil="true" />
<FullName i:nil="true" />
<LastActivityDate i:nil="true" />
<LastLockoutDate i:nil="true" />
<LastLoginDate i:nil="true" />
<LastName i:nil="true" />
<LastPasswordChange i:nil="true" />
<LastUpdatedDate i:nil="true" />
<LdapDn i:nil="true" />
<Locked>false</Locked>
<MiddleInitial i:nil="true" />
<MutliFactorAuthentication>false</MutliFactorAuthentication>
<OAuthProvider i:nil="true" />
<OrganizationId i:nil="true" />
<OrganizationName i:nil="true" />
<PortfolioViewer>false</PortfolioViewer>
<ReportAdmin>false</ReportAdmin>
<RssToken i:nil="true" />
<UserGuid i:nil="true" />
<UserId i:nil="true" />
<UserName i:nil="true" />
</RemoteUser>
{"UserId":null,
"UserGuid":null,
"FirstName":null,
"LastName":null,
"MiddleInitial":null,
"UserName":null,
"LdapDn":null,
"EmailAddress":null,
"Admin":false,
"Active":false,
"Department":null,
"Approved":false,
"Locked":false,
"RssToken":null,
"FullName":null,
"LastUpdatedDate":null,
"LastLockoutDate":null,
"LastActivityDate":null,
"LastLoginDate":null,
"LastPasswordChange":null,
"OrganizationName":null,
"OrganizationId":null,
"EmailsEnabled":false,
"ReportAdmin":false,
"PortfolioViewer":false,
"OAuthProvider":null,
"MutliFactorAuthentication":false,
"CustomProperties":null,
"ArtifactTypeId":0,
"ConcurrencyGuid":null}
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
|
|
UserGuid
|
The guid 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)
|
|
LastUpdatedDate
|
|
|
LastLockoutDate
|
Last date this users account was locked out
|
|
LastActivityDate
|
Last date this users account did something
|
|
LastLoginDate
|
Last date this users account was logged in to
|
|
LastPasswordChange
|
Last date this users account password was changed
|
|
OrganizationName
|
Organization name of the user
|
|
OrganizationId
|
ID of the organization this user belongs to
|
|
EmailsEnabled
|
Whether or not a user has opted to recieve emails or not
|
|
ReportAdmin
|
Whether the user is a report admin
|
|
PortfolioViewer
|
Whether this user has permissions to view all portfolios
|
|
OAuthProvider
|
Name of the external OAuth provider being used to access this account
|
|
MutliFactorAuthentication
|
Whether this user is using Spira's integrated MFA implementation.
|
|
CustomProperties
|
The list of associated custom properties/fields for this user
Not currently used, but there for the future
|
|
ArtifactTypeId
|
The type of artifact that we have
|
|
ConcurrencyGuid
|
The field used to track optimistic concurrency to prevent edit conflicts
It's a GUID, but we use the string representation to make compatibility easier
|
|
CustomProperties
|
The list of associated custom properties/fields for this workspace
|
<RemoteUser xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Inflectra.SpiraTest.Web.Services.v7_0.DataObjects">
<ArtifactTypeId>0</ArtifactTypeId>
<ConcurrencyGuid i:nil="true" />
<CustomProperties i:nil="true" />
<Active>false</Active>
<Admin>false</Admin>
<Approved>false</Approved>
<CustomProperties i:nil="true" />
<Department i:nil="true" />
<EmailAddress i:nil="true" />
<EmailsEnabled>false</EmailsEnabled>
<FirstName i:nil="true" />
<FullName i:nil="true" />
<LastActivityDate i:nil="true" />
<LastLockoutDate i:nil="true" />
<LastLoginDate i:nil="true" />
<LastName i:nil="true" />
<LastPasswordChange i:nil="true" />
<LastUpdatedDate i:nil="true" />
<LdapDn i:nil="true" />
<Locked>false</Locked>
<MiddleInitial i:nil="true" />
<MutliFactorAuthentication>false</MutliFactorAuthentication>
<OAuthProvider i:nil="true" />
<OrganizationId i:nil="true" />
<OrganizationName i:nil="true" />
<PortfolioViewer>false</PortfolioViewer>
<ReportAdmin>false</ReportAdmin>
<RssToken i:nil="true" />
<UserGuid i:nil="true" />
<UserId i:nil="true" />
<UserName i:nil="true" />
</RemoteUser>
{"UserId":null,
"UserGuid":null,
"FirstName":null,
"LastName":null,
"MiddleInitial":null,
"UserName":null,
"LdapDn":null,
"EmailAddress":null,
"Admin":false,
"Active":false,
"Department":null,
"Approved":false,
"Locked":false,
"RssToken":null,
"FullName":null,
"LastUpdatedDate":null,
"LastLockoutDate":null,
"LastActivityDate":null,
"LastLoginDate":null,
"LastPasswordChange":null,
"OrganizationName":null,
"OrganizationId":null,
"EmailsEnabled":false,
"ReportAdmin":false,
"PortfolioViewer":false,
"OAuthProvider":null,
"MutliFactorAuthentication":false,
"CustomProperties":null,
"ArtifactTypeId":0,
"ConcurrencyGuid":null}