identity_providers.properties

This section describes the architecture of the identity_providers.properties file.

entraID.clientID=
Modifiable Field entraID.clientID
Field Description The Client ID used to establish a connection to Microsoft Entra ID.
Possible Values
Value Definition String 
entraID.tenantID=
Modifiable Field entraID.tenantID
Field Description The Tenant ID used to establish a connection to Microsoft Entra ID.
Possible Values
Value Definition String 
entraID.secret=
Modifiable Field entraID.secret
Field Description The secret used to establish a connection to Microsoft Entra ID. The secret can be entered here in plain text or it can be encrypted.
Possible Values User defined
Value Definition User defined 
entraID.secretEncrypted=
Modifiable Field entraID.secretEncrypted
Field Description Instructs Remote Control to read the value of the secret parameter as encrypted (true) or plain text (false).
Possible Values True or False
Value Definition 
entraID.authorityHost=
Modifiable Field entraID.authorityHost
Field Description Specifies the Azure Authority Host to use. The value of the property is one of the following strings:
Possible Values https://login.microsoftonline.com/, https://login.microsoftonline.us/
Value Definition 
entraID.baseUrl=
Modifiable Field entraID.baseUrl
Field Description Base URL for Microsoft Entra ID.
Possible Values The default value is https://graph.microsoft.com/v1.0
Value Definition 
entraID.defaultScope=
Modifiable Field entraID.defaultScope
Field Description Default scope for Microsoft Entra ID.
Possible Values The default value is https://graph.microsoft.com/default
Value Definition 
entraID.groupFilter=
Modifiable Field entraID.groupFilter
Field Description The Microsoft Entra filter that is used for the group search. For more information, refer to https://learn.microsoft.com/en-us/graph/filter-query-parameter.
Possible Values Default value is startswith(displayName,'TRC').
Value Definition 
entraID.userFilter=
Modifiable Field entraID.userFilter
Field Description The Microsoft Entra ID filter expression used for users searches, for example, startswith(displayName,'Bob'). For more information, refer to https://learn.microsoft.com/en-us/graph/filter-query-parameter.
Possible Values User Defined
Value Definition 
entraID.userInGroup=
Modifiable Field entraID.userInGroup
Field Description Determines whether a user who matches the user search criteria also has to be a member of the groups found in the group search.
Possible Values True or False
Value Definition
True
Only users who match the user search criteria and are members of the groups found in the group search are imported.
False
All users who match the user search criteria regardless of their group membership are imported.
Note:
Users are imported into the DefaultGroup as well as any other groups that they belong to.
 
entraID.userEmail=
Modifiable Field entraID.userEmail
Field Description Microsoft Entra ID attribute containing the user's email address.
Possible Values User Defined for example: userPrincipalName
Value Definition 
entraID.userID=
Modifiable Field entraID.userID
Field Description Microsoft Entra ID attribute used for user ID.
Possible Values User defined for example: userPrincipalName.
Value Definition 
entraID.forename=
Modifiable Field entraID.forename
Field Description Microsoft Entra ID field for forename.
Possible Values User Defined
Value Definition User defined string 
entraID.surname=
Modifiable Field entraID.surname
Field Description Microsoft Entra ID field for surname.
Possible Values User defined
Value Definition User defined string 
entraID.employeeID=
Modifiable Field entraID.employeeID
Field Description Microsoft Entra ID field for employee ID.
Possible Values User defined
Value Definition User defined string 
entraID.title=
Modifiable Field entraID.title
Field Description Microsoft Entra ID field for title.
Possible Values User Defined
Value Definition User defined string 
entraID.company=
Modifiable Field entraID.company
Field Description Microsoft Entra ID field for company.
Possible Values User Defined
Value Definition User defined string 
entraID.department=
Modifiable Field entraID.department
Field Description Microsoft Entra ID field for department.
Possible Values User Defined
Value Definition User Defined string 
entraID.location=
Modifiable Field entraID.location
Field Description Microsoft Entra ID field for location.
Possible Values User Defined
Value Definition User Defined string 
entraID.address=
Modifiable Field entraID.address
Field Description Microsoft Entra ID field for address.
Possible Values User Defined
Value Definition User Defined string 
entraID.mobile=
Modifiable Field entraID.mobile
Field Description Microsoft Entra ID field for mobile.
Possible Values User Defined
Value Definition User defined string 
entraID.state=
Modifiable Field entraID.state
Field Description Microsoft Entra ID field for state.
Possible Values User Defined
Value Definition User defined string 
entraID.country=
Modifiable Field entraID.country
Field Description Microsoft Entra ID field for country.
Possible Values User Defined
Value Definition User defined string 
entraID.pageSize=
Modifiable Field entraID.pageSize
Field Description Set this value to the page size of Microsoft Entra search retrievals.
Possible Values User defined integer that must be between 1 and 999 inclusive. The default value is 500.
Value Definition User Defined