Skip to content
background-image background-image

Graph Api - Get Users

[ | version 3.0]

Connector

The connector is permitted for use of the platform background agent.

Connector processing type: Both (Row by row & Bulk), Default type: Row by row!

This connector allows to get users the given organization from Azure Active directory through Graph API. More info in documentation 1 with testing environment 2.

Timeout

The number of seconds to wait before terminating the request. The default value is set to 100.

IgnoreSSLCertificates

Ignore all SSL certificates.

Authentication Type

Authorization flow for Graph API. More info in Documentation. Following table shows supported flows:

Authorization flow Description More info
Resource Owner Password Credentials Allows an application to sign in the user by directly handling their password Documentation
Client credentials flow Access web-hosted resources by using the identity of an application (more secure) Documentation

TenantID

An immutable, non-reusable identifier that identifies the directory tenant that issued the token. You can use this value to access tenant-specific directory resources in a multi-tenant application.

ClientID

Client ID visible in Azure portal in overview of registered AAD application.

ClientSecret

Client secret visible in Azure portal in 'Certificates & secrets' tab of registered AAD application.

UserName

Client user name

Password

Client password

Scope

Authorization scope. Usually optional and defaulted in connector. See more info about authorization flows in Documentation.

Filter

You can use the '$filter' and $search query parameters to get a subset of users from this collection as well. To filter guest users, you can add ?$filter=userType eq 'guest' or get users with given name 'Adele' ?$filter=givenName eq 'Adele'

Using placeholders

For other string properties in configuration you can use single cell placeholder which can be wrapped by other text. For these configuration properties placeholders are replaced just by first row of input data but it will work for whole input if sequential access is used.

${input.UserName}

Configurations

GraphAPI Connection configuration

Timeout

The number of seconds to wait before terminating the request. The default value is set to 100.

Ignore SSL Certificates

Ignore all SSL certificates.

Authentication Type

Authorization flow for Graph API. More info in Documentation.

Tenant ID

An immutable, non-reusable identifier that identifies the directory tenant that issued the token. You can use this value to access tenant-specific directory resources in a multi-tenant application.

Client ID

Client ID visible in Azure portal in overview of registered AAD application.

Client Secret

Client secret visible in Azure portal in ''Certificates & secrets'' tab of registered AAD application.

Username

Client user name.

Password

Client password.

Scope

Authorization scope. Usually optional and defaulted in connector. See more info about authorization flows in Documentation.

GraphAPI Get Users configuration

Filter

You can use the ''$filter'' and $search query parameters to get a subset of users from this collection as well. To filter guest users, you can add ?$filter=userType eq ''guest'' or get users with given name ''Adele'' ?$filter=givenName eq ''Adele''

Input & Output Schema

Input

Connector doesn't require schema

Output

The result contains basic information about users and its business phones.

Graph Api Get Users Schema (ver. 1.0.0)

Column Data type Allow null
Id string Yes
DisplayName string Yes
GivenName string Yes
JobTitle string Yes
Mail string Yes
MobilePhone string Yes
OfficeLocation string Yes
PreferredLanguage string Yes
Surname string Yes
UserPrincipalName string Yes
BusinessPhones Graph Api Phone Schema 1.0.0 Yes

Graph Api Phone Schema (ver. 1.0.0)

Column Data type Allow null
Phone string Yes

Example output data

Id: String DisplayName: String GivenName: String JobTitle: String Mail: String MobilePhone: String OfficeLocation: String PreferredLanguage: String Surname: String UserPrincipalName: String BusinessPhones: Graph Api Phone Schema 1.0.0
170140e1-5408-4cc3-9e98-6dcec4515402 Adele Vance Adele Retail Manager AdeleV@2qvynb.onmicrosoft.com null 18/2111 en-US Vance AdeleV@2qvynb.onmicrosoft.com Phones data

Output headers data

Phone: String
+1 425 555 0109

where decoded response Content is:

{
    "Success":true
}

Release notes

3.0.3

  • Fixed shared nuget package versions.

3.0.2

  • Fixed right processing of nullable properties.