SecurityService API

Use this web service to sign in to a project and obtain an authorization key for the other ALM web services.


Protocol: SOAP, WebService

Link: http://<host>/api/securityservice

WSDL description (document/literal): http://<host>/api/securityservice?wsdl

WSDL description (rpc/encoded): http://<host>/api/securityservice?wsdl&style=rpc&use=encoded

Methods

Name Return value Purpose

login (string userName, string userPassword, string projectName)

Token

Signs the user in to the project.

  • the projectName variable can contain the project code name. In that case the user is signed in inside the project and can get project data: Tasks, Issues, and so on.
  • if projectName is an empty string, the user is signed in to the system but cannot get project data.

Returns an object that contains authorization data.

Classes

Name Attribute Purpose

Token

Key

Key used to authorize the user when web service methods are called.


Examples (C#)

// авторизуемся в проекте
 security.SecurityService api = new security.SecurityService() { 
      Url = 'http://<host>/api/securityservice'
 };
 
 security.Token _token = api.login("guest", "guest", "development");


Search results