Connectors Reference

Azure AD

Azure Active Directory is an Identity and Access Management cloud solution that extends your on-premises directories to the cloud and provides single sign-on to thousands of cloud (SaaS) apps and access to web apps you run on-premises.

 

Status: Preview

Tier: Standard

Version: 1.0.0

 

Actions:

Name

Summary

CreateGroup (CreateGroupParameterBody body)

Create group

GetGroup (string id)

Get group

GetUser (string id)

Get user

UpdateUser (string id, UpdateUser_Request body)

Update user

GetMemberGroups (string id, GetMemberGroups_Request body)

Get groups of a user

CreateUser (CreateUser_Request body)

Create user

GetGroupMembers (string id, [advanced][Optional]integer $top)

Get group members

RemoveMemberFromGroup (string groupId, string memberId)

Remove Member From Group

AddUserToGroup (string id, GetGroup_Request body)

Add user to group

CheckMemberGroups (string id, CheckMemberGroups_Request body)

Check group membership

AssignManager (string id, AssignManager_Request body)

Assign manager

 

Triggers:

Name

Summary

 

Objects:

Name

Summary

AssignManager_Request

 

CheckMemberGroups_Request

 

CreateGroupParameterBody

 

CreateGroupResponse

 

CreateUser_Request

 

GetGroupMembers_Response

 

GetGroup_Request

 

GetGroup_Response

 

GetMemberGroups_Request

 

GetUser_Response

 

UpdateUser_Request

 

 

Actions:

CreateGroup

Summary: Create group

Description: Create a group in your AAD tenant.

 

Syntax:

