Skip to content

Commit

Permalink
Merge pull request #23497 from microsoftgraph/fix#8777
Browse files Browse the repository at this point in the history
Link to license requirements for different Entra reports
  • Loading branch information
Lauragra authored Jan 31, 2024
2 parents 6215af0 + bb0b736 commit 5a96642
Show file tree
Hide file tree
Showing 11 changed files with 25 additions and 43 deletions.
22 changes: 8 additions & 14 deletions api-reference/beta/resources/azure-ad-auditlog-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,20 +66,14 @@ GET custom security attribute audit logs | [https://graph.microsoft.com/beta/aud
GET tenant user sign-ins | [https://graph.microsoft.com/beta/auditLogs/signIns](https://developer.microsoft.com/graph/graph-explorer?request=auditLogs/signIns&version=beta)
GET provisioning logs | [https://graph.microsoft.com/beta/auditLogs/provisioning](https://developer.microsoft.com/graph/graph-explorer?request=auditLogs/Provisioning&version=beta)

## What licenses do I need?
## License requirements

Activity reports are available for features that you've licensed. If you have a license for a specific feature, you also have access to the reports.
Activity reports are available for features that you've licensed. If you have a license for a specific feature, you also have access to the reports. For more information about license requirements for the different activity reports, see [Microsoft Entra audit logs: License and role requirements](/entra/identity/monitoring-health/concept-audit-logs#license-and-role-requirements).

For example, you need a Microsoft Entra ID P1 license to access self-service password audit reports. To learn more, see [Microsoft Entra ID licensing](https://azure.microsoft.com/pricing/details/active-directory/).
## Related content

Sign-in reports require a Microsoft Entra ID P1 or P2 license.

To learn more, see [Microsoft Entra pricing](https://azure.microsoft.com/pricing/details/active-directory/).

## Next steps

- [Register your app](/azure/active-directory/active-directory-reporting-api-prerequisites-azure-portal) to satisfy report prerequisites.
- To learn how to retrieve audit logs while authenticated using certificates, see [Tutorial: Get data using the Microsoft Entra reporting API with certificates](/azure/active-directory/reports-monitoring/tutorial-access-api-with-certificates).
- Review the [directoryAudit](directoryaudit.md) resource and actions.
- Review the [signIn](signin.md) resource and actions.
- Review the [provisioningObjectSummary](provisioningobjectsummary.md) resource.
- Start working with the following resources representing the different activity reports:
- [directoryAudit](directoryaudit.md) resource type.
- [signIn](signin.md) resource type.
- [provisioningObjectSummary](provisioningobjectsummary.md) resource type.
- [customSecurityAttributeAudit](customsecurityattributeaudit.md) resource type.
2 changes: 1 addition & 1 deletion api-reference/beta/resources/credentialusagesummary.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Namespace: microsoft.graph

[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]

Represents the current state of how many users in your organization are using self-service password reset capabilities.
Represents the current state of how many users in your organization are using self-service password reset capabilities. For more information about license requirements for this feature, see [Authentication Methods Activity: Permissions and licenses](/entra/identity/authentication/howto-authentication-methods-activity#permissions-and-licenses).

## Methods

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Namespace: microsoft.graph

[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]

Represents the current state of how many users in your organization are registered for self-service password reset and multifactor authentication capabilities.
Represents the current state of how many users in your organization are registered for self-service password reset and multifactor authentication capabilities. For more information about license requirements for this feature, see [Authentication Methods Activity: Permissions and licenses](/entra/identity/authentication/howto-authentication-methods-activity#permissions-and-licenses).

## Methods

Expand Down
2 changes: 1 addition & 1 deletion api-reference/beta/resources/usercredentialusagedetails.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Namespace: microsoft.graph

[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]

Represents the self-service password reset usage for a given tenant. Details include user information, status of the reset, and the reason for failure.
Represents the self-service password reset usage for a given tenant. Details include user information, status of the reset, and the reason for failure. For more information about license requirements for this feature, see [Authentication Methods Activity: Permissions and licenses](/entra/identity/authentication/howto-authentication-methods-activity#permissions-and-licenses).

## Methods

Expand Down
2 changes: 1 addition & 1 deletion api-reference/beta/resources/userregistrationdetails.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Namespace: microsoft.graph

[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]

Represents the state of a user's authentication methods, including which methods are registered and which features the user is registered and capable of. (For example, multifactor authentication, self-service password reset, and passwordless authentication.)
Represents the state of a user's authentication methods, including which methods are registered and which features the user is registered and capable of. For example, multifactor authentication, self-service password reset, and passwordless authentication. For more information about license requirements for this feature, see [Authentication Methods Activity: Permissions and licenses](/entra/identity/authentication/howto-authentication-methods-activity#permissions-and-licenses).

Inherits from [entity](../resources/entity.md).

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Namespace: microsoft.graph

[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]

Represents the summary of users capable of multifactor authentication, self-service password reset, and passwordless authentication in an organization.
Represents the summary of users capable of multifactor authentication, self-service password reset, and passwordless authentication in an organization. For more information about license requirements for this feature, see [Authentication Methods Activity: Permissions and licenses](/entra/identity/authentication/howto-authentication-methods-activity#permissions-and-licenses).

## Methods

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Namespace: microsoft.graph

[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]

Represents the summary of number of users registered for each authentication method.
Represents the summary of number of users registered for each authentication method. For more information about license requirements for this feature, see [Authentication Methods Activity: Permissions and licenses](/entra/identity/authentication/howto-authentication-methods-activity#permissions-and-licenses).

## Methods

Expand Down
28 changes: 8 additions & 20 deletions api-reference/v1.0/resources/azure-ad-auditlog-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,26 +50,14 @@ Operation | URL
GET tenant user activities | [GET https://graph.microsoft.com/v1.0/auditLogs/directoryAudits](https://developer.microsoft.com/graph/graph-explorer?request=auditLogs/directoryAudits&version=v1.0)
GET tenant user sign-ins | [GET https://graph.microsoft.com/v1.0/auditLogs/signIns](https://developer.microsoft.com/graph/graph-explorer?request=auditLogs/signIns&version=v1.0)

## What licenses do I need?
## License requirements

Activity reports are available for features that you've licensed. If you have a license for a specific feature, you also have access to the reports.
Activity reports are available for features that you've licensed. If you have a license for a specific feature, you also have access to the reports. For more information about license requirements for the different activity reports, see [Microsoft Entra audit logs: License and role requirements](/entra/identity/monitoring-health/concept-audit-logs#license-and-role-requirements).

For example, you need a Microsoft Entra ID P1 license to access self-service password audit reports. To learn more, see [Microsoft Entra ID licensing](https://azure.microsoft.com/pricing/details/active-directory/).
## Related content

Sign-in reports require a Microsoft Entra ID P1 or P2 license.

To learn more, see [Microsoft Entra pricing](https://azure.microsoft.com/pricing/details/active-directory/).

## Next Steps

- [Register your app](/azure/active-directory/active-directory-reporting-api-prerequisites-azure-portal) to satisfy report prerequisites.
- To learn how to retrieve audit logs while authenticated using certificates, see [Tutorial: Get data using the Microsoft Entra reporting API with certificates](/azure/active-directory/reports-monitoring/tutorial-access-api-with-certificates).
- Review [directoryAudit](directoryaudit.md) resource and actions.
- Review [signIn](signin.md) resource and actions.
<!--
{
"type": "#page.annotation",
"suppressions": [
]
}
-->
- Start working with the following resources representing the different activity reports:
- [directoryAudit](directoryaudit.md) resource type.
- [signIn](signin.md) resource type.
- [provisioningObjectSummary](provisioningobjectsummary.md) resource type.
<!-- - [customSecurityAttributeAudit](customsecurityattributeaudit.md) resource type. -->
2 changes: 1 addition & 1 deletion api-reference/v1.0/resources/userregistrationdetails.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ doc_type: resourcePageType

Namespace: microsoft.graph

Represents the state of a user's authentication methods, including which methods are registered and which features the user is registered and capable of, such as multifactor authentication, self-service password reset, and passwordless authentication.
Represents the state of a user's authentication methods, including which methods are registered and which features the user is registered and capable of, such as multifactor authentication, self-service password reset, and passwordless authentication. For more information about license requirements for this feature, see [Authentication Methods Activity: Permissions and licenses](/entra/identity/authentication/howto-authentication-methods-activity#permissions-and-licenses).

Inherits from [entity](../resources/entity.md).

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ doc_type: resourcePageType

Namespace: microsoft.graph

Represents the summary of users capable of multi-factor authentication, self-service password reset, and passwordless authentication in an organization.
Represents the summary of users capable of multi-factor authentication, self-service password reset, and passwordless authentication in an organization. For more information about license requirements for this feature, see [Authentication Methods Activity: Permissions and licenses](/entra/identity/authentication/howto-authentication-methods-activity#permissions-and-licenses).

## Methods

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ doc_type: resourcePageType

Namespace: microsoft.graph

Represents the summary of number of users registered for each authentication method.
Represents the summary of number of users registered for each authentication method. For more information about license requirements for this feature, see [Authentication Methods Activity: Permissions and licenses](/entra/identity/authentication/howto-authentication-methods-activity#permissions-and-licenses).

## Methods

Expand Down

0 comments on commit 5a96642

Please sign in to comment.