From 24dabd253f25fd6097d49479fa666d32d158432b Mon Sep 17 00:00:00 2001 From: hchen Date: Thu, 23 Oct 2025 16:35:44 +0800 Subject: [PATCH] elements hotfix --- docs/docs/Overview.md | 1 + .../enpower/exchange/resourcemailboxes.md | 2 +- .../insights/users/userPermissionsExport.md | 2 +- .../baseline-management/create-baseline.md | 6 +-- .../baseline-management/query-baselines.md | 26 +++++----- ...query-create-baseline-job-report-detail.md | 12 ++--- .../elements/baseline-management/query-job.md | 16 +++--- .../baseline-management/query-tenant.md | 26 +++++----- .../baseline-management/tenant-action.md | 14 +++--- docs/elements/change-log.md | 2 +- .../general/customer/get-all-customers.md | 10 ++-- .../general/customer/onboard-customer.md | 2 +- ...get-customer-cloud-backup-m365-overview.md | 4 +- .../elements/general/job/get-customer-jobs.md | 10 ++-- .../job/get-customer-scan-profile-changes.md | 4 +- .../job/get-customer-scan-profile-detail.md | 4 +- .../general/job/get-customer-scan-profiles.md | 8 +-- .../service subscription/add-service.md | 4 +- .../service subscription/get-all-services.md | 8 +-- .../get-3rd-party-products-tenant-type.md | 26 +++++----- .../get-cloud-backup-m365-users-batch.md | 8 +-- docs/elements/register-app.md | 25 ++++++++-- .../all-data-source-match-risk-rule.md | 12 ++--- .../specific-rule-detail-hit-items.md | 50 +++++++++---------- .../dashboard_public_api.md | 32 ++++++------ .../get-compliance-category.md | 32 ++++++------ .../risky_public_api/get-risk-action.md | 2 +- .../get-risk-analyze-workflow.md | 14 +++--- .../risky_public_api/get-sign-in.md | 22 ++++---- .../user_public_api/get-information-user.md | 20 ++++---- .../get-multi-information-users.md | 34 ++++++++----- .../update-account-information.md | 12 ++--- .../user_public_api/update-birthday.md | 6 +-- .../update-contact-information.md | 4 +- .../user_public_api/update-email-address.md | 6 +-- .../update-general-information.md | 2 +- .../user_public_api/update-istest.md | 2 +- .../user_public_api/update-manager.md | 6 +-- .../update-office-information.md | 2 +- .../user_public_api/update-office.md | 2 +- .../update-password-setting.md | 2 +- 41 files changed, 252 insertions(+), 230 deletions(-) diff --git a/docs/docs/Overview.md b/docs/docs/Overview.md index f0246ee..55bdc43 100644 --- a/docs/docs/Overview.md +++ b/docs/docs/Overview.md @@ -96,6 +96,7 @@ Refer to the data center endpoints in the table below: | | Switzerland North (Zurich) | `https://graph-ch.avepointonlineservices.com/` | | | UK South (London) | `https://graph-uk.avepointonlineservices.com/` | | | US - East | `https://graph-us.avepointonlineservices.com/` | +| | United Arab Emirates (Dubai) | `https://graph-uae.avepointonlineservices.com/` | | | AOS-US Gov | `https://graph-gov.avepointonlineservices.com/` | | | AOS2 | `https://graph-aos2.avepointonlineservices.com/` | | | FedRAMP Cloud (Project Hosts) | `https://graphusgovapi.online15.net/` | diff --git a/docs/docs/services-and-features/enpower/exchange/resourcemailboxes.md b/docs/docs/services-and-features/enpower/exchange/resourcemailboxes.md index ffdbe43..e60dd2d 100644 --- a/docs/docs/services-and-features/enpower/exchange/resourcemailboxes.md +++ b/docs/docs/services-and-features/enpower/exchange/resourcemailboxes.md @@ -163,7 +163,7 @@ If the request has been successfully processed, a 200 OK response will be return { "resourceMailboxes": [ { - "id": "73669ae7-55fe-4b47-****-47324c01d5d2",//The unique identifier of the resource mailbox in PowerShell + "id": "73669ae7-55fe-4b47-****-47324c01****",//The unique identifier of the resource mailbox in PowerShell "userId": "",// The unique identifier of the resource mailbox in Microsoft 365 "principalName": "",// The user principal name of the resource mailbox "name": "",// The name of the resource mailbox in PowerShell diff --git a/docs/docs/services-and-features/insights/users/userPermissionsExport.md b/docs/docs/services-and-features/insights/users/userPermissionsExport.md index 5615f10..2972f09 100644 --- a/docs/docs/services-and-features/insights/users/userPermissionsExport.md +++ b/docs/docs/services-and-features/insights/users/userPermissionsExport.md @@ -47,7 +47,7 @@ The API response provides the export job ID and its operation status. You can us To use this API, send a `GET` request to the specified endpoint, including necessary parameters as defined in the references. The following request is an API call to the Insights environment in the US - East region. ```json -https://graph-us.avepointonlineservices.com/insights/users/insights******001_j*****insightstest.onmicrosoft.com%2523ext%2523%2540m3********.onmicrosoft.com/access/export?exportOptionType=2&siteUrls=https%3A%2F%2Fm******.sharepoint.com%2Fsites%2Fjuly2022public****01&dataSources=microsoft%20teams&dataSources=sharepoint%20online +https://graph-us.avepointonlineservices.com/insights/users/insights******001_j*****insightstest.onmicrosoft.com%2523ext%2523%2540m3********.onmicrosoft.com/access/export?siteUrls=https%3A%2F%2Fm******.sharepoint.com%2Fsites%2Fjuly2022public****01&dataSources=microsoft%20teams&dataSources=sharepoint%20online ``` ## Response Sample diff --git a/docs/elements/baseline-management/create-baseline.md b/docs/elements/baseline-management/create-baseline.md index bbf7c1b..2d5f6f2 100644 --- a/docs/elements/baseline-management/create-baseline.md +++ b/docs/elements/baseline-management/create-baseline.md @@ -53,8 +53,8 @@ https://graph.avepointonlineservices.com/partner/external/v3/bm/baselines "name": "baseline A", // The name of the baseline "color":"0", // The color of the baseline "description":"baseline A's description", // The description of the baseline - "customerId":"ce43e186-****-****-****-86b51b0aef92", // The ID of the customer - "tenantId":"af83b8e1-****-****-****-970f92192dc5" // The ID of the tenant + "customerId":"ce43e186-****-98b4-****-86b51b0aef92", // The ID of the customer + "tenantId":"af83b8e1-****-8b70-****-970f92192dc5" // The ID of the tenant } ``` @@ -64,5 +64,5 @@ If the request has been successfully processed, a 201 OK response will be return ```json { - "baselineId": "606f30c0-****-****-****-3a1c3a823ab5" // The ID of the newly created baseline + "baselineId": "606f30c0-****-47b8-****-3a1c3a823ab5" // The ID of the newly created baseline } \ No newline at end of file diff --git a/docs/elements/baseline-management/query-baselines.md b/docs/elements/baseline-management/query-baselines.md index 31177ed..d60b49d 100644 --- a/docs/elements/baseline-management/query-baselines.md +++ b/docs/elements/baseline-management/query-baselines.md @@ -25,8 +25,8 @@ You can use the following optional query parameters in the URL to control pagina |Parameter|Description | Type|Required?| |---|---|---|---| -|pageIndex|The starting number of the page to retrieve. The default value is 1. |integer|No| -|pageSize|The number of records to return per page. The default value is 50, and the acceptable range is from 1 to 100.|integer|No| +|pageIndex|The starting number of the page to retrieve baselines. The default value is 1. |integer|No| +|pageSize|The number of objects to display on one page. The default value is 50 and the maximum value allowed is 100.|integer|No| ## Request Body Parameters @@ -44,8 +44,8 @@ If the request has been successfully processed, a 200 OK response will be return | --- | --- | --- | | baselineId | The ID of the baseline. | string | | baselineName | The name of the baseline. | string | -| createdTime | The created time (UTC) of the baseline. | string | -| modifiedTime | The last modified time (UTC) of the baseline. | string | +| createdTime | The created time of the baseline in ISO 8601 format. | string | +| modifiedTime | The last modified time of the baseline in ISO 8601 format. | string | | status | The status of the baseline. | integer | ## Request Sample @@ -58,8 +58,8 @@ https://graph-us.avepointonlineservices.com/partner/external/v3/bm/baselines/bat { "baselineIds": [ - "0f0cb41b-****-****-****-3a1c39554d0c", // The ID of the baseline - "5aec2275-****-****-****-3a1c307a28fa" + "0f0cb41b-****-98b6-****-3a1c39554d0c", // The ID of the baseline + "5aec2275-****-78n6-****-3a1c307a28fa" ] } ``` @@ -72,14 +72,14 @@ If the request has been successfully processed, a 200 OK response will be return { "data": [ { - "baselineId": "0f0cb41b-****-****-****-3a1c39554d0c", // The ID of the baseline + "baselineId": "0f0cb41b-****98b6-****-3a1c39554d0c", // The ID of the baseline "baselineName": "Baseline1", // The name of the baseline - "createdTime": "2025-09-04T10:30:00Z", // The created time (UTC) of the baseline - "modifiedTime": "2025-09-05T10:30:00Z", // The last modified time (UTC) of the baseline + "createdTime": "2025-09-04T10:30:00Z", // The created time of the baseline in ISO 8601 format + "modifiedTime": "2025-09-05T10:30:00Z", // The last modified time of the baseline in ISO 8601 format "status": 1 // The status of the baseline. 1 represents "Retrieving settings" }, { - "baselineId": "5aec2275-****-****-****-3a1c307a28fa", + "baselineId": "5aec2275-****-78n6-****-3a1c307a28fa", "name": "Baseline2", "createdTime": "2025-09-06T10:30:00Z", "modifiedTime": "2025-09-07T10:30:00Z", @@ -87,8 +87,8 @@ If the request has been successfully processed, a 200 OK response will be return } ], "metadata": { - "pageIndex": 1, // The page index of the current request - "pageSize": 50, // The number of baselines to be retrieved in one request - "totalCount": 2 // The total number count that matches the request + "pageIndex": 1, // The current display page + "pageSize": 50, // The number of objects on the display page + "totalCount": 2 // The total number of objects matching the query parameters } } \ No newline at end of file diff --git a/docs/elements/baseline-management/query-create-baseline-job-report-detail.md b/docs/elements/baseline-management/query-create-baseline-job-report-detail.md index 0c70f60..a567433 100644 --- a/docs/elements/baseline-management/query-create-baseline-job-report-detail.md +++ b/docs/elements/baseline-management/query-create-baseline-job-report-detail.md @@ -33,8 +33,8 @@ You can use the following optional query parameters in the URL to control pagina |Parameter|Description | Type|Required?| |---|---|---|---| -|pageIndex|The index of the page to retrieve. The default value is 1. |integer|No| -|pageSize|The number of records to return per page. The default value is 50, and the acceptable range is from 1 to 100.|integer|No| +|pageIndex|The starting number of the page to get the report details. The default value is 1|integer|No| +|pageSize|The number of objects to display on one page. The default value is 50 and the maximum value allowed is 100.|integer|No| ## Response @@ -52,7 +52,7 @@ If the request has been successfully processed, a 200 OK response will be return To use this API, send a GET request to the specified endpoint. ```json -https://graph-us.avepointonlineservices.com/partner/external/v3/bm/baselines/23351ee7-****-****-****-e8e3ffc29cd7/reports?pageIndex=1&pageSize=50 +https://graph-us.avepointonlineservices.com/partner/external/v3/bm/baselines/23351ee7-****-78n6-****-e8e3ffc29cd7/reports?pageIndex=1&pageSize=50 ``` ## Response Sample @@ -77,8 +77,8 @@ If the request has been successfully processed, a 200 OK response will be return ... ], "metadata": { - "pageIndex": 1, // The page index of thecurrent request - "pageSize": 50, // The number of report data to be retrieved in one request - "totalCount": 109 // The total number count that matches the request + "pageIndex": 1, // The current display page + "pageSize": 50, // The number of objects on the display page + "totalCount": 109 // The total number of objects matching the query parameters } } \ No newline at end of file diff --git a/docs/elements/baseline-management/query-job.md b/docs/elements/baseline-management/query-job.md index 351a009..0529d22 100644 --- a/docs/elements/baseline-management/query-job.md +++ b/docs/elements/baseline-management/query-job.md @@ -34,8 +34,8 @@ You can use the following optional query parameters in the URL to control pagina |Parameter|Description | Type|Required?| |---|---|---|---| -|pageIndex|The index of the page to retrieve. The default value is 1. |integer|No| -|pageSize|The number of records to return per page. The default value is 50, and the acceptable range is from 1 to 100.|integer|No| +|pageIndex|The starting number of the page to get job information. The default value is 1. |integer|No| +|pageSize|The number of objects to display on one page. The default value is 50 and the maximum value allowed is 100.|integer|No| ## Request Body Parameters @@ -60,12 +60,12 @@ If the request has been successfully processed, a 200 OK response will be return To use this API, send a POST request to the specified endpoint. ```json -https://graph-us.avepointonlineservices.com/partner/external/v3/bm/customers/38c6a73d-****-****-****-75b0f1959474/tenants/a2145aa5-****-****-****-7fffd6e0cc68/process-center/jobs/batch?pageIndex=1&pageSize=50 +https://graph-us.avepointonlineservices.com/partner/external/v3/bm/customers/38c6a73d-****-98b6-****-75b0f1959474/tenants/a2145aa5-****-76b8-****-7fffd6e0cc68/process-center/jobs/batch?pageIndex=1&pageSize=50 { "jobIds": [ - "a7bd3e1b-****-****-****-243c4df89a2d" // The ID of the job + "a7bd3e1b-****-97d6-****-243c4df89a2d" // The ID of the job ] } ``` @@ -78,14 +78,14 @@ If the request has been successfully processed, a 200 OK response will be return { "data": [ { - "jobId": "a7bd3e1b-****-****-****-243c4df89a2d", // The ID of the job + "jobId": "a7bd3e1b-****-97d6-****-243c4df89a2d", // The ID of the job "type": 1, // The type of the job "status": 2 // The status of the job } ], "metadata": { - "pageIndex": 1, // The page index of the current request - "pageSize": 5, // The number of jobs to be retrieved in one request - "totalCount": 1 // The total number count that matches the request + "pageIndex": 1, // The current display page + "pageSize": 50, // The number of objects on the display page + "totalCount": 1 // The total number of objects matching the query parameters } } \ No newline at end of file diff --git a/docs/elements/baseline-management/query-tenant.md b/docs/elements/baseline-management/query-tenant.md index 2aa37bf..b7f3527 100644 --- a/docs/elements/baseline-management/query-tenant.md +++ b/docs/elements/baseline-management/query-tenant.md @@ -25,8 +25,8 @@ You can use the following optional query parameters in the URL to control pagina |Parameter|Description | Type|Required?| |---|---|---|---| -|pageIndex|The index of the page to retrieve. The default value is 1. |integer|No| -|pageSize|The number of records to return per page. The default value is 50, and the acceptable range is from 1 to 100.|integer|No| +|pageIndex|The starting number of the page to get tenants. The default value is 1. |integer|No| +|pageSize|The number of objects to display on one page. The default value is 50 and the maximum value allowed is 100.|integer|No| ## Request Body Parameters @@ -45,8 +45,8 @@ If the request has been successfully processed, a 200 OK response will be return | tenantName | The name of the tenant. | string | | status | The status of the tenant. | integer | | driftDetected | The number of configuration deviations that have been detected for the tenant. | integer | -| driftDetectedTime | The time (UTC) when configuration deviations were detected. | string | -| lastDeployedTime | The time (UTC) when the baseline was deployed to the tenant. | string | +| driftDetectedTime | The time in ISO 8601 format when configuration deviations were detected. | string | +| lastDeployedTime | The time in ISO 8601 format when the baseline was deployed to the tenant. | string | | customerId | The ID of the customer. | string | | tenantId | The ID of the tenant. | string | | autoAlignment | The status of the auto-alignment setting. | string | @@ -65,7 +65,7 @@ https://graph-us.avepointonlineservices.com/partner/external/v3/bm/baselines/bat { "tenantIds": [ - "af83b8e1-****-****-****-970f92192dc5" // The ID of the tenant + "af83b8e1-****-98a7-****-970f92192dc5" // The ID of the tenant ] } ``` @@ -81,14 +81,14 @@ If the request has been successfully processed, a 200 OK response will be return "tenantName": "2****l", // The name of the tenant "status": 5, // The status of the tenant. 5 represents "Deployment failed" "driftDetected": 51, // The number of configuration deviations that have been detected for the tenant - "driftDetectedTime": "2025-09-05T10:30:00Z", // The time (UTC) when configuration deviations were detected - "customerId": "ce43e186-****-****-****-86b51b0aef92", // The ID of the customer - "tenantId": "af83b8e1-****-****-****-970f92192dc5", // The ID of the tenant + "driftDetectedTime": "2025-09-05T10:30:00Z", // The time in ISO 8601 format when configuration deviations were detected + "customerId": "ce43e186-****-67v8-****-86b51b0aef92", // The ID of the customer + "tenantId": "af83b8e1-****-98a7-****-970f92192dc5", // The ID of the tenant "autoAlignment": 1, // The status of the auto-alignment setting. 1 represents "Enabled" - "lastDeployedTime": "2025-09-11T02:26:34Z", // The time (UTC) when the baseline was deployed to the tenant + "lastDeployedTime": "2025-09-11T02:26:34Z", // The time in ISO 8601 format when the baseline was deployed to the tenant "appliedBaselines": [ { - "baselineId": "de473862-****-****-****-3a1c20398d55", // The ID of the baseline + "baselineId": "de473862-****-45s6-****-3a1c20398d55", // The ID of the baseline "baselineName": "baseline1", // The name of the baseline "version": "4" // The version of the baseline } @@ -96,8 +96,8 @@ If the request has been successfully processed, a 200 OK response will be return } ], "metadata": { - "pageIndex": 1, // The page index of the current request - "pageSize": 50, // The number of tenants to be retrieved in one request - "totalCount": 1 // The total number count that matches the request + "pageIndex": 1, // The current display page + "pageSize": 50, // The number of objects on the display page + "totalCount": 1 // The total number of objects matching the query parameters } } \ No newline at end of file diff --git a/docs/elements/baseline-management/tenant-action.md b/docs/elements/baseline-management/tenant-action.md index b2fd195..f19b03a 100644 --- a/docs/elements/baseline-management/tenant-action.md +++ b/docs/elements/baseline-management/tenant-action.md @@ -30,16 +30,15 @@ This section describes the query parameters that can be added to the URL when se ## Request Body Parameters -You can provide a object about the action. +You can provide an object about the action. |Parameter|Description | Type|Required?| |---|---|---|---| |actionType| The action that you want to perform on a tenant. (More actions will be supported in the future) |integer|Yes| |data| The parameters of the action. |object|Yes| -### Apply Action Data Parameters +**Action data parameters** -For the "Apply baselines to tenant" action, the parameters of the data object are as follows. |Parameter|Description | Type|Required?| |---|---|---|---| @@ -64,19 +63,18 @@ If the request has been successfully processed, a 200 OK response will be return To use this API, send a POST request to the specified endpoint. ```json -https://graph-us.avepointonlineservices.com/partner/external/v3/bm/customers/38c6a73d-****-****-****-75b0f1959474/tenants/a2145aa5-****-****-****-7fffd6e0cc68/actions +https://graph-us.avepointonlineservices.com/partner/external/v3/bm/customers/38c6a73d-****-57c6-****-75b0f1959474/tenants/a2145aa5-****-26v7-****-7fffd6e0cc68/actions -//Apply baseline action { "actionType": "1", // The action that you want to perform on the tenant. 1 represents "Apply baselines to tenant" "data": [ { - "baselineId": "e12922f4-****-****-****-3a1c162b4cf2", // The ID of the baseline + "baselineId": "e12922f4-****-45b7-****-3a1c162b4cf2", // The ID of the baseline "rankingOrder": 1 // The ranking order of the baseline among all applied baselines }, { - "baselineId": "b4c84bff-****-****-****-3a1c16243555", + "baselineId": "b4c84bff-****-87b2-****-3a1c16243555", "rankingOrder": 2 } ] @@ -89,6 +87,6 @@ If the request has been successfully processed, a 200 OK response will be return ```json { - "jobId": "7f3b241b-****-****-****-3a1c395524t6" // The ID of the applying baselines to tenant job + "jobId": "7f3b241b-****-27s7-****-3a1c395524t6" // The ID of the applying baselines to tenant job } ``` \ No newline at end of file diff --git a/docs/elements/change-log.md b/docs/elements/change-log.md index 0645859..eb8610c 100644 --- a/docs/elements/change-log.md +++ b/docs/elements/change-log.md @@ -11,7 +11,7 @@ This document provides a detailed log of changes, updates, and enhancements made - `/partner/external/v3/general/customers` for onboarding a customer to the current partner. - `/partner/external/v3/general/customers/{customerId}/services` for adding a service for a customer. - `/partner/external/v3/general/customers/services/batch` for retrieving the services of customers managed by the current partner. - - `/partner/external/v3/general/customers/{customerId}/3rd-party-products/type/{type}/users` for retrieving the numbers of assigned and available user seats of customer's tenant. + - `/partner/external/v3/general/customers/{customerId}/3rd-party-products/type/{type}/tenants/batch` for retrieving the numbers of assigned and available user seats of customer's tenant. - `/partner/external/v3/general/customers/{customerId}/avpt-products/type/{productType}/overview` for retrieving the purchased user seats for AvePoint products of the customer. - `/partner/external/v3/general/customers/{customerId}/tenants/{tenantId}/cloud-backup-m365/users/batch` for retrieving the protected status of users in the customer's tenant by Cloud Backup for Microsoft 365. - `/partner/external/v3/general/customers/{customerId}/cloud-backup-m365/overview` for retrieving the customer's protected data information of Cloud Backup for Microsoft 365. diff --git a/docs/elements/general/customer/get-all-customers.md b/docs/elements/general/customer/get-all-customers.md index e348b8c..415b32b 100644 --- a/docs/elements/general/customer/get-all-customers.md +++ b/docs/elements/general/customer/get-all-customers.md @@ -26,7 +26,7 @@ This section outlines the parameters that allow users to specify pagination. | Parameter | Description | Type | Required | | --- | --- | --- | --- | -| pageIndex | The starting number of the page to get the violated objects. The default value is 1. | integer | No | +| pageIndex | The starting number of the page to retrieve the customers. The default value is 1. | integer | No | | pageSize | The number of objects to display on one page. The default value is 50 and the maximum value allowed is 100. | integer | No | ## Request Body Parameters @@ -35,7 +35,7 @@ This section outlines the request body parameters required to specify the custom | Parameter | Description | Type | Required | | --- | --- | --- | --- | -| customerId | The ID of the customer to be retrieved. | string | No | +| customerIds | The ID of the customer to be retrieved. | string[] | No | ## Response @@ -71,7 +71,7 @@ For more details on the HTTP status code, refer to [Http Status Code](../../Use- { "data": [ { - "id": "03f7382e-****-****-****-dd9af05974f0", //The customer ID + "id": "03f7382e-****-1cda-****-dd9a****74f0", //The customer ID "organization": "OrganizationABC", //The organization name of the customer "ownerEmail": "user@domain.com", //The email address of the customer "jobStatus": 0, //The status of the customer's tenant: 0 represents N/A @@ -80,13 +80,13 @@ For more details on the HTTP status code, refer to [Http Status Code](../../Use- "tenants": [ { - "id":"03f7382e-xxxx-xxxx-xxxx-dd9af05974f0", //The ID of the tenant + "id":"03f7382e-****-1bcd-****-dd9a****74f0", //The ID of the tenant "name":"Tenant ABC" //The name of the tenant } ] }, { - "id": "03f7382e-****-****-****-dd9adcs974f0", + "id": "03f7382e-****-1bac-****-dd9a****74f0", "organization": "OrganizationDEF", "ownerEmail": "userA@domain.com", "jobStatus": 0, diff --git a/docs/elements/general/customer/onboard-customer.md b/docs/elements/general/customer/onboard-customer.md index 984808d..ec95219 100644 --- a/docs/elements/general/customer/onboard-customer.md +++ b/docs/elements/general/customer/onboard-customer.md @@ -59,7 +59,7 @@ https://graph.avepointonlineservices.com/partner/external/v3/general/customers "RegistrationAccount": "user@domain.com", // The registration account of the customer "password":"**********", // The password of the customer "countryCode":"AF", // The country code of the customer - "dataCenter":"7e4ffcae-****-****-****-c6ef****50d5", // The data center ID of the customer + "dataCenter":"0d4a9846-97ad-4c09-bb1c-8fbe93eaf3c6", // The data center ID of the customer "tags":["tagA"] // The tags of the customer } ``` diff --git a/docs/elements/general/job/get-customer-cloud-backup-m365-overview.md b/docs/elements/general/job/get-customer-cloud-backup-m365-overview.md index 810694a..b45936c 100644 --- a/docs/elements/general/job/get-customer-cloud-backup-m365-overview.md +++ b/docs/elements/general/job/get-customer-cloud-backup-m365-overview.md @@ -29,8 +29,8 @@ If the request has been successfully processed, a 200 OK response will be return | customer | The email address of the customer. | string | | serviceType | The name of the service. | string | | serviceModule | The module of the customer’s Cloud Backup for Microsoft 365 service. | string | -| totalScannedObjects | The number of the scanned objects of the module. | integer | -| totalProtectedObjects | The number of the backed-up objects of the module. | integer | +| totalScannedObjects | The number of scanned objects of the module. | integer | +| totalProtectedObjects | The number of backed-up objects of the module. | integer | | dataSizeStoredInAvePoint | The size of the backed-up objects stored in the AvePoint storage. | string | | dataSizeStoredInBYOS | The size of the backed-up objects stored in BYOS. | string | diff --git a/docs/elements/general/job/get-customer-jobs.md b/docs/elements/general/job/get-customer-jobs.md index 95bc5a4..fa8e4fb 100644 --- a/docs/elements/general/job/get-customer-jobs.md +++ b/docs/elements/general/job/get-customer-jobs.md @@ -1,6 +1,6 @@ # Retrieve Job Details of Backup Services for a Customer -Use this API to retrieve the job details job details for a specific job type and module of backup services, including Cloud Backup for Microsoft 365, Cloud Backup for Google Workspace, Cloud Backup for IaaS + PaaS, Cloud Backup for Dynamics 365, and Cloud Backup for Salesforce. +Use this API to retrieve the job details for a specific job type and module of backup services, including Cloud Backup for Microsoft 365, Cloud Backup for Google Workspace, Cloud Backup for IaaS + PaaS, Cloud Backup for Dynamics 365, and Cloud Backup for Salesforce. ## Permission @@ -25,7 +25,7 @@ This section outlines the parameters that allow users to specify pagination. | Parameter | Description | Type | Required | | --- | --- | --- | --- | -| pageIndex | The starting number of the page to get the violated objects. The default value is 1. | integer | No | +| pageIndex | The starting number of the page to get the job details. The default value is 1. | integer | No | | pageSize | The number of objects to display on one page. The default value is 50 and the maximum value allowed is 100. | integer | No | ## Request Body Parameters @@ -54,10 +54,10 @@ If the request has been successfully processed, a 200 OK response will be return | skippedCount | The number of skipped objects. | string | | warningCount | The number of warning objects. | string | | backupSize | The size of the backed-up objects. |string| -| startTime | The start time of the job. | string | -| endTime | The end time of the job. | string | +| startTime | The start time of the job in ISO 8601 format. | string | +| endTime | The end time of the job in ISO 8601 format. | string | | jobDuration | The duration of the job. | string | -| lastModifyTime | The last modified time of the job. | string | +| lastModifyTime | The last modified time of the job in ISO 8601 format. | string | ## Request Sample To use this API, send a POST request to the specified endpoint, including necessary parameters as defined in the references. diff --git a/docs/elements/general/job/get-customer-scan-profile-changes.md b/docs/elements/general/job/get-customer-scan-profile-changes.md index 095fa17..dc4aca3 100644 --- a/docs/elements/general/job/get-customer-scan-profile-changes.md +++ b/docs/elements/general/job/get-customer-scan-profile-changes.md @@ -31,8 +31,8 @@ If the request has been successfully processed, a 200 OK response will be return | tenantId | The tenant ID of the scan profile. | string | | tenantDomain | The tenant domain of the scan profile. | string | | scanMode | The scan mode of the profile. | integer | -| modifiedTime | The last modified time of the scan profile. | string | -| lastUpdateTime | The time the daily report for the scan profile was generated. If no daily report has been generated, the time will be the last modified time of the scan profile. | string | +| modifiedTime | The last modified time of the scan profile in ISO 8601 format. | string | +| lastUpdateTime | The time the daily report for the scan profile was generated in ISO 8601 format. If no daily report has been generated, the time will be the last modified time of the scan profile. | string | | lastScanStatus | The last scan job status of the scan profile. | integer | | newRegisteredContentCount | The number of newly registered objects in the daily report of the scan profile. | integer | | movedToAnotherContainer | The number of objects moved to another container in the daily report of the scan profile. | integer | diff --git a/docs/elements/general/job/get-customer-scan-profile-detail.md b/docs/elements/general/job/get-customer-scan-profile-detail.md index ed6cd9f..7b59797 100644 --- a/docs/elements/general/job/get-customer-scan-profile-detail.md +++ b/docs/elements/general/job/get-customer-scan-profile-detail.md @@ -31,8 +31,8 @@ If the request has been successfully processed, a 200 OK response will be return | tenantId | The tenant ID of the scan profile. | string | | tenantDomain | The tenant domain of the scan profile. | string | | scanMode | The scan mode of the scan profile. | integer | -| modifiedTime | The last modified time of the scan profile. | string | -| createdTime | The created time of the scan profile. | string | +| modifiedTime | The last modified time of the scan profile in ISO 8601 format. | string | +| createdTime | The created time of the scan profile in ISO 8601 format. | string | | impersonationAccount | The impersonation account configured in the scan profile. | string | | scanInplaceArchivedMailboxes | Whether the **Scan in-place archived mailboxes** setting is enabled in the scan profile: | boolean | | isIgnoreLockedSiteEnabled | Whether the **Ignore the locked objects when updating the job status** setting is enabled in the scan profile: | boolean | diff --git a/docs/elements/general/job/get-customer-scan-profiles.md b/docs/elements/general/job/get-customer-scan-profiles.md index 0c79706..c00c1be 100644 --- a/docs/elements/general/job/get-customer-scan-profiles.md +++ b/docs/elements/general/job/get-customer-scan-profiles.md @@ -25,8 +25,8 @@ This section outlines the parameters optional required to specify paging informa | Parameter | Description | Type | Required | | --- | --- | --- | --- | -| pageIndex | The page number of the data which will be retrieve, the default value is 1. | integer | No | -| pageSize | The number of customers API will retrieved in a time, the default value is 100. | integer | No | +| pageIndex | The starting number of the page to retrieve the scan profiles. The default value is 1. | integer | No | +| pageSize | The number of objects to display on one page. The default value is 50 and the maximum value allowed is 100. | integer | No | ## Request Body Parameters @@ -34,7 +34,7 @@ This section outlines the request body required to specify which scan profiles y | Parameter | Description | Type | Required | | --- | --- | --- | --- | -| scanProfileIds | The IDs of the scan profiles to be retrieved | string[] | No | +| scanProfileIds | The IDs of the scan profiles to be retrieved. | string[] | No | ## Response @@ -45,7 +45,7 @@ If the request has been successfully processed, a 200 OK response will be return | profileName | The name of the scan profile. | string | | profileId | The ID of the scan profile. | string | | scanMode | The scan mode of the scan profile. | integer | -| modifiedTime | The last modified time of the scan profile. | string | +| modifiedTime | The last modified time of the scan profile in ISO 8601 format. | string | ## Request Sample To use this API, send a GET request to the specified endpoint, including necessary parameters as defined in the references. diff --git a/docs/elements/general/service subscription/add-service.md b/docs/elements/general/service subscription/add-service.md index 26b9620..55ab739 100644 --- a/docs/elements/general/service subscription/add-service.md +++ b/docs/elements/general/service subscription/add-service.md @@ -67,7 +67,7 @@ You can provide the service detailed information in the request body to add a se |resource |The resource of the service. |string |Yes| |subscriptionSourceType |The source of the service. |integer |Yes| |isSameAsPool |Whether the expiration time of the service is the same as the pool. |bool |Yes (No)| -|expireTime |The expiration time of the service. |string |No (Yes)| +|expireTime |The expiration time of the service in ISO 8601 format. |string |No (Yes)| |saleType |The type of the service. |integer |Yes| |packageType |The package type of the service. |integer |Yes| |customerSize |The customer's size of the service. |integer |Yes| @@ -94,7 +94,7 @@ You can provide the service detailed information in the request body to add a se |resource |The resource of the service. |string |Yes| |subscriptionSourceType |The source of the service. |integer |Yes| |isSameAsPool |Whether the expiration time of the service is the same as the pool. |boolean |Yes (No)| -|expireTime |The expiration time of the service. |string |No (Yes)| +|expireTime |The expiration time of the service in ISO 8601 format. |string |No (Yes)| |userSeat |The number of user seats of the service to assign to the customer. |integer |Yes| |contractEndDate |The contract end date of the service. |string |No | |paymentType |The payment type of the service. |integer |Yes| diff --git a/docs/elements/general/service subscription/get-all-services.md b/docs/elements/general/service subscription/get-all-services.md index e13b7e2..ec1f985 100644 --- a/docs/elements/general/service subscription/get-all-services.md +++ b/docs/elements/general/service subscription/get-all-services.md @@ -26,7 +26,7 @@ This section outlines the parameters that allow users to specify pagination. | Parameter | Description | Type | Required | | --- | --- | --- | --- | -| pageIndex | The starting number of the page to get the violated objects. The default value is 1. | integer | No | +| pageIndex | The starting number of the page to retrieve the services. The default value is 1. | integer | No | | pageSize | The number of objects to display on one page. The default value is 50 and the maximum value allowed is 100. | integer | No | ## Request Body Parameters @@ -35,7 +35,7 @@ This section outlines the request body required to specify which customers you w | Parameter | Description | Type | Required | | --- | --- | --- | --- | -| customerId | The ID of the customer to be retrieved. | string | No | +| customerIds | The ID of the customer to be retrieved. | string[] | No | ## Response @@ -63,7 +63,7 @@ If the request has been successfully processed, a 200 OK response will be return | storage | The storage of the service. | string | | retention | The data retention period of the customer. | string | | consumedStorage | The consumed storage size of the customer. | string | -| expirationDate | The expiration date of the customer’s service. | string | +| expirationDate | The expiration time of the customer’s service in ISO 8601 format. | string | | change | The changes in the pooled license compared with the first day of the current month. | string | | source | The source of the subscription. | string | | paymentType | The payment type of the subscription. | string | @@ -100,7 +100,7 @@ For more details on the HTTP status code, refer to [Http Status Code](../../Use- "storage": "Bring your own storage", // The storage of the service "retention": "N/A", // The data retention period of the customer; not applicable here "consumedStorage": "N/A", // The consumed storage size of the customer; not applicable here - "expirationDate": "2025-09-26T00:00:00Z", // The expiration date of the customer’s service + "expirationDate": "2025-09-26T00:00:00Z", // The expiration time of the customer’s service "change": "N/A", // The changes in the pooled license compared with the first day of the current month; no changes here "source": "AvePoint pooled subscription", // The source of the subscription "paymentType": "Prepaid", // The payment type of the subscription; not applicable here diff --git a/docs/elements/general/tenant/get-3rd-party-products-tenant-type.md b/docs/elements/general/tenant/get-3rd-party-products-tenant-type.md index 3913447..156c49e 100644 --- a/docs/elements/general/tenant/get-3rd-party-products-tenant-type.md +++ b/docs/elements/general/tenant/get-3rd-party-products-tenant-type.md @@ -25,7 +25,7 @@ This section outlines the parameters that allow users to specify pagination. | Parameter | Description | Type | Required | | --- | --- | --- | --- | -| pageIndex | The starting number of the page to get the violated objects. The default value is 1. | integer | No | +| pageIndex | The starting number of the page to get the numbers of assigned and available user seats. The default value is 1. | integer | No | | pageSize | The number of objects to display on one page. The default value is 50 and the maximum value allowed is 100. | integer | No | ## URL Parameters @@ -39,11 +39,11 @@ This section outlines the parameters required to specify which customer tenant y ## Request Body Parameters -This section outlines the request body required to specify the type of user seats you want to retrieve. +This section outlines the request body required to specify the tenants for which you want to retrieve the user seats. | Parameter | Description | Type | Required | | --- | --- | --- | --- | -| licenseAssignedStatus | The type of the user seats. | integer | No | +| tenantIds | The ID of the tenant. | integer | No | ## Response @@ -67,18 +67,20 @@ https://graph.avepointonlineservices.com/partner/external/v3/general/customers/f If the request has been successfully processed, a 200 OK response will be returned along with the requested information displayed in the response body. For more details on the HTTP status code, refer to [Http Status Code](../../Use-AvePoint-Graph-API.md#http-status-code). ```json -[ - { - "type": 0, // The type of the tenant; 0 represents the Microsoft 365 tenant - "tenantId": "f04d7aee-****-****-****-65215f92e596", // The ID of the tenant - "tenantName":"TenantABC", // The name of the tenant - "availableUserSeat": 25, // The number of available user seats of the tenant - "assignedUserSeat": 25 // The number of assigned user seats of the tenant - } +{ + "data": [ + { + "type": 0, // The type of the tenant; 0 represents the Microsoft 365 tenant + "tenantId": "f04d7aee-****-5f92-****-6521****e596", // The ID of the tenant + "tenantName":"TenantABC", // The name of the tenant + "availableUserSeat": 25, // The number of available user seats of the tenant + "assignedUserSeat": 25 // The number of assigned user seats of the tenant + } + ], "metadata": { "pageIndex": 1, // The current display page "pageSize": 50, // The number of objects on the display page "totalCount": 1 // The total number of objects matching the query parameters } -] +} ``` \ No newline at end of file diff --git a/docs/elements/general/tenant/get-cloud-backup-m365-users-batch.md b/docs/elements/general/tenant/get-cloud-backup-m365-users-batch.md index ba80121..f4688e6 100644 --- a/docs/elements/general/tenant/get-cloud-backup-m365-users-batch.md +++ b/docs/elements/general/tenant/get-cloud-backup-m365-users-batch.md @@ -25,7 +25,7 @@ This section outlines the parameters that allow users to specify pagination. | Parameter | Description | Type | Required | | --- | --- | --- | --- | -| pageIndex | The starting number of the page to get the violated objects. The default value is 1. | integer | No | +| pageIndex | The starting number of the page to get the protected status of users. The default value is 1. | integer | No | | pageSize | The number of objects to display on one page. The default value is 50 and the maximum value allowed is 100. | integer | No | ## URL Parameters @@ -43,7 +43,7 @@ This section outlines the request body required to specify which tenant user's p | Parameter | Description | Type | Required | | --- | --- | --- | --- | -| email | The email address of the tenant user to be retrieved | string | No | +| userEmails | The email address of the tenant user to be retrieved. | string[] | No | ## Response @@ -76,7 +76,7 @@ For more details on the HTTP status code, refer to [Http Status Code](../../Use- { "data": [ { - "id": "96c5a607-****-****-****-b1a112d7aeae", // The ID of the tenant user + "id": "96c5a607-****-12d7-****-b1a1****aeae", // The ID of the tenant user "email": "user@domain.onmicrosoft.com", // The email address of the tenant user "displayName":"UserA", // The display name of the tenant user "moduleStatus": @@ -95,7 +95,7 @@ For more details on the HTTP status code, refer to [Http Status Code](../../Use- "metadata": { "pageIndex": 1, // The current display page "pageSize": 50, // The number of objects on the display page - "totalCount": 2 // The total number of objects matching the query parameters + "totalCount": 1// The total number of objects matching the query parameters } } ``` \ No newline at end of file diff --git a/docs/elements/register-app.md b/docs/elements/register-app.md index 0b51228..477d06c 100644 --- a/docs/elements/register-app.md +++ b/docs/elements/register-app.md @@ -137,7 +137,16 @@ Based on the credentials of an app registration in Elements, refer to the follow If you want to get the access token with a client secret in an app registration, follow the instructions below to send a POST request: -1. Set the access token URL: `https://identity.avepointonlineservices.com/connect/token`. +1. Set the access token URL. + + Choose the URL based on your organization's environment: + + | Elements Environment | Access Token URL | + | --------------------------- | --------------------------------------------------------------- | + | Commercial | `https://identity.avepointonlineservices.com/connect/token` | + | U.S. Government | `https://identity-gov.avepointonlineservices.com/connect/token` | + | AOS2 | `https://identity-aos2.avepointonlineservices.com/connect/token`| + | FedRAMP Cloud (Project Hosts)| `https://identity.online15.net/connect/token`| 2. Set the header to `Content-Type: application/x-www-form-urlencoded`. 3. Set the following parameters in the request body: - `client_id` – Copy the Application (Client) ID value from the app registration details page and paste the value here. @@ -157,7 +166,7 @@ The following information is required to get an access token: | Element | Description | |--------------------------|-----------------------------------------------------------------------------| -| Identity Service URL | `https://identity.avepointonlineservices.com` | +| Identity Service URL | `https://identity.avepointonlineservices.com/connect/token` | | Application (Client) ID | The application (client) ID you have retrieved. | | Certificate | The corresponding `.pfx` certificate file of the `.cer` certificate you used when registering the app. | @@ -165,8 +174,18 @@ To get the access token using the above information, create a JSON web token usi Below is an example for getting the access token: +> [!NOTE] +> Adjust the `identityServiceUrl` based on your Elements environment. +> +> |Elements Environment| Identity Service URL| +> |---|---| +> |Commercial | `https://identity.avepointonlineservices.com/connect/token`| +> |U.S. Government |`https://identity-gov.avepointonlineservices.com/connect/token`| +> |AOS2 | `https://identity-aos2.avepointonlineservices.com/connect/token`| +> |FedRAMP Cloud (Project Hosts)| `https://identity.online15.net/connect/token`| + ```json -var identityServiceUrl = "{https://identity.avepointonlineservices.com}"; +var identityServiceUrl = "{https://identity.avepointonlineservices.com/connect/token}"; var client = new HttpClient(); var disco = await client.GetDiscoveryDocumentAsync(identityServiceUrl); if (disco.IsError) diff --git a/docs/elements/risk-management/all-data-source-match-risk-rule.md b/docs/elements/risk-management/all-data-source-match-risk-rule.md index 874780c..a6a2ef3 100644 --- a/docs/elements/risk-management/all-data-source-match-risk-rule.md +++ b/docs/elements/risk-management/all-data-source-match-risk-rule.md @@ -72,20 +72,20 @@ If the request has been successfully processed, a 200 OK response will be return { "result": [ { - "ruleId": "00000002-****-****-****-0000001A", // The ID of the rule + "ruleId": "00000002-****-4830-****-00000019", // The ID of the rule "ruleName": "Users without MFA enabled", // The display name of the rule "setting": null, // The parameter value configured for the rule - "tenantId": "be4cdf40-****-****-****-ab967eb78246", // The tenant ID - "customerId": "292b68c5-****-****-****-28650d407eaf", // The customer ID + "tenantId": "be4cdf40-****-4830-****-ab96****8246", // The tenant ID + "customerId": "292b68c5-****-0d40-****-2865****7eaf", // The customer ID "dataSource": 6, // The data source of the matched objects, Users "hitItemCount": 161 // The number of objects that match the risk rule }, { - "ruleId": "00000002-****-****-****-00000023", + "ruleId": "00000002-****-4A52-****-00000023", "ruleName": "Global administrator without a password expiration date", "setting": null, - "tenantId": "be4cdf40-****-****-****-ab967eb78246", - "customerId": "292b68c5-****-****-****-28650d407eaf", + "tenantId": "be4cdf40-****-7eb7-****-ab96****8246", + "customerId": "292b68c5-****-0d40-****-2865****7eaf", "dataSource": 6, "hitItemCount": 1 } diff --git a/docs/elements/risk-management/specific-rule-detail-hit-items.md b/docs/elements/risk-management/specific-rule-detail-hit-items.md index 1a382ab..2d25a6b 100644 --- a/docs/elements/risk-management/specific-rule-detail-hit-items.md +++ b/docs/elements/risk-management/specific-rule-detail-hit-items.md @@ -69,8 +69,8 @@ If the request has been successfully processed, a 200 OK response will be return | storageUsed | The used storage of the mailbox. The unit is MB. | integer | | prohibitSendReceiveQuota | The prohibit send and recieve quota of the mailbox. The unit is MB.| integer | | recipientType | The recipient type of the mailbox. | integer | -| createdDate | The created date and time of the mailbox. | string | -| lastActivityDate | The date and time of the mailbox's last activity. | string | +| createdDate | The created date and time of the mailbox in ISO 8601 format. | string | +| lastActivityDate | The date and time of the mailbox's last activity in ISO 8601 format. | string | | prohibitSendQuota | The prohibit send quota of the mailbox. The unit is MB.| integer | | mark | The status of the mailbox whether it is marked as fixed. | integer | @@ -85,8 +85,8 @@ If the request has been successfully processed, a 200 OK response will be return | groupType | The type of group. | integer | | ownerCount | The number of owners in the group. | integer | | memberCount | The number of members in the group. | integer | -| createdDate | The created date and time of the group. | string | -| lastActivityDate | The date and tiem of the group's last activity. | string | +| createdDate | The created date and time of the group in ISO 8601 format. | string | +| lastActivityDate | The date and tiem of the group's last activity in ISO 8601 format. | string | | mark | The status of the group whether it is marked as fixed. | integer | | sourceType | The source type of the group. | integer | @@ -100,7 +100,7 @@ If the request has been successfully processed, a 200 OK response will be return | createdBy | The creator name of the Team. | string | | ownerCount | The number of owners in the Team. | integer | | memberCount | The number of members in the Team. | integer | -| lastActivityDate | The date and time of the Team's last activity. | string | +| lastActivityDate | The date and time of the Team's last activity in ISO 8601 format. | string | | mark | The status of the Team whether it is marked as fixed. | integer | | latestCampaignInfo | The detailed information about the Team's campaign. | string | @@ -115,8 +115,8 @@ If the request has been successfully processed, a 200 OK response will be return | storageUsed | The used storage of the site. The unit is MB.| integer | | ownerCount | The number of owners in the site. | integer | | memberCount | The number of members in the site. | integer | -| createdDate | The created date and time of the site. | string | -| lastActivityDate | The date and time of the site's last activity. | string | +| createdDate | The created date and time of the site in ISO 8601 format. | string | +| lastActivityDate | The date and time of the site's last activity in ISO 8601 format. | string | | mark | The status of the site whether it is marked as fixed. | integer | | latestCampaignInfo | The detailed information about the site's campaign. | string | | lockState | The lock status of the site. | integer | @@ -144,8 +144,8 @@ If the request has been successfully processed, a 200 OK response will be return | environmentMakerCount | The number of environment makers. | integer | | region | The environment's region. | integer | | type | The environment type. | integer | -| createdDate | The created date and time of the environment. | string | -| lastActivityDate | The date and time of the environment's last activity. | string | +| createdDate | The created date and time of the environment in ISO 8601 format. | string | +| lastActivityDate | The date and time of the environment's last activity in ISO 8601 format. | string | | totalUsage | The environment's total usage. The unit is Bytes. | integer | | mark | The status of the environment whether it is marked as fixed. | integer | | creatorName | The creator name of the environment. | string | @@ -160,7 +160,7 @@ If the request has been successfully processed, a 200 OK response will be return | connectionName | The display name of the connection. | string | | parentEnvironment | The parent environment of the connection. | string | | createdBy | The creator name of the connection | string | -| createdDate | The created date and time of the connection. | string | +| createdDate | The created date and time of the connection in ISO 8601 format. | string | | mark | The status of the connection whether it is marked as fixed. | integer | @@ -174,9 +174,9 @@ If the request has been successfully processed, a 200 OK response will be return | guestUserCount | The number of guest users in the Power App. | integer | | includedInSolutions | The status whether the Power App is included in a solution. | integer | | coOwnerCount | The number of co-owners in the app. | integer | -| lastSignIn | The time when users last signed in to the app. | string | -| lastLaunchTime | The time when users last launched the app. | string | -| createdDate | The created date and time of the app. | string | +| lastSignIn | The time when users last signed in to the app in ISO 8601 format. | string | +| lastLaunchTime | The time when users last launched the app in ISO 8601 format. | string | +| createdDate | The created date and time of the app in ISO 8601 format. | string | | mark | The status of the app whether it is marked as fixed. | integer | @@ -191,8 +191,8 @@ If the request has been successfully processed, a 200 OK response will be return | type | The flow type. | integer | | includedInSolutions |The status whether the flow is included in a solution. | integer | | coOwnerCount | The number of co-owners in the flow. | integer | -| createdDate | The created date and time of the flow. | string | -| lastActivityDate | The date and time of the flow's last activity. | string | +| createdDate | The created date and time of the flow in ISO 8601 format. | string | +| lastActivityDate | The date and time of the flow's last activity in ISO 8601 format. | string | | lastSignIn | The time when users last signed in to the flow. | string | | mark | The status of the flow whether it is marked as fixed. | integer | @@ -207,8 +207,8 @@ If the request has been successfully processed, a 200 OK response will be return | workspace | The parent workspace name. | string | | sensitivity | The sensitivity level of the Power BI workspace/report. | string | | adminCount | The number of admins. | integer | -| lastActivityDate | The date and time of the last activity in the Power BI workspace/report. | string | -| createdDate | The created date and time of the Power BI workspace/report. | string | +| lastActivityDate | The date and time of the last activity in the Power BI workspace/report in ISO 8601 format. | string | +| createdDate | The created date and time of the Power BI workspace/report in ISO 8601 format. | string | | guestUserCount | The number of guest users. | integer | | reportCount | The number of Power BI reports. | integer | | mark | The status of the workspace/report whether it is marked as fixed. | integer | @@ -226,9 +226,9 @@ If the request has been successfully processed, a 200 OK response will be return | upn | The User Principal Name of the user. | string | | userType | The user type. | integer | | MFAControlledViaCap | The user's MFA status. | bool | -| lastSignIn | The time when the user last signed in to Microsoft 365. | string | -| lastActivityDate | The date and time of the user's last activity. | string | -| createdDate | The created date and time of the user. | string | +| lastSignIn | The time when the user last signed in to Microsoft 365 in ISO 8601 format. | string | +| lastActivityDate | The date and time of the user's last activity in ISO 8601 format. | string | +| createdDate | The created date and time of the user in ISO 8601 format. | string | | signInCount | The number of the user's sign-ins. | integer | | mark | The status of the user whether it is marked as fixed. | integer | | sourceType | The source type of the user. | integer | @@ -269,11 +269,11 @@ If the request has been successfully processed, a 200 OK response will be return "mark": 0, // The status of the group whether it is marked as fixed, not fixed "sourceType": 1 // The source type of the group, Cloud }, - "id": "5824e186-****-****-****-e2aa9a60ac16", // The record ID - "objectid": "e6950ad1-****-****-****-151a1a060d1f", // The object ID - "ruleId": "00000002-****-****-****-00000007", // The ID of the risk rule - "tenantId": "be4cdf40-****-****-****-ab967eb78246", // The tenant ID - "customerId": "292b68c5-****-****-****-28650d407eaf", // The customer ID + "id": "5824e186-****-9a60-****-e2aa****ac16", // The record ID + "objectid": "e6950ad1-****-1a06-****-151a****0d1f", // The object ID + "ruleId": "00000002-****-4A52-****-00000036", // The ID of the risk rule + "tenantId": "0eaab044-****-4a92-****-93c6****711e", // The tenant ID + "customerId": "d926b068-****-4830-****-fd2a****4e99", // The customer ID "dataSource": 2 // The object's data source, Groups } ], diff --git a/docs/elements/user-management/dashboard_public_api/dashboard_public_api.md b/docs/elements/user-management/dashboard_public_api/dashboard_public_api.md index d650114..7874524 100644 --- a/docs/elements/user-management/dashboard_public_api/dashboard_public_api.md +++ b/docs/elements/user-management/dashboard_public_api/dashboard_public_api.md @@ -34,8 +34,8 @@ This section outlines the parameters optional required to specify paging informa | Parameter | Description | Type | Required | | --- | --- | --- | --- | -| pageIndex | The page number of the data to retrieve. The default value is 1. | integer | No | -| pageSize | The number of users to be retrieved in one time. The default value is 100. | integer | No | +| pageIndex | The starting number of the page to get security users. The default value is 1. | integer | No | +| pageSize | The number of objects to display on one page. The default value is 100. | integer | No | | status | The status of the user that you want to retrieve. | integer | No | ## Response @@ -58,18 +58,18 @@ If the request has been successfully processed, a 200 OK response will be return | jobTitle | The job title of the user. | string | | isTestUser | Indicates whether this is a test user account for development purposes. | bool | | age | The password age of the user. | integer | -| startDate | The start date when the user account can sign in Microsoft 365. | string | -| endDate | The date when the user account will be blocked from signing in. | string | +| startDate | The start date in ISO 8601 format when the user account can sign in Microsoft 365. | string | +| endDate | The date in ISO 8601 format when the user account will be blocked from signing in. | string | | countryOrRegion | The country or region of the user. | string | | status | The current status of the user. | integer | -| pageIndex | The page index of current request. | integer | -| pageSize | The user number will be retrieved in one request. | integer | -| totalCount | The total number count that match the request. | integer | +| pageIndex | The current display page. | integer | +| pageSize | The number of objects on the display page. | integer | +| totalCount | The total number of objects matching the query parameters. | integer | ## Request Sample To use this API, send a GET request to the specified endpoint, including necessary parameters as defined in the references. ```json -https://graph.avepointonlineservices.com/partner/external/v3/um/customers/966f35cc-****-****-****-25cdbcf82a07/tenants/0c7715b3-****-****-****-f3634dcfacec/overview/security/users +https://graph.avepointonlineservices.com/partner/external/v3/um/customers/966f35cc-****-87b4-****-25cdbcf82a07/tenants/0c7715b3-****-81b6-****-f3634dcfacec/overview/security/users ``` ## Response Sample @@ -79,15 +79,15 @@ For more details on the HTTP status code, refer to [Http Status Code](../../Use- { "data": [ { - "id": "c2aa00d3-ef87-40aa-a80a-9e9c79232bff", // The ID of the user - "userPrincipalName": "kevin@element.onmicrosoft.com", // The user principle name + "id": "c2aa00d3-****-40aa-****-9e9c79232bff", // The ID of the user + "userPrincipalName": "kevin@domain.com", // The user principle name "displayName": "Kevin Mark", // The display name of the user "firstName": "Kevin", // The first name of the user "lastName": "Mark", // The last name of the user "department": "DEV", // The department of the user "mobile": "11122", // The mobile of the user "jobTitle": "Software developer", // The job title of the user - "mail": "tony@element.onmicrosoft.com", // The mail of the user + "mail": "tony@domain.com", // The mail of the user "location": "location", // The office location of the user "employeeId": "643477", // The employee ID of the user "status": [ @@ -96,16 +96,16 @@ For more details on the HTTP status code, refer to [Http Status Code](../../Use- ], "isTestUser": false, // Indicates whether this is a test user account for development purposes "age": 12, // The password age of the user - "startDate": "1970-01-01T00:00:00Z", // The start date when the user account can sign in Microsoft 365 - "endDate": "1970-01-01T00:00:00Z", // The date when the user account will be blocked from signing in + "startDate": "1970-01-01T00:00:00Z", // The start date in ISO 8601 format when the user account can sign in Microsoft 365 + "endDate": "1970-01-01T00:00:00Z", // The date in ISO 8601 format when the user account will be blocked from signing in "company": "BK Company", // The company of the user "countryOrRegion": "Slovenia" // The country or region of the user } ], "metadata": { - "pageIndex": 1, // The page index of the current request - "pageSize": 50, // The number of users to be retrieved in one request - "totalCount": 1 // The total number count that matches the request + "pageIndex": 1, // The current display page + "pageSize": 50, // The number of objects on the display page + "totalCount": 1 // he total number of objects matching the query parameters } } ``` \ No newline at end of file diff --git a/docs/elements/user-management/risky_public_api/get-compliance-category.md b/docs/elements/user-management/risky_public_api/get-compliance-category.md index 4863ecc..a5f62fd 100644 --- a/docs/elements/user-management/risky_public_api/get-compliance-category.md +++ b/docs/elements/user-management/risky_public_api/get-compliance-category.md @@ -34,8 +34,8 @@ This section outlines the parameters optional required to specify paging informa | Parameter | Description | Type | Required | | --- | --- | --- | --- | -| pageIndex | The page number of the data which will be retrieve, the default value is 1. | integer | No | -| pageSize | The number of users API will retrieved in a time, the default value is 100. | integer | No | +| pageIndex | The starting number of the page to get objects. The default value is 1.| integer | No | +| pageSize | The default value is 50 and the maximum value allowed is 100.| integer | No | ## Response @@ -49,44 +49,41 @@ If the request has been successfully processed, a 200 OK response will be return | userPrincipalName | The user principal name of the risky user. | string | | userId | The unique identifier of the risky user. | string | | loginIP | The IP address in which a user signs in to Microsoft 365. | string | -| loginTime | The sign-in time when user signs in to Microsoft 365. | string | +| loginTime | The sign-in time in ISO 8601 format when user signs in to Microsoft 365. | string | | deviceName | The name of the device that user uses to sign in to Microsoft 365. | string | | accessedFileName | The name of the file that has been accessed. | string | | sensitiveInformation | The sensitive information of the file. | string | -| accessTime | The time when the user accesses the file. | string | +| accessTime | The time in ISO 8601 format when the user accesses the file. | string | ## Request Sample To use this API, send a GET request to the specified endpoint, including necessary parameters as defined in the references. ```json -https://graph.avepointonlineservices.com/partner/external/v3/um/customers/966f35cc-61f4-4070-819c-25cdbcf82a07/tenants/0c7715b3-****-****-****-f3634dcfacec/overview/security/compliances/workflows/4dbd4e4e-****-****-****-2e224d38b0c4 +https://graph.avepointonlineservices.com/partner/external/v3/um/customers/966f35cc-****-4070-****-25cd****2a07/tenants/0c7715b3-****-4dcf-****-f363****acec/overview/security/compliances/workflows/4dbd4e4e-****-4d38-****-2e22****b0c4 ``` ## Response Sample If the request has been successfully processed, a 200 OK response will be returned along with the requested information displayed in the response body. For more details on the HTTP status code, refer to [Http Status Code](../../Use-AvePoint-Graph-API.md#http-status-code). -### Response Sample Multiple IP Login & Multiple Login Failed & External IP Login & Guest User Login - ```json { "last7DayFixCount": 8, // The number of fixed risky actions in last 7 days "riskUserCount": 12, // The number of users who trigger the risk based on the workflow - "riskUsers": { - "items": [ + "items": [ { "userDisplayName": "Mark Kevin", // The display name of the risky user - "userPrincipalName": "mark@element.onmicrosoft.com", // The user principal name of the risky user - "userId": "c2aa00d3-ef87-40aa-a80a-9e9c79232bfe", // The unique identifier of the risky user + "userPrincipalName": "mark@domain.onmicrosoft.com", // The user principal name of the risky user + "userId": "c2aa00d3-****-40aa-****-9e9c79232bfe", // The unique identifier of the risky user "loginIps": [ { - "loginIP": "23.98.122.140", // The IP address in which a user signs in to Microsoft 365 - "loginTime": "1970-01-01T00:00:00Z" // The sign-in time when user signs in to Microsoft 365 + "loginIP": "23.98.***.140", // The IP address in which a user signs in to Microsoft 365 + "loginTime": "1970-01-01T00:00:00Z" // The sign-in time in ISO 8601 format when user signs in to Microsoft 365 } ], "files": [ { "accessedFileName": "report.docx", // The name of the file that has been accessed - "accessTime": "1970-01-01T00:00:00Z", // The time when the user accesses the file + "accessTime": "1970-01-01T00:00:00Z", // The in time in ISO 8601 format when the user accesses the file "sensitiveInformation": "Personal Data" // The sensitive information of the file } ], @@ -97,9 +94,8 @@ If the request has been successfully processed, a 200 OK response will be return ] } ], - "totalCount": 1, // The page index of current request - "pageSize": 50, // The user number will be retrieved in one request - "pageIndex": 1 // The total number count that matches the request - } + "totalCount": 1, // The current display page + "pageSize": 50, // The number of objects on the display page + "pageIndex": 1 // The total number of objects matching the query parameters } ``` \ No newline at end of file diff --git a/docs/elements/user-management/risky_public_api/get-risk-action.md b/docs/elements/user-management/risky_public_api/get-risk-action.md index 7eb4592..7a46bcb 100644 --- a/docs/elements/user-management/risky_public_api/get-risk-action.md +++ b/docs/elements/user-management/risky_public_api/get-risk-action.md @@ -53,7 +53,7 @@ If the request has been successfully processed, a 200 OK response will be return To use this API, send a GET request to the specified endpoint, including necessary parameters as defined in the references. ```json -https://graph.avepointonlineservices.com/partner/external/v3/um/customers/966f35cc-****-****-****-25cdbcf82a07/tenants/0c7715b3-****-****-****-f3634dcfacec/overview/security/compliances/actions +https://graph.avepointonlineservices.com/partner/external/v3/um/customers/966f35cc-****-87b1-****-25cdbcf82a07/tenants/0c7715b3-****-88b2-****-f3634dcfacec/overview/security/compliances/actions ``` ## Response Sample diff --git a/docs/elements/user-management/risky_public_api/get-risk-analyze-workflow.md b/docs/elements/user-management/risky_public_api/get-risk-analyze-workflow.md index 0d23673..d143c32 100644 --- a/docs/elements/user-management/risky_public_api/get-risk-analyze-workflow.md +++ b/docs/elements/user-management/risky_public_api/get-risk-analyze-workflow.md @@ -35,8 +35,8 @@ This section outlines the optional parameters used to specify the information fo | Parameter | Description | Type | Required | | --- | --- | --- | --- | | catagory | The category of the risky actions. | integer | No | -| pageIndex | The page number of the data which will be retrieve, the default value is 1. | integer | No | -| pageSize | The number of users API will retrieved in a time, the default value is 100. | integer | No | +| pageIndex | The starting number of the page to get objects. The default value is 1. | integer | No | +| pageSize | The default value is 50 and the maximum value allowed is 100.| integer | No | ## Response @@ -52,7 +52,7 @@ If the request has been successfully processed, a 200 OK response will be return To use this API, send a GET request to the specified endpoint, including necessary parameters as defined in the references. ```json -https://aostestpartnergcc.sharepointguild.com:5000/external/v3/um/customers/966f35cc-****-****-****-25cdbcf82a07/tenants/0c7715b3-****-****-****-f3634dcfacec/overview/security/compliances/workflows +https://aostestpartnergcc.sharepointguild.com:5000/external/v3/um/customers/966f35cc-****-47vb-****-25cdbcf82a07/tenants/0c7715b3-****-91n4-****-f3634dcfacec/overview/security/compliances/workflows ``` ## Response Sample @@ -63,14 +63,14 @@ If the request has been successfully processed, a 200 OK response will be return { "data": [ { - "workflowId": "8fc933ed-5d54-41fe-909c-afbf326f27ff", // The ID of the workflow + "workflowId": "8fc933ed-****-41fe-****-afbf326f27ff", // The ID of the workflow "workflowDisplayName": "User MFA disabled" // The display name of the workflow } ], "metadata": { - "pageIndex": 1, // The page index of the current request - "pageSize": 50, // The number of workflows to be retrieved in one request - "totalCount": 1 // The total number count that matches the request + "pageIndex": 1, // The current display page + "pageSize": 50, // The number of objects on the display page + "totalCount": 1 // The total number of objects matching the query parameters } } ``` \ No newline at end of file diff --git a/docs/elements/user-management/risky_public_api/get-sign-in.md b/docs/elements/user-management/risky_public_api/get-sign-in.md index 4071f62..6ded3c4 100644 --- a/docs/elements/user-management/risky_public_api/get-sign-in.md +++ b/docs/elements/user-management/risky_public_api/get-sign-in.md @@ -34,8 +34,8 @@ This section outlines the parameters optional required to specify paging informa | Parameter | Description | Type | Required | | --- | --- | --- | --- | -| pageIndex | The page number of the data which will be retrieve, the default value is 1. | integer | No | -| pageSize | The number of users API will retrieved in a time, the default value is 100. | integer | No | +| pageIndex | The starting number of the page to get bjects. The default value is 1. | integer | No | +| pageSize | The default value is 50 and the maximum value allowed is 100. | integer | No | | risky | Indicate whether you want to retrieve only risky sign-ins. | bool | No | ## Response @@ -45,7 +45,7 @@ If the request has been successfully processed, a 200 OK response will be return | Response | Description | Type | | --- | --- | --- | | id | The unique identifier of the sign-in record. | string | -| loginTime | The sign-in time. | long | +| loginTime | The sign-in time in ISO 8601 format. | long | | userId | The unique identifier of the user. | string | | userDisplayName | The display name of the user. | string | | userPrincipalName | The user principal name. | string | @@ -61,7 +61,7 @@ If the request has been successfully processed, a 200 OK response will be return To use this API, send a GET request to the specified endpoint, including necessary parameters as defined in the references. ```json -https://graph.avepointonlineservices.com/partner/external/v3/um/customers/966f35cc-61f4-4070-819c-25cdbcf82a07/tenants/0c7715b3-bc2f-4c4c-a8a0-f3634dcfacec/overview/security/compliances/signins +https://graph.avepointonlineservices.com/partner/external/v3/um/customers/966f35cc-****-4070-****-25cd****2a07/tenants/0c7715b3-****-4c4c-****-f363****acec/overview/security/compliances/signins ``` ## Response Sample @@ -72,11 +72,11 @@ If the request has been successfully processed, a 200 OK response will be return { "data": [ { - "id": "001f0090-****-****-****-b2c060e52500", // The unique identifier of the sign-in record - "loginTime": 638907426550000000, // The sign-in time - "userId": "4140b563-****-****-****-5f44dadcf0fd", // The unique identifier of the user + "id": "001f0090-****-60e5-****-b2c0****2500", // The unique identifier of the sign-in record + "loginTime": "1970-01-01T00:00:00Z", // The sign-in time in ISO 8601 format + "userId": "4140b563-****-dadc-****-5f44****f0fd", // The unique identifier of the user "userDisplayName": "Bob Mark", // The display name of the user. - "userPrincipalName": "mark@element.onmicrosoft.com", // The user principal name + "userPrincipalName": "Bob@domain.com", // The user principal name "ip": "74.207.240.85", // The IP address of the sign-in record "lat": 37.56699, // The latitude of the sign-in record "lon": -121.9827, // The longitude of the sign-in record @@ -86,9 +86,9 @@ If the request has been successfully processed, a 200 OK response will be return }, ], "metadata": { - "pageIndex": 1, // The page index of current request - "pageSize": 50, // The number will be retrieved in one request - "totalCount": 1 // The total number count that matches the request + "pageIndex": 1, // The current display page + "pageSize": 50, // The number of objects on the display page + "totalCount": 1 // The total number of objects matching the query parameters } } ``` \ No newline at end of file diff --git a/docs/elements/user-management/user_public_api/get-information-user.md b/docs/elements/user-management/user_public_api/get-information-user.md index bf2b8dd..c39dea7 100644 --- a/docs/elements/user-management/user_public_api/get-information-user.md +++ b/docs/elements/user-management/user_public_api/get-information-user.md @@ -57,9 +57,9 @@ If the request has been successfully processed, a 200 OK response will be return | usageLocation | The usage location for the user account, typically a country code (AF: Afghanistan). | string | | preferredLanguage | The preferred language setting for the user interface. | string | | enforceStart | Indicates whether account enforcement start date is enabled. | boolean | -| enforceStartDateTime | The date and time when account enforcement begins. | string | +| enforceStartDateTime | The date and time in ISO 8601 format when account enforcement begins. | string | | enforceEnd | Indicates whether account enforcement end date is enabled. | boolean | -| enforceEndDateTime | The date and time when account enforcement ends. | string | +| enforceEndDateTime | The date and time in ISO 8601 format when account enforcement ends. | string | | postalCode | The postal code of the user. | string | | countryRegion | The country or region where the user is located. | string | | state | The state or province where the user is located. | string | @@ -72,7 +72,7 @@ If the request has been successfully processed, a 200 OK response will be return To use this API, send a GET request to the specified endpoint, including necessary parameters as defined in the references. ```json -https://graph.avepointonlineservices.com/partner/external/v3/um/customers/966f35cc-****-****-****-25cdbcf82a07/tenants/0c7715b3-bc2f-4c4c-a8a0-f3634dcfacec/users/7c18fd6f-****-****-****-5725fa9edc3f +https://graph.avepointonlineservices.com/partner/external/v3/um/customers/966f35cc-****-****-****-25cdbcf82a07/tenants/0c7715b3-****-4c4c-****-f3634dcfacec/users/7c18fd6f-****-89b6-****-5725fa9edc3f ``` ## Response Sample @@ -82,15 +82,15 @@ For more details on the HTTP status code, refer to [Http Status Code](../../Use- ```json { - "id": "7c18fd6f-****-****-****-5725fa9edc3f", // The ID of the user - "manager": "user@element.onmicrosoft.com", // The manager of the user + "id": "7c18fd6f-****-89b6-****-5725fa9edc3f", // The ID of the user + "manager": "user@domain.com", // The manager of the user "firstName": "Tony", // The first name of the user "lastName": "Brown", // The last name of the user "displayName": "Tony Brown", // The display name of the user "jobTitle": "IT", // The job title of the user "employeeId": "099999", // The employee ID of the user "alternateEmailAddress": [ - "Tony_Al@element.onmicrosoft.com" // The alternate email address of the user + "Tony_Al@domain.com" // The alternate email address of the user ], "company": "Organization ABC", // The company of the user "department": "DEV", // The department of the user @@ -102,18 +102,18 @@ For more details on the HTTP status code, refer to [Http Status Code](../../Use- "officePhone": "232****9754", // The business phone number of the user "mobile": "323****76", // The mobile phone number of the user. "birthday": "1970-01-01T00:00:00Z", // The birthday of the user - "mail": "tony@element.onmicrosoft.com", // The primary email address of the user + "mail": "tony@domain.com", // The primary email address of the user "usageLocation": "AF", // The usage location for the user account, typically a country code "preferredLanguage": "af-NA", // The preferred language setting for the user interface "enforceStart": false, // Indicates whether account enforcement start date is enabled - "enforceStartDateTime": "1970-01-01T00:00:00Z", // The date and time when account enforcement begins + "enforceStartDateTime": "1970-01-01T00:00:00Z", // The date and time in ISO 8601 format when account enforcement begins "enforceEnd": false, // Indicates whether account enforcement end date is enabled - "enforceEndDateTime": "1970-01-01T00:00:00Z", // The date and time when account enforcement ends + "enforceEndDateTime": "1970-01-01T00:00:00Z", // The date and time in ISO 8601 format when account enforcement ends "postalCode": "2121", // The postal code of the user "countryRegion": "United States", // The country or region where the user is located "state": "Los Angeles", // The state or province where the user is located "address": "Rothera Research Station", // The street address of the user's location - "loginName": "tony@element.onmicrosoft.com", // The login name or user principal name used for authentication + "loginName": "tony@domain.com", // The login name or user principal name used for authentication "status": [ 0, // The current status of the user. 0 represents "MFA disabled" 1 // The current status of the user. 1 represents "Sign-in blocked" diff --git a/docs/elements/user-management/user_public_api/get-multi-information-users.md b/docs/elements/user-management/user_public_api/get-multi-information-users.md index d01ee2f..e7d1262 100644 --- a/docs/elements/user-management/user_public_api/get-multi-information-users.md +++ b/docs/elements/user-management/user_public_api/get-multi-information-users.md @@ -34,8 +34,8 @@ This section outlines the parameters optional required to specify paging informa | Parameter | Description | Type | Required | | --- | --- | --- | --- | -| pageIndex | The page number of the data to retrieve. The default value is 1. | integer | No | -| pageSize | The number of users that will be retrieved in one time. The default value is 100. | integer | No | +| pageIndex | The starting number of the page to get users. The default value is 1. | integer | No | +| pageSize | The default value is 50 and the maximum value allowed is 100.| integer | No | ## Request Body @@ -65,8 +65,8 @@ If the request has been successfully processed, a 200 OK response will be return | jobTitle | The job title of the user. | string | | isTestUser | Indicates whether the user account is a test user for development purposes. | bool | | age | The password age of the user. | integer | -| startDate | The start date when the user account can sign in to Microsoft 365.| string | -| endDate | The date when the user account will be blocked from signing in.| string | +| startDate | The start date in ISO 8601 format when the user account can sign in to Microsoft 365.| string | +| endDate | The date in ISO 8601 format when the user account will be blocked from signing in.| string | | countryOrRegion | The country or region of the user. | string | | status | The current status of the user account. | integer | | pageIndex | The page index of current request. | integer | @@ -78,7 +78,15 @@ If the request has been successfully processed, a 200 OK response will be return To use this API, send a GET request to the specified endpoint, including necessary parameters as defined in the references. ```json -https://graph.avepointonlineservices.com/partner/external/v3/um/customers/966f35cc-****-****-****-25cdbcf82a07/tenants/0c7715b3-****-****-****-f3634dcfacec/users/batch +https://graph.avepointonlineservices.com/partner/external/v3/um/customers/966f35cc-****-25v7-****-25cdbcf82a07/tenants/0c7715b3-****-17b9-****-f3634dcfacec/users/batch +``` + +## Request Body Sample + +```json +{ + "userIds":["c2aa00d3-****-36v7-****-9e9c79232bff"] +} ``` ## Response Sample @@ -89,15 +97,15 @@ If the request has been successfully processed, a 200 OK response will be return { "data": [ { - "id": "c2aa00d3-****-****-****-9e9c79232bff", // The ID of the user - "userPrincipalName": "tony@element.onmicrosoft.com", // The user principle name + "id": "c2aa00d3-****-36v7-****-9e9c79232bff", // The ID of the user + "userPrincipalName": "tony@domain.com", // The user principle name "displayName": "Kevin Mark", // The display name of the user "firstName": "Kevin", // The first name of the user "lastName": "Mark", // The last name of the user "department": "DEV", // The department of the user "mobile": "11122", // The mobile of the user "jobTitle": "Software developer", // The job title of the user - "mail": "tony@element.onmicrosoft.com", // The mail of the user + "mail": "tony@domain.com", // The mail of the user "location": "location", // The office location of the user "employeeId": "643477", // The employee ID of the user "status": [ @@ -106,15 +114,15 @@ If the request has been successfully processed, a 200 OK response will be return ], "isTestUser": false, // Indicates whether the user abbount is a test user for development purposes "age": 12, // The password age of the user - "startDate": "1970-01-01T00:00:00Z", // The start date when the user account can sign in to Microsoft 365 - "endDate": "1970-01-01T00:00:00Z", // The date when the user account will be blocked from signing in + "startDate": "1970-01-01T00:00:00Z", // The start date in ISO 8601 format when the user account can sign in to Microsoft 365 + "endDate": "1970-01-01T00:00:00Z", // The date in ISO 8601 format when the user account will be blocked from signing in "company": "Organization ABC", // The company of the user "countryOrRegion": "Slovenia" // The country or region of the user } ], "metadata": { - "pageIndex": 1, // The page index of the current request - "pageSize": 50, // The number of users to be retrieved in one request - "totalCount": 1 // The total number count that matches the request + "pageIndex": 1, // The current display page + "pageSize": 50, // The number of objects on the display page + "totalCount": 1 // The total number of objects matching the query parameters } } diff --git a/docs/elements/user-management/user_public_api/update-account-information.md b/docs/elements/user-management/user_public_api/update-account-information.md index c17b06f..8071809 100644 --- a/docs/elements/user-management/user_public_api/update-account-information.md +++ b/docs/elements/user-management/user_public_api/update-account-information.md @@ -39,9 +39,9 @@ This section outlines the required fields to update the information of a specifi | usageLocation | The usage location of the user. The maximum length is 128 characters. For details, refer to [Usage Locations](../../../elements/user-management/user_public_api/usage_location.md).| string | Yes | | preferredLanguage | The preferred language of the user. For details, refer to [Preferred Languages](../../../elements/user-management/user_public_api/language.md). | string | Yes | | enforceStart | Indicates whether account enforcement start date is enabled. | bool | Yes | -| enforceStartDateTime |The date and time when account enforcement begins.| string | Yes | +| enforceStartDateTime |The date and time in ISO 8601 format when account enforcement begins.| string | Yes | | enforceEnd |Indicates whether account enforcement end date is enabled. | bool | Yes | -| enforceEndDateTime |The date and time when account enforcement ends. | string | Yes | +| enforceEndDateTime |The date and time in ISO 8601 format when account enforcement ends. | string | Yes | ## Response @@ -52,18 +52,18 @@ If the request has been successfully processed, a 204 No Content response will b To use this API, send a PUT request to the specified endpoint, including necessary parameters as defined in the references. ```json -https://graph.avepointonlineservices.com/partner/external/v3/um/customers/966f35cc-****-****-****-25cdbcf82a07/tenants/0c7715b3-****-****-****-f3634dcfacec/users/7c18fd6f-****-****-****-5725fa9edc3f/account-information +https://graph.avepointonlineservices.com/partner/external/v3/um/customers/966f35cc-****-57v8-****-25cdbcf82a07/tenants/0c7715b3-****-25x9-****-f3634dcfacec/users/7c18fd6f-****-24v6-****-5725fa9edc3f/account-information ``` ## Request Body Sample ```json { - "mail": "tony@element.onmicrosoft.com", // The mail of the user + "mail": "tony@domain.com", // The mail of the user "usageLocation": "AF", // The usage location of the user "preferredLanguage": "af-NA", // The preferred language of the user "enforceStart": true, // Indicates whether account enforcement start date is enabled - "enforceStartDateTime": "1970-01-01T00:00:00Z", // The date and time when account enforcement begins + "enforceStartDateTime": "1970-01-01T00:00:00Z", // The date and time in ISO 8601 format when account enforcement begins "enforceEnd": true, // Indicates whether account enforcement end date is enabled - "enforceEndDateTime": "1970-01-01T00:00:00Z" // The date and time when account enforcement ends + "enforceEndDateTime": "1970-01-01T00:00:00Z" // The date and time in ISO 8601 format when account enforcement ends } ``` \ No newline at end of file diff --git a/docs/elements/user-management/user_public_api/update-birthday.md b/docs/elements/user-management/user_public_api/update-birthday.md index 751e2cb..778aa2b 100644 --- a/docs/elements/user-management/user_public_api/update-birthday.md +++ b/docs/elements/user-management/user_public_api/update-birthday.md @@ -35,7 +35,7 @@ This section outlines the required fields to update the birthday of a specific u | Parameter | Description | Type | Required | | --- | --- | --- | --- | -| birthday | The birthday of the user. | string | Yes | +| birthday | The birthday of the user in ISO 8601 format. | string | Yes | ## Response @@ -46,12 +46,12 @@ If the request has been successfully processed, a 204 No Content response will b To use this API, send a PUT request to the specified endpoint, including necessary parameters as defined in the references. ```json -https://graph.avepointonlineservices.com/partner/external/v3/um/customers/966f35cc-****-****-****-25cdbcf82a07/tenants/0c7715b3-****-****-****-f3634dcfacec/users/7c18fd6f-****-****-****-5725fa9edc3f/birthday +https://graph.avepointonlineservices.com/partner/external/v3/um/customers/966f35cc-****-36v6-****-25cdbcf82a07/tenants/0c7715b3-****-18a7-****-f3634dcfacec/users/7c18fd6f-****-26c3-****-5725fa9edc3f/birthday ``` ## Request Body Sample ```json { - "birthday": "1970-01-01T00:00:00Z" // The birthday of the user + "birthday": "1970-01-01T00:00:00Z" // The birthday of the user in ISO 8601 format } ``` \ No newline at end of file diff --git a/docs/elements/user-management/user_public_api/update-contact-information.md b/docs/elements/user-management/user_public_api/update-contact-information.md index b1d6597..833e027 100644 --- a/docs/elements/user-management/user_public_api/update-contact-information.md +++ b/docs/elements/user-management/user_public_api/update-contact-information.md @@ -35,7 +35,7 @@ This section outlines the required fields to update the contact information of a | Parameter | Description | Type | Required | | --- | --- | --- | --- | -| phone | The business phone number of the user. The maximum length is 64 characters.| string | Yes | +| officePhone | The business phone number of the user. The maximum length is 64 characters.| string | Yes | | mobile | The mobile phone number of the user. The maximum length is 64 characters.| string | Yes | ## Response @@ -47,7 +47,7 @@ If the request has been successfully processed, a 204 No Content response will b To use this API, send a PUT request to the specified endpoint, including necessary parameters as defined in the references. ```json -https://graph.avepointonlineservices.com/partner/external/v3/um/customers/966f35cc-****-****-****-25cdbcf82a07/tenants/0c7715b3-****-****-****-f3634dcfacec/users/7c18fd6f-****-****-****-5725fa9edc3f/contact-information +https://graph.avepointonlineservices.com/partner/external/v3/um/customers/966f35cc-****-25v6-****-25cdbcf82a07/tenants/0c7715b3-****-46s7-****-f3634dcfacec/users/7c18fd6f-****-87c6-****-5725fa9edc3f/contact-information ``` ## Request Body Sample diff --git a/docs/elements/user-management/user_public_api/update-email-address.md b/docs/elements/user-management/user_public_api/update-email-address.md index aef4795..3b304b6 100644 --- a/docs/elements/user-management/user_public_api/update-email-address.md +++ b/docs/elements/user-management/user_public_api/update-email-address.md @@ -47,7 +47,7 @@ If the request has been successfully processed, a 204 No Content response will b To use this API, send a PUT request to the specified endpoint, including necessary parameters as defined in the references. ```json -https://graph.avepointonlineservices.com/partner/external/v3/um/customers/966f35cc-****-****-****-25cdbcf82a07/tenants/0c7715b3-****-****-****-f3634dcfacec/users/7c18fd6f-****-****-****-5725fa9edc3f/alternate-email-address +https://graph.avepointonlineservices.com/partner/external/v3/um/customers/966f35cc-****-5902-****-25cd****2a07/tenants/0c7715b3-****-4dcf-****-f363****acec/users/7c18fd6f-****-fa9e-****-5725****dc3f/alternate-email-address ``` ## Request Body Sample @@ -55,8 +55,8 @@ https://graph.avepointonlineservices.com/partner/external/v3/um/customers/966f35 ```json { "alternateEmailAddress": [ - "Tony@element.onmicrosoft.com", // The alternate email address of the user - "Tony_mark@element.onmicrosoft.com" + "Tony@domain.com", // The alternate email address of the user + "Tony_alternate@domain.com" ] } ``` diff --git a/docs/elements/user-management/user_public_api/update-general-information.md b/docs/elements/user-management/user_public_api/update-general-information.md index 6f6e5e8..ee79525 100644 --- a/docs/elements/user-management/user_public_api/update-general-information.md +++ b/docs/elements/user-management/user_public_api/update-general-information.md @@ -51,7 +51,7 @@ If the request has been successfully processed, a 204 No Content response will b To use this API, send a PUT request to the specified endpoint, including necessary parameters as defined in the references. ```json -https://graph.avepointonlineservices.com/partner/external/v3/um/customers/966f35cc-****-****-****-25cdbcf82a07/tenants/0c7715b3-****-****-****-f3634dcfacec/users/7c18fd6f-****-****-****-5725fa9edc3f/general-information +https://graph.avepointonlineservices.com/partner/external/v3/um/customers/966f35cc-****-86a8-****-25cdbcf82a07/tenants/0c7715b3-****-35c6-****-f3634dcfacec/users/7c18fd6f-****-98v3-****-5725fa9edc3f/general-information ``` ## Request Body Sample diff --git a/docs/elements/user-management/user_public_api/update-istest.md b/docs/elements/user-management/user_public_api/update-istest.md index 628dc06..6b0113a 100644 --- a/docs/elements/user-management/user_public_api/update-istest.md +++ b/docs/elements/user-management/user_public_api/update-istest.md @@ -47,7 +47,7 @@ If the request has been successfully processed, a 204 No Content response will b To use this API, send a PUT request to the specified endpoint, including necessary parameters as defined in the references. ```json -https://graph.avepointonlineservices.com/partner/external/v3/um/customers/966f35cc-****-****-****-25cdbcf82a07/tenants/0c7715b3-****-****-****-f3634dcfacec/users/7c18fd6f-****-****-****-5725fa9edc3f/istest +https://graph.avepointonlineservices.com/partner/external/v3/um/customers/966f35cc-****-78d4-****-25cdbcf82a07/tenants/0c7715b3-****-89v1-****-f3634dcfacec/users/7c18fd6f-****-86c9-****-5725fa9edc3f/istest ``` ## Request Body Sample diff --git a/docs/elements/user-management/user_public_api/update-manager.md b/docs/elements/user-management/user_public_api/update-manager.md index 9364e51..29e979e 100644 --- a/docs/elements/user-management/user_public_api/update-manager.md +++ b/docs/elements/user-management/user_public_api/update-manager.md @@ -35,7 +35,6 @@ This section outlines the required fields to update the manager of a specific us | Parameter | Description | Type | Required | | --- | --- | --- | --- | -| id | The ID of the manager. The maximum length is 40 characters.| string | Yes | | userPrincipalName | The user principal name of the manager. The maximum length is 1024 characters. For user types other than cloud users, the userPrincipalName property contains the distinguished name (DN) of the manager. Example: "userPrincipalName": "CN=Terry Gu,DC=dev1,DC=com".| string | Yes | ## Response @@ -47,13 +46,12 @@ If the request has been successfully processed, a 204 No Content response will b To use this API, send a PUT request to the specified endpoint, including necessary parameters as defined in the references. ```json -https://graph.avepointonlineservices.com/partner/external/v3/um/customers/966f35cc-61f4-4070-819c-25cdbcf82a07/tenants/0c7715b3-bc2f-4c4c-a8a0-f3634dcfacec/users/7c18fd6f-fb26-4353-8dbd-5725fa9edc3f/manager +https://graph.avepointonlineservices.com/partner/external/v3/um/customers/966f35cc-****-4070-****-25cd****2a07/tenants/0c7715b3-****-4c4c-****-f363****acec/users/7c18fd6f-****-4353-****-5725****dc3f/manager ``` ## Request Body Sample ```json { - "id": "631b0def-****-****-****-5811518ebbea", // The ID of the manager - "userPrincipalName": "tony@element.onmicrosoft.com" // The user principal name of the manager. + "userPrincipalName": "tony@domain.com" // The user principal name of the manager } ``` \ No newline at end of file diff --git a/docs/elements/user-management/user_public_api/update-office-information.md b/docs/elements/user-management/user_public_api/update-office-information.md index 24f5e9d..c1c2509 100644 --- a/docs/elements/user-management/user_public_api/update-office-information.md +++ b/docs/elements/user-management/user_public_api/update-office-information.md @@ -49,7 +49,7 @@ If the request has been successfully processed, a 204 No Content response will b To use this API, send a PUT request to the specified endpoint, including necessary parameters as defined in the references. ```json -https://graph.avepointonlineservices.com/partner/external/um/v3/customers/966f35cc-****-****-****-25cdbcf82a07/tenants/0c7715b3-****-****-****-f3634dcfacec/users/7c18fd6f-****-****-****-5725fa9edc3f/office-information +https://graph.avepointonlineservices.com/partner/external/um/v3/customers/966f35cc-****-98b2-****-25cdbcf82a07/tenants/0c7715b3-****-16v8-****-f3634dcfacec/users/7c18fd6f-****-91c6-****-5725fa9edc3f/office-information ``` ## Request Body Sample diff --git a/docs/elements/user-management/user_public_api/update-office.md b/docs/elements/user-management/user_public_api/update-office.md index 4426011..2c9dcce 100644 --- a/docs/elements/user-management/user_public_api/update-office.md +++ b/docs/elements/user-management/user_public_api/update-office.md @@ -49,7 +49,7 @@ If the request has been successfully processed, a 204 No Content response will b To use this API, send a PUT request to the specified endpoint, including necessary parameters as defined in the references. ```json -https://graph.avepointonlineservices.com/partner/external/v3/um/customers/966f35cc-****-****-****-25cdbcf82a07/tenants/0c7715b3-****-****-****-f3634dcfacec/users/7c18fd6f-****-****-****-5725fa9edc3f/office +https://graph.avepointonlineservices.com/partner/external/v3/um/customers/966f35cc-****-98b1-****-25cdbcf82a07/tenants/0c7715b3-****-16b5-****-f3634dcfacec/users/7c18fd6f-****-87b2-****-5725fa9edc3f/office ``` ## Request Body Sample diff --git a/docs/elements/user-management/user_public_api/update-password-setting.md b/docs/elements/user-management/user_public_api/update-password-setting.md index 4648f46..4c9c74d 100644 --- a/docs/elements/user-management/user_public_api/update-password-setting.md +++ b/docs/elements/user-management/user_public_api/update-password-setting.md @@ -46,7 +46,7 @@ If the request has been successfully processed, a 204 No Content response will b To use this API, send a PUT request to the specified endpoint, including necessary parameters as defined in the references. ```json -https://graph.avepointonlineservices.com/partner/external/v3/um/customers/966f35cc-****-****-****-25cdbcf82a07/tenants/0c7715b3-****-****-****-f3634dcfacec/users/7c18fd6f-****-****-****-5725fa9edc3f/password-setting +https://graph.avepointonlineservices.com/partner/external/v3/um/customers/966f35cc-****-89b2-****-25cdbcf82a07/tenants/0c7715b3-****-27s3-****-f3634dcfacec/users/7c18fd6f-****-36m7-****-5725fa9edc3f/password-setting ``` ## Request Body Sample