Hide Table of Contents
PDM Pro API Web Service
Postapi/{vaultName}/authenticate
PDM Pro API Web Service > Authentication Resource Group : api/{vaultName}/authenticate (Post)
Description
POST: api/{VaultName}/authenticate Use for the authenticate to get authentication token

 

Authenticates the specified login for the specified vault and returns the authentication token and status.

Parameters
NameDescriptionData Type
(URI parameter) Name of the vault (required)string
(Body) Login namestring
(Body) Passwordstring

(Response) Software version information:

  • Major
  • Minor
  • Build
  • Revision
  • MajorRevision
  • MinorRevision

Member of HttpResponseMessage model

Version

(Response) Authentication token

 

Member of HttpResponseMessage model

 

HttpContent

(Response) Status code; see https://en.wikipedia.org/wiki/List_of_HTTP_status_codes

 

Member of HttpResponseMessage model

 

HttpStatusCode

(Response) Reason

 

Member of HttpResponseMessage model

 

string

(Response) Collection of headers

 

Member of HttpResponseMessage model

 

Collection of Object

(Response) An HttpRequestMessage object that consists of:

   Version (Version model)

   Content (HttpContent object consisting of Headers array)

   Method (HttpMethod object consisting of Method string)

   RequestUri (URI)

   Headers (Array of objects)

   Properties (Dictionary of string [key] and Object [value]

 

Member of HttpResponseMessage model

 

HttpRequestMessage

(Response) True if successful, false if not

 

Member of HttpResponseMessage model

 

boolean
Request (application/json, text/json)

Sample Data

{
  "Username": "sample string 1",
  "Password": "sample string 2"
}
Request (application/xml, text/xml)

Sample Data

<UserCredentials xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SWPDM.Models">
  <Password>sample string 2</Password>
  <Username>sample string 1</Username>
</UserCredentials>
Request (application/x-www-form-urlencoded)

Example

C# console application:

//============================================================

// Preconditions:

// 1. A SOLIDWORKS PDM Professional Web Server is running on a host machine web site.

// 2. SOLIDWORKS PDM Professional is installed and configured with a vault, vault view, and Admin user.

// 3. Create a C# console project in Visual Studio.

// 4. Copy the code below into Program.cs.

// 5. Change the namespace as needed. Change "localhost" and the port in this application's Url string to your host machine's name and available port.

// 6. Change the vaultName and loginuser.password assignments to your vault name and Admin password.

// Postconditions:

// 1. Authenticates the logged-in user. Deserializes the authentication result to create a JSON Web Tokens (JWT) Bearer token.

// 2. Sends GET requests with the Bearer token to obtain all folders and all users in the vault.

// 3. Inspect the console.

//================================================================

using Newtonsoft.Json;

using System;

using System.Collections.Generic;

using System.IO;

using System.Linq;

using System.Net;

using System.Text;

using System.Threading.Tasks;

using System.Web.Script.Serialization;

namespace ConsoleWebAPIClientHTTPWebReq

{

    class Program

    {

      

        const string Url = "http://localhost:8082/api/";

        static string JwtString = string.Empty;

        static bool Authorized = false;

        const string vaultName = "2_24_2021";      

 

        static void Main(string[] args)

        {

            try

            {

                string urlLogin = Url + vaultName + "/authenticate";            

                UserCredentials loginUser = new UserCredentials();

                loginUser.username = "Admin";

                loginUser.password = String.Empty;

                string loginResult = AuthenticateRequest(urlLogin, loginUser);

                Authorized = AuthorizationCode(loginResult);

                if (Authorized)

                {

                    // Get all the folders in the root folder of the vault

                    Console.WriteLine(" All folders : \n");

                    string urlBrowseAllFolder = Url + vaultName +"/folders/1/browse";                

                

                    List<ObjectInfo> vaultFolderItems = GetVaultItems(urlBrowseAllFolder);

                    foreach (var item in vaultFolderItems)

                    {

                        Console.WriteLine(" Folder Name :" + item.Name);

                    }

                   

                    // Get all the users in the vault

                    Console.WriteLine("\n Vault Users : \n");                   

                    string urlAllUsers = Url + vaultName + "/users"; 

                    vaultFolderItems = GetVaultItems(urlAllUsers);

                    foreach (var item in vaultFolderItems)

                    {

                        Console.WriteLine(" User Name :" + item.FullName);

                        Console.WriteLine(" User ID :" + item.UserInfo.UserId.ToString());

                    }

                }

            }

            catch (Exception ex)

            {

                Console.WriteLine(ex.ToString());

            }

        }

 

 

        private static List<ObjectInfo> GetVaultItems(string Url)

        {

            var result = GetResultOfAPI<List<ObjectInfo>>(Url);

 

            return result ?? new List<ObjectInfo>();

        }

 

 

        public static T GetResultOfAPI<T>(string data)

        {

            T model = default(T);

            string result = GetRequest(data, JwtString);

            try

            {

                // Convert the GET returned string to a list

                // of objects of type specified in GetVaultItems

                model = ConvertToType<T>(result);

            }

            catch (Exception ex)

            {

                Console.WriteLine(ex.ToString());

            }

 

            return model;

        }

 

 

 

        public static T ConvertToType<T>(string response)

        {

 

            // Deserialize the response and convert it to the specified type

 

                           return JsonConvert.DeserializeObject<T>(response);

        }

 

 

        public static bool AuthorizationCode(string result)

        {      

            try

            {

                var jsonConvert = new JavaScriptSerializer();

 

                // Deserialize the authentication result

                // and convert it to a JSON Web Token

                var temp = (Dictionary<string, object>)jsonConvert.DeserializeObject(result);

                JwtString = temp["JwtString"].ToString();             

            }

            catch (Exception ex)

            {

               Console.WriteLine(ex.ToString());

            }

       

            // Authorize, if the Bearer token is not empty of null

 

            Authorized = !String.IsNullOrEmpty(JwtString);

 

            return Authorized;

        }

 

        public static string AuthenticateRequest(string url, UserCredentials user)

        {

            string result = String.Empty;

            var jsonConvert = new JavaScriptSerializer();

            string json = jsonConvert.Serialize(user);

            var body = Encoding.UTF8.GetBytes(json);

            HttpWebRequest request = (HttpWebRequest)WebRequest.Create(url);

            request.Method = "POST";

            request.ContentType = "application/json";

            request.ContentLength = body.Length;

            // Get a Stream object to send request data

           // using the Stream.Write method

 

            using (Stream stream = request.GetRequestStream())

            {

                stream.Write(body, 0, body.Length);

                stream.Close();

            }

            try

            {

                // Sends the HttpWebRequest and waits for the response

 

                                   using (HttpWebResponse response = (HttpWebResponse)request.GetResponse())

                {

 

                // Gets the stream associated with the response

                // and pipes it to a higher-level stream reader
                // with the required encoding format

                    using (var sr = new StreamReader(response.GetResponseStream()))

                    {

                        result = sr.ReadToEnd();

                    }

 

                    response.Close();

                }

            }

            catch (WebException ex)

            {

                if (ex.Response == null)

                    throw;

                using (WebResponse response = ex.Response)

                {

                    using (var sr = new StreamReader(response.GetResponseStream()))

                    {

                        result = sr.ReadToEnd();

                    }

                }

            }

 

            return result;

        }

 

 

        public static string GetRequest(string url, string jwt)

        {

            // Initialize an HttpWebRequest

 

            HttpWebRequest req = (HttpWebRequest)WebRequest.Create(url);

            req.Accept = "application/json";

            req.Headers.Add("Authorization", "Bearer " + jwt);

            string result = String.Empty;

            try

            {

               // Sends the HttpWebRequest and waits for the response

 

               HttpWebResponse resp = (HttpWebResponse)req.GetResponse();

             

               // Gets the stream used to read the body of the response

 

                using (var sr = new StreamReader(resp.GetResponseStream()))

                {

                    result = sr.ReadToEnd();

                }

            }

            catch (WebException ex)

            {

                if (ex.Response == null)

 

                    return result;

                using (WebResponse response = ex.Response)

                {

                    using (var sr = new StreamReader(response.GetResponseStream()))

                    {

                        result = sr.ReadToEnd();

                    }

                }

            }

 

            return result;

        }

    }

 

 

   

    public struct UserCredentials

    {

       public string password;

       public string username;

    }

 

    public class ObjectInfo

    {

        public int Id { get; set; }

        public string Name { get; set; }

        public long Size { get; set; }

        public DateTime ModifiedDate { get; set; }

        public int Version { get; set; }

        public string State { get; set; }

        public int StateId { get; set; }

        public int ParentFolderId { get; set; }

        public string Path { get; set; }

        public ObjectType Type { get; set; }

        public int IsLocked { get; set; }

        public int LockedBy { get; set; }

        public int IsShared { get; set; }

        public int IsToolbox { get; set; }

        public int IsDeleted { get; set; }

        public UserInfo UserInfo { get; set; }

        public string FullName { get; set; }

        public string Initials { get; set; }

    }

 

 

    public enum ObjectType

    {

        Folder = 0,

        File = 1,

        Bom = 3

    }

 

 

    public class UserInfo

    {

        public string UserName { get; set; }

        public int UserId { get; set; }

    }

}

Remarks

Read Getting Started.

For more information about the data types used in authentication:

See Also


Provide feedback on this topic

SOLIDWORKS welcomes your feedback concerning the presentation, accuracy, and thoroughness of the documentation. Use the form below to send your comments and suggestions about this topic directly to our documentation team. The documentation team cannot answer technical support questions. Click here for information about technical support.

* Required

 
*Email:  
Subject:   Feedback on Help Topics
Page:   api/{vaultName}/authenticate (Post)
*Comment:  
*   I acknowledge I have read and I hereby accept the privacy policy under which my Personal Data will be used by Dassault Systèmes

Print Topic

Select the scope of content to print:




x

We have detected you are using a browser version older than Internet Explorer 7. For optimized display, we suggest upgrading your browser to Internet Explorer 7 or newer.

 Never show this message again
x

Web Help Content Version: API Help (English only) 2022 SP02

To disable Web help from within SOLIDWORKS and use local help instead, click Help > Use SOLIDWORKS Web Help.

To report problems encountered with the Web help interface and search, contact your local support representative. To provide feedback on individual help topics, use the “Feedback on this topic” link on the individual topic page.