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-users | Type: Application | PCID required: Yes
microsoft_active_directory_users_assign_user_license
Assign or remove licenses for a user
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
user_id | string | Yes | — | User Id |
addLicenses | object[] | Yes | — | Licenses to add |
removeLicenses | string[] | Yes | — | Array of SKU GUIDs to remove |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"user_id": {
"type": "string",
"description": "User Id"
},
"addLicenses": {
"type": "array",
"items": {
"type": "object"
},
"description": "Licenses to add"
},
"removeLicenses": {
"type": "array",
"items": {
"type": "string"
},
"description": "Array of SKU GUIDs to remove"
}
},
"required": [
"PCID",
"user_id",
"addLicenses",
"removeLicenses"
]
}
microsoft_active_directory_users_assign_user_manager
Assign a manager to a user
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
user_id | string | Yes | — | User Id |
@odata.id | string | Yes | — | Full URL of the manager (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"
},
"user_id": {
"type": "string",
"description": "User Id"
},
"@odata.id": {
"type": "string",
"description": "Full URL of the manager (e.g. https://graph.microsoft.com/v1.0/users/{user-id})"
}
},
"required": [
"PCID",
"user_id",
"@odata.id"
]
}
microsoft_active_directory_users_create_user
Create a new user
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
accountEnabled | boolean | Yes | — | Whether the account is enabled |
department | string | No | — | The department value |
displayName | string | Yes | — | Display name of the user |
givenName | string | No | — | Given Name |
jobTitle | string | No | — | Job Title |
mailNickname | string | Yes | — | Mail alias for the user |
officeLocation | string | No | — | Office Location |
passwordProfile | object | Yes | — | Password Profile |
surname | string | No | — | The surname value |
userPrincipalName | string | Yes | — | User principal name (e.g. user@contoso.onmicrosoft.com) |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"accountEnabled": {
"type": "boolean",
"description": "Whether the account is enabled"
},
"department": {
"type": "string",
"description": "The department value"
},
"displayName": {
"type": "string",
"description": "Display name of the user"
},
"givenName": {
"type": "string",
"description": "Given Name"
},
"jobTitle": {
"type": "string",
"description": "Job Title"
},
"mailNickname": {
"type": "string",
"description": "Mail alias for the user"
},
"officeLocation": {
"type": "string",
"description": "Office Location"
},
"passwordProfile": {
"type": "object",
"description": "Password Profile",
"properties": {
"password": {
"type": "string",
"description": "The password for the user"
},
"forceChangePasswordNextSignIn": {
"type": "boolean",
"description": "Whether user must change password at next sign-in"
}
},
"required": [
"password",
"forceChangePasswordNextSignIn"
]
},
"surname": {
"type": "string",
"description": "The surname value"
},
"userPrincipalName": {
"type": "string",
"description": "User principal name (e.g. user@contoso.onmicrosoft.com)"
}
},
"required": [
"PCID",
"accountEnabled",
"displayName",
"mailNickname",
"passwordProfile",
"userPrincipalName"
]
}
microsoft_active_directory_users_delete_user
Delete a user
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
user_id | string | Yes | — | User ID (GUID) or userPrincipalName |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"user_id": {
"type": "string",
"description": "User ID (GUID) or userPrincipalName"
}
},
"required": [
"PCID",
"user_id"
]
}
microsoft_active_directory_users_get_user
Get a user by ID
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
user_id | string | Yes | — | User ID (GUID) or userPrincipalName |
$select | string | No | — | Comma-separated list of properties to return |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"user_id": {
"type": "string",
"description": "User ID (GUID) or userPrincipalName"
},
"$select": {
"type": "string",
"description": "Comma-separated list of properties to return"
}
},
"required": [
"PCID",
"user_id"
]
}
microsoft_active_directory_users_get_user_mailbox_settings
Get a user’s mailbox settings
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
user_id | string | Yes | — | User Id |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"user_id": {
"type": "string",
"description": "User Id"
}
},
"required": [
"PCID",
"user_id"
]
}
microsoft_active_directory_users_get_user_manager
Get a user’s manager
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
user_id | string | Yes | — | User Id |
$select | string | No | — | The $select value |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"user_id": {
"type": "string",
"description": "User Id"
},
"$select": {
"type": "string",
"description": "The $select value"
}
},
"required": [
"PCID",
"user_id"
]
}
microsoft_active_directory_users_get_user_photo
Get a user’s profile photo metadata
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
user_id | string | Yes | — | User Id |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"user_id": {
"type": "string",
"description": "User Id"
}
},
"required": [
"PCID",
"user_id"
]
}
microsoft_active_directory_users_list_user_app_role_assignments
List a user’s app role assignments
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
user_id | string | Yes | — | User Id |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"user_id": {
"type": "string",
"description": "User Id"
}
},
"required": [
"PCID",
"user_id"
]
}
microsoft_active_directory_users_list_user_authentication_methods
List a user’s authentication methods
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
user_id | string | Yes | — | User Id |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"user_id": {
"type": "string",
"description": "User Id"
}
},
"required": [
"PCID",
"user_id"
]
}
microsoft_active_directory_users_list_user_created_objects
List directory objects created by a user
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
user_id | string | Yes | — | User Id |
$top | integer | No | — | The $top value |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"user_id": {
"type": "string",
"description": "User Id"
},
"$top": {
"type": "integer",
"description": "The $top value"
}
},
"required": [
"PCID",
"user_id"
]
}
microsoft_active_directory_users_list_user_direct_reports
List a user’s direct reports
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
user_id | string | Yes | — | User Id |
$top | integer | No | — | The $top value |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"user_id": {
"type": "string",
"description": "User Id"
},
"$top": {
"type": "integer",
"description": "The $top value"
}
},
"required": [
"PCID",
"user_id"
]
}
microsoft_active_directory_users_list_user_memberships
List groups and roles a user belongs to
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
user_id | string | Yes | — | User ID (GUID) or userPrincipalName |
$select | string | No | — | Comma-separated list of properties to return |
$top | integer | No | — | Number of results to return |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"user_id": {
"type": "string",
"description": "User ID (GUID) or userPrincipalName"
},
"$select": {
"type": "string",
"description": "Comma-separated list of properties to return"
},
"$top": {
"type": "integer",
"description": "Number of results to return"
}
},
"required": [
"PCID",
"user_id"
]
}
microsoft_active_directory_users_list_user_owned_objects
List directory objects owned by a user
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
user_id | string | Yes | — | User Id |
$top | integer | No | — | The $top value |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"user_id": {
"type": "string",
"description": "User Id"
},
"$top": {
"type": "integer",
"description": "The $top value"
}
},
"required": [
"PCID",
"user_id"
]
}
microsoft_active_directory_users_list_users
List users
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
$filter | string | No | — | OData filter expression (e.g. “displayName eq ‘Jane Doe’”, “mail eq ‘user@contoso.com’”, “startsWith(displayName,‘Jane’)“) |
$select | string | No | — | Comma-separated list of properties to return (e.g. “id,displayName,mail,userPrincipalName”) |
$top | integer | No | — | Number of results to return (max 999) |
$orderby | string | 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 'Jane Doe'\", \"mail eq 'user@contoso.com'\", \"startsWith(displayName,'Jane')\")"
},
"$select": {
"type": "string",
"description": "Comma-separated list of properties to return (e.g. \"id,displayName,mail,userPrincipalName\")"
},
"$top": {
"type": "integer",
"description": "Number of results to return (max 999)"
},
"$orderby": {
"type": "string",
"description": "Order results (e.g. \"displayName asc\")"
}
},
"required": [
"PCID"
]
}
microsoft_active_directory_users_remove_user_manager
Remove a user’s manager
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
user_id | string | Yes | — | User Id |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"user_id": {
"type": "string",
"description": "User Id"
}
},
"required": [
"PCID",
"user_id"
]
}
microsoft_active_directory_users_reset_user_password
Reset a user’s password
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
user_id | string | Yes | — | User Id |
method_id | string | Yes | — | Authentication method ID (use 28c10230-6103-485e-b985-444c60001490 for the password method) |
newPassword | string | No | — | New password (omit to have one generated) |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"user_id": {
"type": "string",
"description": "User Id"
},
"method_id": {
"type": "string",
"description": "Authentication method ID (use 28c10230-6103-485e-b985-444c60001490 for the password method)"
},
"newPassword": {
"type": "string",
"description": "New password (omit to have one generated)"
}
},
"required": [
"PCID",
"user_id",
"method_id"
]
}
microsoft_active_directory_users_revoke_user_app_role_assignment
Revoke an app role assignment from a user
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
user_id | string | Yes | — | User Id |
app_role_assignment_id | string | Yes | — | The ID of the appRoleAssignment to remove |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"user_id": {
"type": "string",
"description": "User Id"
},
"app_role_assignment_id": {
"type": "string",
"description": "The ID of the appRoleAssignment to remove"
}
},
"required": [
"PCID",
"user_id",
"app_role_assignment_id"
]
}
microsoft_active_directory_users_revoke_user_sign_in_sessions
Revoke all sign-in sessions for a user
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
user_id | string | Yes | — | User ID (GUID) or userPrincipalName |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"user_id": {
"type": "string",
"description": "User ID (GUID) or userPrincipalName"
}
},
"required": [
"PCID",
"user_id"
]
}
microsoft_active_directory_users_update_user
Update a user
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
user_id | string | Yes | — | User ID (GUID) or userPrincipalName |
accountEnabled | boolean | No | — | Account Enabled |
department | string | No | — | The department value |
displayName | string | No | — | Display Name |
givenName | string | No | — | Given Name |
jobTitle | string | No | — | Job Title |
mobilePhone | string | No | — | Mobile Phone |
officeLocation | string | No | — | Office Location |
surname | string | No | — | The surname value |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"user_id": {
"type": "string",
"description": "User ID (GUID) or userPrincipalName"
},
"accountEnabled": {
"type": "boolean",
"description": "Account Enabled"
},
"department": {
"type": "string",
"description": "The department value"
},
"displayName": {
"type": "string",
"description": "Display Name"
},
"givenName": {
"type": "string",
"description": "Given Name"
},
"jobTitle": {
"type": "string",
"description": "Job Title"
},
"mobilePhone": {
"type": "string",
"description": "Mobile Phone"
},
"officeLocation": {
"type": "string",
"description": "Office Location"
},
"surname": {
"type": "string",
"description": "The surname value"
}
},
"required": [
"PCID",
"user_id"
]
}
microsoft_active_directory_users_update_user_mailbox_settings
Update a user’s mailbox settings
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
user_id | string | Yes | — | User Id |
automaticRepliesSetting | object | No | — | Automatic Replies Setting |
language | object | No | — | The language value |
timeZone | string | No | — | Timezone identifier |
workingHours | object | No | — | Working Hours |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"user_id": {
"type": "string",
"description": "User Id"
},
"automaticRepliesSetting": {
"type": "object",
"description": "Automatic Replies Setting",
"properties": {
"status": {
"type": "string",
"description": "The status value"
},
"externalAudience": {
"type": "string",
"description": "External Audience"
},
"scheduledStartDateTime": {
"type": "object",
"description": "Scheduled Start Date Time"
},
"scheduledEndDateTime": {
"type": "object",
"description": "Scheduled End Date Time"
},
"internalReplyMessage": {
"type": "string",
"description": "Internal Reply Message"
},
"externalReplyMessage": {
"type": "string",
"description": "External Reply Message"
}
}
},
"language": {
"type": "object",
"description": "The language value",
"properties": {
"locale": {
"type": "string",
"description": "Locale or language code"
},
"displayName": {
"type": "string",
"description": "Display Name"
}
}
},
"timeZone": {
"type": "string",
"description": "Timezone identifier"
},
"workingHours": {
"type": "object",
"description": "Working Hours",
"properties": {
"daysOfWeek": {
"type": "array",
"description": "Days Of Week"
},
"startTime": {
"type": "string",
"description": "Start Time"
},
"endTime": {
"type": "string",
"description": "End Time"
},
"timeZone": {
"type": "object",
"description": "Timezone identifier"
}
}
}
},
"required": [
"PCID",
"user_id"
]
}
