Edit

Share via


customUsernameSignInIdentifier resource type

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.

Represents a custom username sign-in identifier that enables users to authenticate using custom patterns such as account numbers, member IDs, or employee identifiers. This resource allows tenant administrators to define validation patterns using regular expressions to ensure custom usernames follow specific formats required by their organization.

Inherits from signInIdentifierBase.

Methods

None.

For the list of API operations for managing this resource type, see the signInIdentifierBase resource type.

Properties

Property Type Description
isEnabled Boolean Indicates whether this custom username sign-in identifier type is enabled for user authentication in the tenant. Inherited from signInIdentifierBase.
name String The unique name identifier for this custom username sign-in identifier configuration. Possible values include: CustomUsername1, CustomUsername2. Inherited from signInIdentifierBase.
validationRegex String The regular expression pattern used to validate custom usernames. The pattern must be a valid regex, can't exceed 60 characters in length, and can't be an email-supported regex pattern.

Relationships

None.

JSON representation

The following JSON representation shows the resource type.

{
  "@odata.type": "#microsoft.graph.customUsernameSignInIdentifier",
  "name": "String (identifier)",
  "isEnabled": "Boolean",
  "validationRegex": "String"
}