Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
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.
Details self-service sign-up activity of Microsoft Entra External ID users on a tenant.
Methods
| Method | Return type | Description |
|---|---|---|
| List | selfServiceSignUp collection | Get a list of the selfServiceSignUp objects and their properties. |
| Get | selfServiceSignUp | Read the properties and relationships of a selfServiceSignUp object. |
Properties
| Property | Type | Description |
|---|---|---|
| appDisplayName | String | App name displayed in the Microsoft Entra admin center. Supports $filter (eq, startsWith). |
| appId | String | Unique GUID that represents the app ID in the Microsoft Entra ID. Supports $filter (eq). |
| appliedEventListeners | appliedAuthenticationEventListener collection | Detailed information about the listeners, such as Azure Logic Apps and Azure Functions, which the corresponding events in the sign-up event triggered. |
| correlationId | String | The request ID sent from the client when the sign-up is initiated. Used to troubleshoot sign-up activity. Supports $filter (eq). |
| createdDateTime | DateTimeOffset | Date and time (UTC) the sign-up was initiated. Example: midnight on Jan 1, 2014 is reported as 2014-01-01T00:00:00Z. Supports $orderby, $filter (eq, le, and ge). |
| id | String | Unique ID representing the sign-up activity. Supports $filter (eq). Inherited from entity. |
| signUpIdentity | signUpIdentity | Unique identifier for self-service sign-up user. Supports $filter (eq) on the signUpIdentifierType. |
| signUpIdentityProvider | String | Describes the type of account for which the user registered. Values include Email OTP, Email Password, Google. |
| signUpStage | signUpStage | Describes the step in the sign-up flow. The possible values are: credentialCollection, credentialValidation, credentialFederation, consent, attributeCollectionAndValidation, userCreation, tenantConsent, unknownFutureValue. |
| status | signUpStatus | Sign-up status. Includes the error code and description of the error (if a sign-up failure or interrupt occurs). Supports $filter (eq) on errorCode property. |
| userId | String | The identifier of the user object created during the sign-up. |
Relationships
None.
JSON representation
The following JSON representation shows the resource type.
{
"@odata.type": "#microsoft.graph.selfServiceSignUp",
"id": "String (identifier)",
"appDisplayName": "String",
"appId": "String",
"appliedEventListeners": [
{
"@odata.type": "microsoft.graph.appliedAuthenticationEventListener"
}
],
"correlationId": "String",
"createdDateTime": "String (timestamp)",
"signUpStage": "String",
"status": {
"@odata.type": "microsoft.graph.signUpStatus"
},
"signUpIdentity": {
"@odata.type": "microsoft.graph.signUpIdentity"
},
"signUpIdentityProvider": "String",
"userId": "String"
}