Connectors Reference
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: Production |
Tier: Standard |
Version: 1.0.1 |
|
Name |
Summary |
|
CreateOffice365Group (CreateOffice365GroupParameterBody body) |
Create Office 365 group |
|
Create security group |
|
|
Get group |
|
|
Get user |
|
|
Update user |
|
|
Refresh tokens |
|
|
Get groups of a user (V2) |
|
|
Create user |
|
|
GetGroupMembers (string id, [advanced][Optional]integer $top) |
Get group members |
|
Remove Member From Group |
|
|
Add user to group |
|
|
CheckMemberGroupsV2 (string id, CheckMemberGroups_Request body) |
Check group membership (V2) |
|
Assign manager |
|
|
Create group |
|
|
Get groups of a user |
|
|
CheckMemberGroups (string id, CheckMemberGroups_Request body) |
Check group membership |
|
Name |
Summary |
|
Name |
Summary |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Summary: Create Office 365 group
Description: Create an Office 365 group in your AAD tenant.
Syntax:
AzureAD.CreateOffice365Group (CreateOffice365GroupParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
body |
CreateOffice365GroupParameterBody
|
|
True |
Returns:
Type:CreateGroup_Response
Summary: Create security group
Description: Create a security group in your AAD tenant.
Syntax:
AzureAD.CreateSecurityGroup (CreateSecurityGroupParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
body |
CreateSecurityGroupParameterBody
|
|
True |
Returns:
Type:CreateGroup_Response
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
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
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 |
|
|
True |
Returns:
Summary: Refresh tokens
Description: Invalidate all refresh tokens for a user
Syntax:
AzureAD.RefreshTokens (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:
Summary: Get groups of a user (V2)
Description: Get the groups a user is a member of.
Syntax:
AzureAD.GetMemberGroupsV2 (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 |
|
|
True |
Returns:
Type:GetMemberGroups_Response_V2
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 |
|
|
True |
Returns:
Type:GetUser_Response
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:
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:
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 |
|
|
True |
Returns:
Summary: Check group membership (V2)
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.CheckMemberGroupsV2 (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 |
|
|
True |
Returns:
Type:GetMemberGroups_Response_V2
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 |
|
|
True |
Returns:
Summary: Create group
Description: Create a group in your AAD tenant.
Syntax:
AzureAD.CreateGroup (CreateGroupParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
body |
|
|
True |
Returns:
Type:CreateGroup_Response
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 |
|
|
True |
Returns:
Type:array of (string)
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 |
|
|
True |
Returns:
Type:array of (string)
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'). |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
groupIds |
array of (string)
|
|
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. |
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 |
|
|
string |
|
|
mailEnabled |
boolean mailEnabled |
mailEnabled |
|
mailNickname |
string(date-time) mailNickname |
mailNickname |
|
onPremisesLastSyncDateTime |
string onPremisesLastSyncDateTime |
onPremisesLastSyncDateTime |
|
onPremisesSecurityIdentifier |
string onPremisesSecurityIdentifier |
onPremisesSecurityIdentifier |
|
onPremisesSyncEnabled |
boolean onPremisesSyncEnabled |
onPremisesSyncEnabled |
|
proxyAddresses |
array of (string) proxyAddresses |
proxyAddresses |
|
renewedDateTime |
string(date-time) renewedDateTime |
renewedDateTime |
|
securityEnabled |
boolean securityEnabled |
securityEnabled |
|
visibility |
string visibility |
visibility |
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)
|
For Office 365, group type is 'Unified'. |
|
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. |
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. |
|
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. |
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 |
|
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'. |
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. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
@odata.nextLink |
string Next link |
Link to get next page of results |
|
value |
array of (GetUser_Response) Group Members |
Array of users that are members of the group. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
@odata.id |
string User Id |
Unique identifer of a user (Ex. '5e6cf5c7-b511-4842-6aae-3f6b8ae5e95b'). |
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. |
|
|
string |
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 |
boolean 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). |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
securityEnabledOnly |
boolean Security Enabled Only |
Determines if only security enabled groups should be fetched. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
value |
array of (string)
|
|
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. |
|
|
string |
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. |
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)
|
|
|
onPremisesExtensionAttributes |
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
extensionAttribute1 |
string First customizable extension attribute |
First customizable extension attribute. |
|
extensionAttribute2 |
string Second customizable extension attribute |
Second customizable extension attribute. |
|
extensionAttribute3 |
string Third customizable extension attribute |
Third customizable extension attribute. |
|
extensionAttribute4 |
string Fourth customizable extension attribute |
Fourth customizable extension attribute. |
|
extensionAttribute5 |
string Fifth customizable extension attribute |
Fifth customizable extension attribute. |
|
extensionAttribute6 |
string Sixth customizable extension attribute |
Sixth customizable extension attribute. |
|
extensionAttribute7 |
string Seventh customizable extension attribute |
Seventh customizable extension attribute. |
|
extensionAttribute8 |
string Eighth customizable extension attribute |
Eighth customizable extension attribute. |
|
extensionAttribute9 |
string Ninth customizable extension attribute |
Ninth customizable extension attribute. |
|
extensionAttribute10 |
string Tenth customizable extension attribute |
Tenth customizable extension attribute. |
|
extensionAttribute11 |
string Eleventh customizable extension attribute |
Eleventh customizable extension attribute. |
|
extensionAttribute12 |
string Twelfth customizable extension attribute |
Twelfth customizable extension attribute. |
|
extensionAttribute13 |
string Thirteenth customizable extension attribute |
Thirteenth customizable extension attribute. |
|
extensionAttribute14 |
string Fourteenth customizable extension attribute |
Fourteenth customizable extension attribute. |
|
extensionAttribute15 |
string Fifteenth customizable extension attribute |
Fifteenth customizable extension attribute. |