List signUps

2025-06-27

Namespace: microsoft.graph

Important

APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.

Retrieve the Microsoft Entra External ID user selfServiceSignUps events for your tenant.

The maximum and default page size is 1,000 objects and by default, the most recent sign-ups are returned first. Only sign-up events that occurred within the Microsoft Entra ID default retention period are available.

This API is available in the following national cloud deployments.

Global service	US Government L4	US Government L5 (DOD)	China operated by 21Vianet
✅	❌	❌	❌

Permissions

Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.

Permission type	Least privileged permissions	Higher privileged permissions
Delegated (work or school account)	AuditLog.Read.All	Not available.
Delegated (personal Microsoft account)	Not supported.	Not supported.
Application	AuditLog.Read.All	Not available.

Important

In delegated scenarios with work or school accounts, the signed-in user must be assigned a supported Microsoft Entra role or a custom role with a supported role permission. The following least privileged roles are supported for this operation:

Global Reader
Reports Reader
Security Administrator
Security Operator
Security Reader

HTTP request

GET /auditLogs/signUps

Optional query parameters

This method supports the $top, $skiptoken, and $filter OData query parameters to help customize the response. For general information, see OData query parameters.

To avoid having the request time out, apply the $filter parameter with a time range for which to get all sign-ins, as shown in Example 1.

Request headers

Name	Description
Authorization	Bearer {token}. Required. Learn more about authentication and authorization.

Request body

Don't supply a request body for this method.

Response

If successful, this method returns a 200 OK response code and a collection of selfServiceSignUp objects in the response body. The collection of objects is listed in descending order based on createdDateTime.

Examples

Request

This example lists all sign-up events during a specific time period. Four signup events related to one sign-up attempt are returned. The response object shows the user signed up using Email OTP, and includes an interrupt involving verification of user's identity (by entering the OTP sent to the user's email).

GET https://graph.microsoft.com/beta/auditLogs/signUps?$filter=createdDateTime ge 2024-07-01T00:00:00Z and createdDateTime le 2024-07-14T23:59:59Z


// Code snippets are only available for the latest version. Current version is 5.x

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.AuditLogs.SignUps.GetAsync((requestConfiguration) =>
{
	requestConfiguration.QueryParameters.Filter = "createdDateTime ge 2024-07-01T00:00:00Z and createdDateTime le 2024-07-14T23:59:59Z";
});

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.



// Code snippets are only available for the latest major version. Current major version is $v0.*

// Dependencies
import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go"
	  graphauditlogs "github.com/microsoftgraph/msgraph-beta-sdk-go/auditlogs"
	  //other-imports
)


requestFilter := "createdDateTime ge 2024-07-01T00:00:00Z and createdDateTime le 2024-07-14T23:59:59Z"

requestParameters := &graphauditlogs.AuditLogsSignUpsRequestBuilderGetQueryParameters{
	Filter: &requestFilter,
}
configuration := &graphauditlogs.AuditLogsSignUpsRequestBuilderGetRequestConfiguration{
	QueryParameters: requestParameters,
}

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
signUps, err := graphClient.AuditLogs().SignUps().Get(context.Background(), configuration)

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

SelfServiceSignUpCollectionResponse result = graphClient.auditLogs().signUps().get(requestConfiguration -> {
	requestConfiguration.queryParameters.filter = "createdDateTime ge 2024-07-01T00:00:00Z and createdDateTime le 2024-07-14T23:59:59Z";
});

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


const options = {
	authProvider,
};

const client = Client.init(options);

let signUps = await client.api('/auditLogs/signUps')
	.version('beta')
	.filter('createdDateTime ge 2024-07-01T00:00:00Z and createdDateTime le 2024-07-14T23:59:59Z')
	.get();

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


<?php
use Microsoft\Graph\Beta\GraphServiceClient;
use Microsoft\Graph\Beta\Generated\AuditLogs\SignUps\SignUpsRequestBuilderGetRequestConfiguration;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);

$requestConfiguration = new SignUpsRequestBuilderGetRequestConfiguration();
$queryParameters = SignUpsRequestBuilderGetRequestConfiguration::createQueryParameters();
$queryParameters->filter = "createdDateTime ge 2024-07-01T00:00:00Z and createdDateTime le 2024-07-14T23:59:59Z";
$requestConfiguration->queryParameters = $queryParameters;


$result = $graphServiceClient->auditLogs()->signUps()->get($requestConfiguration)->wait();

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


Import-Module Microsoft.Graph.Beta.Reports

Get-MgBetaAuditLogSignUp -Filter "createdDateTime ge 2024-07-01T00:00:00Z and createdDateTime le 2024-07-14T23:59:59Z"

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


