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-roles-and-units | Type: Application | PCID required: Yes
microsoft_active_directory_roles_and_units_add_administrative_unit_member
Add a member to an administrative unit
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
au_id | string | Yes | — | Administrative unit ID (GUID) |
@odata.id | string | 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"
},
"au_id": {
"type": "string",
"description": "Administrative unit 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",
"au_id",
"@odata.id"
]
}
microsoft_active_directory_roles_and_units_create_administrative_unit
Create an administrative unit
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
description | string | No | — | Description of the administrative unit |
displayName | string | Yes | — | Display name of the administrative unit |
membershipRule | string | No | — | Dynamic membership rule expression (required when membershipType is Dynamic) |
membershipRuleProcessingState | string | No | — | Processing state of the dynamic membership rule |
membershipType | string | No | — | Set to ‘Dynamic’ for rule-based membership, or ‘Assigned’ (default) for manual |
visibility | string | No | — | Visibility of the administrative unit |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"description": {
"type": "string",
"description": "Description of the administrative unit"
},
"displayName": {
"type": "string",
"description": "Display name of the administrative unit"
},
"membershipRule": {
"type": "string",
"description": "Dynamic membership rule expression (required when membershipType is Dynamic)"
},
"membershipRuleProcessingState": {
"type": "string",
"description": "Processing state of the dynamic membership rule",
"enum": [
"On",
"Paused"
]
},
"membershipType": {
"type": "string",
"description": "Set to 'Dynamic' for rule-based membership, or 'Assigned' (default) for manual",
"enum": [
"Assigned",
"Dynamic"
]
},
"visibility": {
"type": "string",
"description": "Visibility of the administrative unit",
"enum": [
"Public",
"HiddenMembership"
]
}
},
"required": [
"PCID",
"displayName"
]
}
microsoft_active_directory_roles_and_units_delete_administrative_unit
Delete an administrative unit
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
au_id | string | Yes | — | Administrative unit ID (GUID) |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"au_id": {
"type": "string",
"description": "Administrative unit ID (GUID)"
}
},
"required": [
"PCID",
"au_id"
]
}
microsoft_active_directory_roles_and_units_get_administrative_unit
Get an administrative unit by ID
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
au_id | string | Yes | — | Administrative unit ID (GUID) |
$select | string | No | — | Comma-separated list of properties to return |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"au_id": {
"type": "string",
"description": "Administrative unit ID (GUID)"
},
"$select": {
"type": "string",
"description": "Comma-separated list of properties to return"
}
},
"required": [
"PCID",
"au_id"
]
}
microsoft_active_directory_roles_and_units_get_objects_by_ids
Resolve directory objects by ID
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
ids | string[] | Yes | — | List of directory object IDs to resolve |
types | string[] | No | — | Optional filter by type (e.g. [‘user’, ‘group’]) |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of directory object IDs to resolve"
},
"types": {
"type": "array",
"items": {
"type": "string"
},
"description": "Optional filter by type (e.g. ['user', 'group'])"
}
},
"required": [
"PCID",
"ids"
]
}
microsoft_active_directory_roles_and_units_list_administrative_unit_members
List administrative unit members
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
au_id | string | Yes | — | Administrative unit ID (GUID) |
$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"
},
"au_id": {
"type": "string",
"description": "Administrative unit ID (GUID)"
},
"$select": {
"type": "string",
"description": "Comma-separated list of properties to return"
},
"$top": {
"type": "integer",
"description": "Number of results to return"
}
},
"required": [
"PCID",
"au_id"
]
}
microsoft_active_directory_roles_and_units_list_administrative_units
List administrative units
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
$filter | string | No | — | OData filter expression (e.g. “displayName eq ‘West Coast’“) |
$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"
},
"$filter": {
"type": "string",
"description": "OData filter expression (e.g. \"displayName eq 'West Coast'\")"
},
"$select": {
"type": "string",
"description": "Comma-separated list of properties to return"
},
"$top": {
"type": "integer",
"description": "Number of results to return"
}
},
"required": [
"PCID"
]
}
microsoft_active_directory_roles_and_units_list_directory_role_members
List members of a directory role
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
role_id | string | Yes | — | Directory role ID (GUID) |
$select | string | No | — | Comma-separated list of properties to return |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"role_id": {
"type": "string",
"description": "Directory role ID (GUID)"
},
"$select": {
"type": "string",
"description": "Comma-separated list of properties to return"
}
},
"required": [
"PCID",
"role_id"
]
}
microsoft_active_directory_roles_and_units_list_directory_roles
List activated directory roles
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
$select | string | No | — | Comma-separated list of properties to return |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"$select": {
"type": "string",
"description": "Comma-separated list of properties to return"
}
},
"required": [
"PCID"
]
}
microsoft_active_directory_roles_and_units_remove_administrative_unit_member
Remove a member from an administrative unit
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
au_id | string | Yes | — | Administrative unit ID (GUID) |
member_id | string | Yes | — | ID of the member to remove |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"au_id": {
"type": "string",
"description": "Administrative unit ID (GUID)"
},
"member_id": {
"type": "string",
"description": "ID of the member to remove"
}
},
"required": [
"PCID",
"au_id",
"member_id"
]
}
microsoft_active_directory_roles_and_units_update_administrative_unit
Update an administrative unit
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
au_id | string | Yes | — | Administrative unit ID (GUID) |
description | string | No | — | The description value |
displayName | string | No | — | Display Name |
membershipRule | string | No | — | Membership Rule |
membershipRuleProcessingState | string | No | — | Membership Rule Processing State |
membershipType | string | No | — | Membership Type |
visibility | string | No | — | The visibility value |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"au_id": {
"type": "string",
"description": "Administrative unit ID (GUID)"
},
"description": {
"type": "string",
"description": "The description value"
},
"displayName": {
"type": "string",
"description": "Display Name"
},
"membershipRule": {
"type": "string",
"description": "Membership Rule"
},
"membershipRuleProcessingState": {
"type": "string",
"description": "Membership Rule Processing State",
"enum": [
"On",
"Paused"
]
},
"membershipType": {
"type": "string",
"description": "Membership Type",
"enum": [
"Assigned",
"Dynamic"
]
},
"visibility": {
"type": "string",
"description": "The visibility value",
"enum": [
"Public",
"HiddenMembership"
]
}
},
"required": [
"PCID",
"au_id"
]
}