AzureAD.CreateGroup (CreateGroupParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

CreateGroupParameterBody

 

 

True

 

Returns:

††††††††† Type:CreateGroupResponse

 

GetGroup

Summary: Get group

Description: Get details for a group.

 

Syntax:

AzureAD.GetGroup (string id)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(Group Id)

Unique identifer of a group (Ex. '40639f36-46a6-73a6-91e2-9584b7913429').

True

 

Returns:

††††††††† Type:GetGroup_Response

 

GetUser

Summary: Get user

Description: Get details for a user.

 

Syntax:

AzureAD.GetUser (string id)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(User Id or Principal Name)

Unique identifier of a user (Ex. 'user@tennant.onmicrosoft.com' or '5f6ce5c7-b521-4842-9bbe-3f6d5aa5e35b').

True

 

Returns:

††††††††† Type:GetUser_Response

 

UpdateUser

Summary: Update user

Description: Update the info for a user.

 

Syntax:

AzureAD.UpdateUser (string id, UpdateUser_Request body)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(User Id or Principal Name)

Unique identifier of a user (Ex. 'user@tennant.onmicrosoft.com' or '5f6ce5c7-b521-4842-9bbe-3f6d5aa5e35b').

True

body

UpdateUser_Request

 

 

True

 

Returns:

 

GetMemberGroups

Summary: Get groups of a user

Description: Get the groups a user is a member of.

 

Syntax:

AzureAD.GetMemberGroups (string id, GetMemberGroups_Request body)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(User Id or Principal Name)

Unique identifier of a user (Ex. 'user@tennant.onmicrosoft.com' or '5f6ce5c7-b521-4842-9bbe-3f6d5aa5e35b').

True

body

GetMemberGroups_Request

 

 

True

 

Returns:

††††††††† Type:array of (string)

 

CreateUser

Summary: Create user

Description: Create a new user in your AAD tenant.

 

Syntax:

AzureAD.CreateUser (CreateUser_Request body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

CreateUser_Request

 

 

True

 

Returns:

††††††††† Type:GetUser_Response

 

GetGroupMembers

Summary: Get group members

Description: Get the users who are members of a group.

 

Syntax:

AzureAD.GetGroupMembers (string id, [advanced][Optional]integer $top)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(Group Id)

Unique identifer of a group (Ex. '40639f36-46a6-73a6-91e2-9584b7913429').

True

$top

integer(int32)

(Top)

Limit on the number of results to return (default = all).

False

 

Returns:

††††††††† Type:GetGroupMembers_Response

 

RemoveMemberFromGroup

Summary: Remove Member From Group

Description: Remove Member From Group

 

Syntax:

AzureAD.RemoveMemberFromGroup (string groupId, string memberId)

 

Parameters:

Name

Type

Summary

Required

Related Action

groupId

string

(Group Id)

The Id of the group.

True

memberId

string

(Member Id)

The Id of the member.

True

 

Returns:

 

AddUserToGroup

Summary: Add user to group

Description: Add a user to a group in this AAD tenant.

 

Syntax:

AzureAD.AddUserToGroup (string id, GetGroup_Request body)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(Group Id)

Unique identifer of a group (Ex. '40639f36-46a6-73a6-91e2-9584b7913429').

True

body

GetGroup_Request

 

 

True

 

Returns:

 

CheckMemberGroups

Summary: Check group membership

Description: If the user is a member of the given group, the result will contain the given id. Otherwise the result will be empty.

 

Syntax:

AzureAD.CheckMemberGroups (string id, CheckMemberGroups_Request body)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(User Id or Principal Name)

Unique identifier of a user (Ex. 'user@tennant.onmicrosoft.com' or '5f6ce5c7-b521-4842-9bbe-3f6d5aa5e35b').

True

body

CheckMemberGroups_Request

 

 

True

 

Returns:

††††††††† Type:array of (string)

 

AssignManager

Summary: Assign manager

Description: Assign a manager for a user.

 

Syntax:

AzureAD.AssignManager (string id, AssignManager_Request body)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(User Id or Principal Name)

Unique identifier of a user (Ex. 'user@tennant.onmicrosoft.com' or '5f6ce5c7-b521-4842-9bbe-3f6d5aa5e35b').

True

body

AssignManager_Request

 

 

True

 

Returns:

 


 

AssignManager_Request

Summary:

Description:

 

††††††††† Properties:

Name

Type

Summary

@odata.id

string

User Id of the Manager

Unique identifer of a manager (Ex. '5f6cf5c7-a561-4842-9aae-3e6d8ce5e95b').


 

CheckMemberGroups_Request

Summary:

Description:

 

††††††††† Properties:

Name

Type

Summary

groupIds

array of (string)

 

 


 

CreateGroupParameterBody

Summary:

Description:

 

††††††††† Properties:

Name

Type

Summary

displayName

string

Display Name

Display name of the new group.

description

string

Description

Description of the new group.

mailNickname

string

Mail Nickname

The mail alias of the new group.

groupTypes

array of (string)

 

Choose 'Unified' for an O365 group. Choose 'None' for a security group.

securityEnabled

boolean

Security Enabled

True if the new group is a security group.

mailEnabled

boolean

Mail Enabled

True if the new group is a mailing group.


 

CreateGroupResponse

Summary:

Description:

 

††††††††† Properties:

Name

Type

Summary

@odata.context

string

@odata.context

@odata.context

id

string

id

id

deletedDateTime

string

deletedDateTime

deletedDateTime

classification

string

classification

classification

createdDateTime

string(date-time)

createdDateTime

createdDateTime

description

string

description

description

displayName

string(date-time)

displayName

displayName

groupTypes

array of (string)

groupTypes

groupTypes

mail

string

mail

mail

mailEnabled

boolean

mailEnabled

mailEnabled

mailNickname

string(date-time)

mailNickname

mailNickname

onPremisesLastSyncDateTime

string

onPremisesLastSyncDateTime

onPremisesLastSyncDateTime

onPremisesSecurityIdentifier

string

onPremisesSecurityIdentifier

onPremisesSecurityIdentifier

onPremisesSyncEnabled

string

onPremisesSyncEnabled

onPremisesSyncEnabled

proxyAddresses

array of (string)

proxyAddresses

proxyAddresses

renewedDateTime

string(date-time)

renewedDateTime

renewedDateTime

securityEnabled

boolean

securityEnabled

securityEnabled

visibility

string

visibility

visibility


 

CreateUser_Request

Summary:

Description:

 

††††††††† Properties:

Name

Type

Summary

accountEnabled

boolean

Account Enabled

True if the new account should be enabled when it is created.

displayName

string

Display Name

The name displayed in the address book for the user.

mailNickname

string

Mail Nickname

The mail alias for the user.

passwordProfile

PasswordProfile

 

passwordProfile

userPrincipalName

string

User Principal Name

The user principal name (UPN) of the user.

givenName

string

Given Name

The user's given name (first name).

surname

string

Surname

The user's surname (family name or last name).

businessPhones

array of (string)

 

 

department

string

Department

The name for the department in which the user works.

jobTitle

string

Job Title

The userís job title.

mobilePhone

string

Mobile Phone

The mobile phone number for the user in any format such as '1 (234) 567-8910'.

officeLocation

string

Office Location

The office location in the user's place of business.

preferredLanguage

string

Preferred Language

The preferred language for the user. Should follow ISO 639-1 Code; for example 'en-US'.

 

PasswordProfile

Summary:

Description: passwordProfile

 

††††††††† Properties:

Name

Type

Summary

password

string

Password

The password for the user. The user will be required to change the password on the next login.

 


 

GetGroupMembers_Response

Summary:

Description:

 

††††††††† Properties:

Name

Type

Summary

value

array of (GetUser_Response)

Group Members

Array of users that are members of the group.


 

GetGroup_Request

Summary:

Description:

 

††††††††† Properties:

Name

Type

Summary

@odata.id

string

User Id

Unique identifer of a user (Ex. '5e6cf5c7-b511-4842-6aae-3f6b8ae5e95b').


 

GetGroup_Response

Summary:

Description:

 

††††††††† Properties:

Name

Type

Summary

id

string

Id

The unique identifier for the group.

deletedDateTime

string(date-time)

Deleted Date Time

Date-time the group was deleted.

createdDateTime

string(date-time)

Created Date Time

Date-time the group was created.

description

string

Description

An optional description for the group.

displayName

string

Display Name

The display name for the group.

mail

string

Mail

The SMTP address for the group.

mailEnabled

boolean

Mail Enabled

True if the group is mail-enabled.

onPremisesLastSyncDateTime

string(date-time)

On Premises Last Sync Date Time

A date-time indicating the last time at which the group was synced with the on-premises directory.

onPremisesSyncEnabled

string

On Premises Sync Enabled

True if this group is synced from an on-premises directory.

securityEnabled

boolean

Security Enabled

True if the group is a security group.

visibility

string

Visibility

Visibility of the group (public or private).


 

GetMemberGroups_Request

Summary:

Description:

 

††††††††† Properties:

Name

Type

Summary

securityEnabledOnly

boolean

Security Enabled Only

Determines if only security enabled groups should be fetched.


 

GetUser_Response

Summary:

Description:

 

††††††††† Properties:

Name

Type

Summary

id

string

Id

A unique identifer for the user.

businessPhones

array of (string)

Business Phones

 

displayName

string

Display Name

The name displayed in the address book for the user.

givenName

string

Given Name

The given name (first name) of the user.

jobTitle

string

Job Title

The userís job title.

mail

string

Mail

The SMTP address for the user.

mobilePhone

string

Mobile Phone

The primary cellular telephone number for the user.

officeLocation

string

Office Location

The office location in the user's place of business.

preferredLanguage

string

Preferred Language

The preferred language for the user. Should follow ISO 639-1 Code; for example 'en-US'.

surname

string

Surname

The user's surname (family name or last name).

userPrincipalName

string

User Principal Name

The user principal name (UPN) of the user.


 

UpdateUser_Request

Summary:

Description:

 

††††††††† Properties:

Name

Type

Summary

userPrincipalName

string

User Principal Name

The user principal name (UPN) of the user.

displayName

string

Display Name

The name displayed in the address book for the user.

mailNickname

string

Mail Nickname

The mail alias for the user.

givenName

string

Given Name

The given name (first name) of the user.

surname

string

Surname

The user's surname (family name or last name).

accountEnabled

boolean

Account Enabled

True if the new account should be enabled.

jobTitle

string

Job Title

The userís job title.

department

string

Department

The name for the department in which the user works.

mobilePhone

string

Mobile Phone

The mobile phone number for the user in any format such as '1 (234) 567-8910'.

officeLocation

string

Office Location

The office location in the user's place of business.

preferredLanguage

string

Preferred Language

The preferred language for the user. Should follow ISO 639-1 Code; for example 'en-US'.

businessPhones

array of (string)