# Code snippets are only available for the latest version. Current version is 1.x
from msgraph_beta import GraphServiceClient
from msgraph_beta.generated.audit_logs.sign_ups.sign_ups_request_builder import SignUpsRequestBuilder
from kiota_abstractions.base_request_configuration import RequestConfiguration
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
query_params = SignUpsRequestBuilder.SignUpsRequestBuilderGetQueryParameters(
		filter = "createdDateTime ge 2024-07-01T00:00:00Z and createdDateTime le 2024-07-14T23:59:59Z",
)

request_configuration = RequestConfiguration(
query_parameters = query_params,
)

result = await graph_client.audit_logs.sign_ups.get(request_configuration = request_configuration)

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Response

The following example shows the response.

Note: The response object shown here might be shortened for readability.

HTTP/1.1 200 OK
Content-Type: application/json

{
    "@odata.context": "https://graph.microsoft.com/beta/$metadata#auditLogs/signUps",
    "@microsoft.graph.tips": "Use $select to choose only the properties your app needs, as this can lead to performance improvements. For example: GET auditLogs/signUps?$select=appDisplayName,appId",
    "value": [
        {
            "appDisplayName": "TestApp4",
            "appId": "94559aba-b733-468e-aaec-44cc4e7f0b58",
            "correlationId": "f4414243-b0ee-4030-9c0c-d661c716a6b8",
            "createdDateTime": "2024-10-15T01:58:09.287604Z",
            "id": "921e63bd-a516-4976-a537-a6710d6a0000",
            "signUpStage": "userCreation",
            "signUpIdentityProvider": "Email OTP",
            "appliedEventListeners": [],
            "status": {
                "errorCode": 0,
                "failureReason": null,
                "additionalDetails": null
            },
            "signUpIdentity": {
                "signUpIdentifier": "testuser@fabrikam.com",
                "signUpIdentifierType": "emailAddress"
            },
            "userId": "9fb7a577-9469-4489-912d-bc58a5bca276"
        },
        {
            "appDisplayName": "TestApp4",
            "appId": "94559aba-b733-468e-aaec-44cc4e7f0b58",
            "correlationId": "f4414243-b0ee-4030-9c0c-d661c716a6b8",
            "createdDateTime": "2024-10-15T01:58:08.383114Z",
            "id": "5b515b07-411f-4759-a389-bce8289f0000",
            "signUpStage": "attributeCollectionAndValidation",
            "signUpIdentityProvider": "Email OTP",
            "userId": null,
            "appliedEventListeners": [],
            "status": {
                "errorCode": 0,
                "failureReason": null,
                "additionalDetails": null
            },
            "signUpIdentity": {
                "signUpIdentifier": "testuser@fabrikam.com",
                "signUpIdentifierType": "emailAddress"
            }
        },
        {
            "appDisplayName": "TestApp4",
            "appId": "94559aba-b733-468e-aaec-44cc4e7f0b58",
            "correlationId": "f4414243-b0ee-4030-9c0c-d661c716a6b8",
            "createdDateTime": "2024-10-15T01:57:49.368731Z",
            "id": "1ce058e4-d023-4ae4-9236-0c9d0f0f0200",
            "signUpStage": "credentialValidation",
            "signUpIdentityProvider": "Email OTP",
            "userId": null,
            "appliedEventListeners": [],
            "status": {
                "errorCode": 1002013,
                "failureReason": null,
                "additionalDetails": null
            },
            "signUpIdentity": {
                "signUpIdentifier": "testuser@fabrikam.com",
                "signUpIdentifierType": "emailAddress"
            }
        },
        {
            "appDisplayName": null,
            "appId": "94559aba-b733-468e-aaec-44cc4e7f0b58",
            "correlationId": "f4414243-b0ee-4030-9c0c-d661c716a6b8",
            "createdDateTime": "2024-10-15T01:57:36.362145Z",
            "id": "921e63bd-a516-4976-a537-a671036a0000",
            "signUpStage": "credentialCollection",
            "signUpIdentityProvider": "Email OTP",
            "userId": null,
            "appliedEventListeners": [],
            "status": {
                "errorCode": 0,
                "failureReason": null,
                "additionalDetails": null
            },
            "signUpIdentity": {
                "signUpIdentifier": "testuser@fabrikam.com",
                "signUpIdentifierType": "emailAddress"
            }
        }
    ]
}

Share via

List signUps

Permissions

HTTP request

Optional query parameters

Request headers

Request body

Response

Examples

Request

Response

Feedback

Additional resources