Documentation Index Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt
Use this file to discover all available pages before exploring further.
Server path: /microsoft-active-directory-groups | Type: Application | PCID required: Yes
microsoft_active_directory_groups_add_group_member
Add a member to a group
Parameters:
Parameter Type Required Default Description group_idstring Yes — Group ID (GUID) @odata.idstring Yes — Full URL of the directory object to add (e.g. https://graph.microsoft.com/v1.0/users/{user-id} ;)
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"group_id" : {
"type" : "string" ,
"description" : "Group ID (GUID)"
},
"@odata.id" : {
"type" : "string" ,
"description" : "Full URL of the directory object to add (e.g. https://graph.microsoft.com/v1.0/users/{user-id})"
}
},
"required" : [
"PCID" ,
"group_id" ,
"@odata.id"
]
}
microsoft_active_directory_groups_add_group_owner
Add an owner to a group
Parameters:
Parameter Type Required Default Description group_idstring Yes — Group Id @odata.idstring Yes — Full URL of the owner (e.g. https://graph.microsoft.com/v1.0/users/{user-id} ;)
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"group_id" : {
"type" : "string" ,
"description" : "Group Id"
},
"@odata.id" : {
"type" : "string" ,
"description" : "Full URL of the owner (e.g. https://graph.microsoft.com/v1.0/users/{user-id})"
}
},
"required" : [
"PCID" ,
"group_id" ,
"@odata.id"
]
}
microsoft_active_directory_groups_create_group
Create a new group
Parameters:
Parameter Type Required Default Description descriptionstring No — Description of the group displayNamestring Yes — Display name of the group groupTypesstring[] No — Set to [‘Unified’] for Microsoft 365 groups, or [] for security groups mailEnabledboolean Yes — Whether the group is mail-enabled mailNicknamestring Yes — Mail alias for the group securityEnabledboolean Yes — Whether the group is a security group
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"description" : {
"type" : "string" ,
"description" : "Description of the group"
},
"displayName" : {
"type" : "string" ,
"description" : "Display name of the group"
},
"groupTypes" : {
"type" : "array" ,
"items" : {
"type" : "string" ,
"enum" : [
"Unified" ,
"DynamicMembership"
]
},
"description" : "Set to ['Unified'] for Microsoft 365 groups, or [] for security groups"
},
"mailEnabled" : {
"type" : "boolean" ,
"description" : "Whether the group is mail-enabled"
},
"mailNickname" : {
"type" : "string" ,
"description" : "Mail alias for the group"
},
"securityEnabled" : {
"type" : "boolean" ,
"description" : "Whether the group is a security group"
}
},
"required" : [
"PCID" ,
"displayName" ,
"mailEnabled" ,
"mailNickname" ,
"securityEnabled"
]
}
microsoft_active_directory_groups_delete_group
Delete a group
Parameters:
Parameter Type Required Default Description group_idstring Yes — Group ID (GUID)
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"group_id" : {
"type" : "string" ,
"description" : "Group ID (GUID)"
}
},
"required" : [
"PCID" ,
"group_id"
]
}
microsoft_active_directory_groups_get_group
Get a group by ID
Parameters:
Parameter Type Required Default Description group_idstring Yes — Group ID (GUID) $selectstring No — Comma-separated list of properties to return
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"group_id" : {
"type" : "string" ,
"description" : "Group ID (GUID)"
},
"$select" : {
"type" : "string" ,
"description" : "Comma-separated list of properties to return"
}
},
"required" : [
"PCID" ,
"group_id"
]
}
microsoft_active_directory_groups_list_group_members
List group members
Parameters:
Parameter Type Required Default Description group_idstring Yes — Group ID (GUID) $selectstring No — Comma-separated list of properties to return $topinteger No — Number of results to return
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"group_id" : {
"type" : "string" ,
"description" : "Group ID (GUID)"
},
"$select" : {
"type" : "string" ,
"description" : "Comma-separated list of properties to return"
},
"$top" : {
"type" : "integer" ,
"description" : "Number of results to return"
}
},
"required" : [
"PCID" ,
"group_id"
]
}
microsoft_active_directory_groups_list_group_owners
List group owners
Parameters:
Parameter Type Required Default Description group_idstring Yes — Group Id $topinteger No — The $top value
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"group_id" : {
"type" : "string" ,
"description" : "Group Id"
},
"$top" : {
"type" : "integer" ,
"description" : "The $top value"
}
},
"required" : [
"PCID" ,
"group_id"
]
}
microsoft_active_directory_groups_list_group_transitive_members
List transitive members of a group
Parameters:
Parameter Type Required Default Description group_idstring Yes — Group Id $topinteger No — The $top value
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"group_id" : {
"type" : "string" ,
"description" : "Group Id"
},
"$top" : {
"type" : "integer" ,
"description" : "The $top value"
}
},
"required" : [
"PCID" ,
"group_id"
]
}
microsoft_active_directory_groups_list_groups
List groups
Parameters:
Parameter Type Required Default Description $filterstring No — OData filter expression (e.g. “displayName eq ‘Marketing’“) $selectstring No — Comma-separated list of properties to return $topinteger No — Number of results to return $orderbystring No — Order results (e.g. “displayName asc”)
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"$filter" : {
"type" : "string" ,
"description" : "OData filter expression (e.g. \" displayName eq 'Marketing' \" )"
},
"$select" : {
"type" : "string" ,
"description" : "Comma-separated list of properties to return"
},
"$top" : {
"type" : "integer" ,
"description" : "Number of results to return"
},
"$orderby" : {
"type" : "string" ,
"description" : "Order results (e.g. \" displayName asc \" )"
}
},
"required" : [
"PCID"
]
}
microsoft_active_directory_groups_remove_group_member
Remove a member from a group
Parameters:
Parameter Type Required Default Description group_idstring Yes — Group ID (GUID) member_idstring Yes — ID of the member to remove
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"group_id" : {
"type" : "string" ,
"description" : "Group ID (GUID)"
},
"member_id" : {
"type" : "string" ,
"description" : "ID of the member to remove"
}
},
"required" : [
"PCID" ,
"group_id" ,
"member_id"
]
}
microsoft_active_directory_groups_remove_group_owner
Remove an owner from a group
Parameters:
Parameter Type Required Default Description group_idstring Yes — Group Id owner_idstring Yes — ID of the owner to remove
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"group_id" : {
"type" : "string" ,
"description" : "Group Id"
},
"owner_id" : {
"type" : "string" ,
"description" : "ID of the owner to remove"
}
},
"required" : [
"PCID" ,
"group_id" ,
"owner_id"
]
}
microsoft_active_directory_groups_update_group
Update a group
Parameters:
Parameter Type Required Default Description group_idstring Yes — Group ID (GUID) descriptionstring No — The description value displayNamestring No — Display Name mailNicknamestring No — Mail Nickname membershipRulestring No — Membership Rule membershipRuleProcessingStatestring No — Membership Rule Processing State visibilitystring No — The visibility value
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"group_id" : {
"type" : "string" ,
"description" : "Group ID (GUID)"
},
"description" : {
"type" : "string" ,
"description" : "The description value"
},
"displayName" : {
"type" : "string" ,
"description" : "Display Name"
},
"mailNickname" : {
"type" : "string" ,
"description" : "Mail Nickname"
},
"membershipRule" : {
"type" : "string" ,
"description" : "Membership Rule"
},
"membershipRuleProcessingState" : {
"type" : "string" ,
"description" : "Membership Rule Processing State" ,
"enum" : [
"On" ,
"Paused"
]
},
"visibility" : {
"type" : "string" ,
"description" : "The visibility value"
}
},
"required" : [
"PCID" ,
"group_id"
]
}