Get user information using REST

<< Click to Display Table of Contents >>

Navigation:  Environments identity and access management > Synchronizing users > Synchronizing users using SCIM's REST methods > Getting started with user sync using REST >

Get user information using REST

To get a user's information using the Bizagi SCIM you must use the service described in this article. The following example uses POSTMAN as the client, but you can invoke this service from any client compatible with RESTful services with OAUth 2.0 authentication.


Before continue, review the Getting started with the synchronization procedure section.


Resource URL



HTTP Method




OAuth 2.0



The username or ID ( guidUser from the WFUser table) sent in the URL.


URL Example:



This gets the information of the username MarkW. If you have multiple domains you can send this parameter using this format




The final execution in POSTMAN looks like this:




The response is a JSON with the SCIM schema and the information is saved in Bizagi.


Ordering your results

By default, Bizagi returns the first 100 users. However, you can look for specific pages, sort, or increase the results per page.  The number of results, items per page, and startIndex are displayed in the JSON.


You can change any of these values in the invocation of the method, Where


startIndex: Indicates the first page to be displayed in the result. By default is one, and values less than one are considered as one.

count: Number of maximum results. This value cannot be greater than 500.

sortBy: Indicates the attribute used to sort the results. See which attributes you can use. If you use any name attribute, Bizagi sorts the result using the attribute full name.

sortOrder: Indicates the sorting order. You can use two values, ascending or descending.


Concatenate this at the end of the invocation URL using the ? symbol, For example,




Consult specific attributes

If you want to obtain only a set of attributes in the result, you can send in the invocation a list of the wanted attributes. To do that use the following command:




Concatenate this at the end of the invocation URL using the ? symbol. See the valid attributes to use in SCIM. for example:




if you need to set the order parameters and set specific attributes, concatenate both commands with the & symbol For example:




Using filters

You can get a subset of results using filters. To filter an invocation use the following command:


filter= [Parameter] [Operator] "[Value]"



Parameter: attribute of the SCIM schema. See the valid attributes.

Value: Value of the attribute you are using as a filter.

Operator: filter operator. The following table shows supported operators:







Not equal


Grater than


Greater or equal than


Less than


Less or equal than


You can add multiple conditions using logical operators:


Logical Operator



The method shows results only if both conditions are meet.


The method shows results only if any of the conditions are meet.


You can also group conditions using parenthesis ( ). Filters are executed in the following order:


1.Grouped conditions with parenthesis

2.Logic operators. The operator and has priority over or.

3.Operators using attributes.



In Bizagi you can only register one email and one mobile phone. Therefore, filters using any subtype of these attributes are ignored. For example, filters using work phone or primary phone (or email), provide the same results because they are all compared to the contactEmail and contactCell attributes of Bizagi.