msdyn_authenticationsettings table/entity reference

Omnichannel for Customer Service offers a suite of capabilities that extend the power of Dynamics 365 Customer Service Enterprise to enable organizations to instantly connect and engage with their customers across digital messaging channels. An additional license is required to access Omnichannel for Customer Service. For more information, see the Dynamics 365 Customer Service pricing overview and Dynamics 365 Customer Service pricing plan pages.

Stores the settings for user authentication

Added by: Omnichannel – Base Solution

Messages

Message	Web API Operation	SDK Assembly
Assign	PATCH [org URI]/api/data/v9.0/msdyn_authenticationsettingses(msdyn_authenticationsettingsid) Update ownerid property.	AssignRequest
Create	POST [org URI]/api/data/v9.0/msdyn_authenticationsettingses See Create	CreateRequest or Create
CreateMultiple		CreateMultipleRequest
Delete	DELETE [org URI]/api/data/v9.0/msdyn_authenticationsettingses(msdyn_authenticationsettingsid) See Delete	DeleteRequest or Delete
GrantAccess	GrantAccess Action	GrantAccessRequest
IsValidStateTransition	IsValidStateTransition Function	IsValidStateTransitionRequest
ModifyAccess	ModifyAccess Action	ModifyAccessRequest
Retrieve	GET [org URI]/api/data/v9.0/msdyn_authenticationsettingses(msdyn_authenticationsettingsid) See Retrieve	RetrieveRequest or Retrieve
RetrieveMultiple	GET [org URI]/api/data/v9.0/msdyn_authenticationsettingses See Query Data	RetrieveMultipleRequest or RetrieveMultiple
RetrievePrincipalAccess	RetrievePrincipalAccess Function	RetrievePrincipalAccessRequest
RetrieveSharedPrincipalsAndAccess	RetrieveSharedPrincipalsAndAccess Function	RetrieveSharedPrincipalsAndAccessRequest
RevokeAccess	RevokeAccess Action	RevokeAccessRequest
SetState	PATCH [org URI]/api/data/v9.0/msdyn_authenticationsettingses(msdyn_authenticationsettingsid) Update statecode and statuscode properties.	SetStateRequest
Update	PATCH [org URI]/api/data/v9.0/msdyn_authenticationsettingses(msdyn_authenticationsettingsid) See Update	UpdateRequest or Update
UpdateMultiple		UpdateMultipleRequest

Properties

Property	Value
CollectionSchemaName	msdyn_authenticationsettingses
DisplayCollectionName	Authentication Settings
DisplayName	Authentication Settings
EntitySetName	msdyn_authenticationsettingses
IsBPFEntity	False
LogicalCollectionName	msdyn_authenticationsettingses
LogicalName	msdyn_authenticationsettings
OwnershipType	UserOwned
PrimaryIdAttribute	msdyn_authenticationsettingsid
PrimaryNameAttribute	msdyn_name
SchemaName	msdyn_authenticationsettings

Writable columns/attributes

These columns/attributes return true for either IsValidForCreate or IsValidForUpdate (usually both). Listed by SchemaName.

• ImportSequenceNumber
• msdyn_authenticationclientid
• msdyn_authenticationclientsecret
• msdyn_authenticationscopes
• msdyn_authenticationsettingsId
• msdyn_Authenticationtype
• msdyn_authserviceconfigsetid
• msdyn_authservicescopeid
• msdyn_decryptedtokenurl
• msdyn_endpointregion
• msdyn_JavaScriptclientfunction
• msdyn_name
• msdyn_ocauthchanneltype
• msdyn_PublickeyURL
• OverriddenCreatedOn
• OwnerId
• OwnerIdType
• statecode
• statuscode
• TimeZoneRuleVersionNumber
• UTCConversionTimeZoneCode

ImportSequenceNumber

Property	Value
Description	Sequence number of the import that created this record.
DisplayName	Import Sequence Number
Format	None
IsValidForForm	False
IsValidForRead	True
IsValidForUpdate	False
LogicalName	importsequencenumber
MaxValue	2147483647
MinValue	-2147483648
RequiredLevel	None
Type	Integer

msdyn_authenticationclientid

Property	Value
Description	Auth service Client Id
DisplayName	Auth service Client ID
FormatName	Text
IsLocalizable	False
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_authenticationclientid
MaxLength	100
RequiredLevel	ApplicationRequired
Type	String

msdyn_authenticationclientsecret

Property	Value
Description	Auth service client secret
DisplayName	Auth service client secret
FormatName	Text
IsLocalizable	False
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_authenticationclientsecret
MaxLength	100
RequiredLevel	ApplicationRequired
Type	String

msdyn_authenticationscopes

Property	Value
Description	Auth service scopes
DisplayName	Auth service scopes
FormatName	Text
IsLocalizable	False
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_authenticationscopes
MaxLength	100
RequiredLevel	ApplicationRequired
Type	String

msdyn_authenticationsettingsId

Property	Value
Description	Unique identifier for entity instances
DisplayName	Authentication Settings
IsValidForForm	False
IsValidForRead	True
IsValidForUpdate	False
LogicalName	msdyn_authenticationsettingsid
RequiredLevel	SystemRequired
Type	Uniqueidentifier

msdyn_Authenticationtype

Property	Value
Description	Authentication Type which will be applied to the chat
DisplayName	Authentication Type
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_authenticationtype
RequiredLevel	ApplicationRequired
Type	Picklist

msdyn_Authenticationtype Choices/Options

Value	Label
192350000	OAuth 2.0 implicit flow
192350001	OAuth 2.0 code flow
192350002	Gatekeeper Biometric Authentication

Note

Microsoft recommends that you use the most secure authentication flow available. You should only use implicit flows when other more secure flows, such as managed identities, aren't viable.

msdyn_authserviceconfigsetid

Added by: Omnichannel - Telephony Solution

Property	Value
Description	Config Set ID for Gatekeeper authentication service
DisplayName	Config Set ID for Gatekeeper authentication service
FormatName	Text
IsLocalizable	False
IsValidForForm	True
IsValidForRead	True
IsValidForUpdate	False
LogicalName	msdyn_authserviceconfigsetid
MaxLength	100
RequiredLevel	None
Type	String

msdyn_authservicescopeid

Added by: Omnichannel - Telephony Solution

Property	Value
Description	Scope ID for Gatekeeper authentication service
DisplayName	Scope ID for Gatekeeper authentication service
FormatName	Text
IsLocalizable	False
IsValidForForm	True
IsValidForRead	True
IsValidForUpdate	False
LogicalName	msdyn_authservicescopeid
MaxLength	100
RequiredLevel	None
Type	String

msdyn_decryptedtokenurl

Property	Value
Description	Decrypted token url to hit with Access token
DisplayName	Decrypted Token URL
FormatName	Text
IsLocalizable	False
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_decryptedtokenurl
MaxLength	100
RequiredLevel	ApplicationRequired
Type	String

msdyn_endpointregion

Property	Value
Description	Endpoint region for authentication setting
DisplayName	Endpoint region
IsValidForForm	True
IsValidForRead	True
IsValidForUpdate	False
LogicalName	msdyn_endpointregion
RequiredLevel	ApplicationRequired
Type	Picklist

msdyn_endpointregion Choices/Options

Value	Label
192440001	United States
192440002	Canada
192440003	United Kingdom

msdyn_JavaScriptclientfunction

Property	Value
Description	Javascript function which will need to return the authentication token
DisplayName	JavaScript client function
FormatName	Text
IsLocalizable	False
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_javascriptclientfunction
MaxLength	100
RequiredLevel	ApplicationRequired
Type	String

msdyn_name

Property	Value
Description	The name of the custom entity.
DisplayName	Name
FormatName	Text
IsLocalizable	False
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_name
MaxLength	100
RequiredLevel	ApplicationRequired
Type	String

msdyn_ocauthchanneltype

Property	Value
Description
DisplayName	Channel Type
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_ocauthchanneltype
RequiredLevel	None
Type	Picklist

msdyn_ocauthchanneltype Choices/Options

Value	Label
192360000	Live chat
192440000	Voice
192450000	Apple Messages For Business

msdyn_PublickeyURL

Property	Value
Description	URL to the Public Key which will be used for token validation
DisplayName	Public key URL
FormatName	Text
IsLocalizable	False
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_publickeyurl
MaxLength	256
RequiredLevel	ApplicationRequired
Type	String

OverriddenCreatedOn

Property	Value
DateTimeBehavior	UserLocal
Description	Date and time that the record was migrated.
DisplayName	Record Created On
Format	DateOnly
IsValidForForm	False
IsValidForRead	True
IsValidForUpdate	False
LogicalName	overriddencreatedon
RequiredLevel	None
Type	DateTime

OwnerId

Added by: Active Solution Solution

Property	Value
Description	Owner Id
DisplayName	Owner
IsValidForForm	True
IsValidForRead	True
LogicalName	ownerid
RequiredLevel	SystemRequired
Targets	systemuser,team
Type	Owner

OwnerIdType

Added by: Active Solution Solution

Property	Value
Description	Owner Id Type
DisplayName
IsValidForForm	False
IsValidForRead	True
LogicalName	owneridtype
RequiredLevel	SystemRequired
Type	EntityName

statecode

Property	Value
Description	Status of the Authentication settings
DisplayName	Status
IsValidForCreate	False
IsValidForForm	True
IsValidForRead	True
LogicalName	statecode
RequiredLevel	SystemRequired
Type	State

statecode Choices/Options

Value	Label	DefaultStatus	InvariantName
0	Active	1	Active
1	Inactive	2	Inactive

statuscode

Property	Value
Description	Reason for the status of the Authentication settings
DisplayName	Status Reason
IsValidForForm	True
IsValidForRead	True
LogicalName	statuscode
RequiredLevel	None
Type	Status

statuscode Choices/Options

Value	Label	State
1	Active	0
2	Inactive	1

TimeZoneRuleVersionNumber

Property	Value
Description	For internal use only.
DisplayName	Time Zone Rule Version Number
Format	None
IsValidForForm	False
IsValidForRead	True
LogicalName	timezoneruleversionnumber
MaxValue	2147483647
MinValue	-1
RequiredLevel	None
Type	Integer

UTCConversionTimeZoneCode

Property	Value
Description	Time zone code that was in use when the record was created.
DisplayName	UTC Conversion Time Zone Code
Format	None
IsValidForForm	False
IsValidForRead	True
LogicalName	utcconversiontimezonecode
MaxValue	2147483647
MinValue	-1
RequiredLevel	None
Type	Integer

Read-only columns/attributes

These columns/attributes return false for both IsValidForCreate or IsValidForUpdate. Listed by SchemaName.

• CreatedBy
• CreatedByName
• CreatedByYomiName
• CreatedOn
• CreatedOnBehalfBy
• CreatedOnBehalfByName
• CreatedOnBehalfByYomiName
• ModifiedBy
• ModifiedByName
• ModifiedByYomiName
• ModifiedOn
• ModifiedOnBehalfBy
• ModifiedOnBehalfByName
• ModifiedOnBehalfByYomiName
• OwnerIdName
• OwnerIdYomiName
• OwningBusinessUnit
• OwningBusinessUnitName
• OwningTeam
• OwningUser
• VersionNumber

CreatedBy

Added by: Active Solution Solution

Property	Value
Description	Unique identifier of the user who created the record.
DisplayName	Created By
IsValidForForm	True
IsValidForRead	True
LogicalName	createdby
RequiredLevel	None
Targets	systemuser
Type	Lookup

CreatedByName

Added by: Active Solution Solution

Property	Value
Description
DisplayName
FormatName	Text
IsLocalizable	False
IsValidForForm	False
IsValidForRead	True
LogicalName	createdbyname
MaxLength	100
RequiredLevel	None
Type	String

CreatedByYomiName

Added by: Active Solution Solution

Property	Value
Description
DisplayName
FormatName	Text
IsLocalizable	False
IsValidForForm	False
IsValidForRead	True
LogicalName	createdbyyominame
MaxLength	100
RequiredLevel	SystemRequired
Type	String

CreatedOn

Property	Value
DateTimeBehavior	UserLocal
Description	Date and time when the record was created.
DisplayName	Created On
Format	DateAndTime
IsValidForForm	True
IsValidForRead	True
LogicalName	createdon
RequiredLevel	None
Type	DateTime

CreatedOnBehalfBy

Added by: Active Solution Solution

Property	Value
Description	Unique identifier of the delegate user who created the record.
DisplayName	Created By (Delegate)
IsValidForForm	True
IsValidForRead	True
LogicalName	createdonbehalfby
RequiredLevel	None
Targets	systemuser
Type	Lookup

CreatedOnBehalfByName

Added by: Active Solution Solution

Property	Value
Description
DisplayName
FormatName	Text
IsLocalizable	False
IsValidForForm	False
IsValidForRead	True
LogicalName	createdonbehalfbyname
MaxLength	100
RequiredLevel	None
Type	String

CreatedOnBehalfByYomiName

Added by: Active Solution Solution

Property	Value
Description
DisplayName
FormatName	Text
IsLocalizable	False
IsValidForForm	False
IsValidForRead	True
LogicalName	createdonbehalfbyyominame
MaxLength	100
RequiredLevel	SystemRequired
Type	String

ModifiedBy

Added by: Active Solution Solution

Property	Value
Description	Unique identifier of the user who modified the record.
DisplayName	Modified By
IsValidForForm	True
IsValidForRead	True
LogicalName	modifiedby
RequiredLevel	None
Targets	systemuser
Type	Lookup

ModifiedByName

Added by: Active Solution Solution

Property	Value
Description
DisplayName
FormatName	Text
IsLocalizable	False
IsValidForForm	False
IsValidForRead	True
LogicalName	modifiedbyname
MaxLength	100
RequiredLevel	None
Type	String

ModifiedByYomiName

Added by: Active Solution Solution

Property	Value
Description
DisplayName
FormatName	Text
IsLocalizable	False
IsValidForForm	False
IsValidForRead	True
LogicalName	modifiedbyyominame
MaxLength	100
RequiredLevel	SystemRequired
Type	String

ModifiedOn

Property	Value
DateTimeBehavior	UserLocal
Description	Date and time when the record was modified.
DisplayName	Modified On
Format	DateAndTime
IsValidForForm	True
IsValidForRead	True
LogicalName	modifiedon
RequiredLevel	None
Type	DateTime

ModifiedOnBehalfBy

Added by: Active Solution Solution

Property	Value
Description	Unique identifier of the delegate user who modified the record.
DisplayName	Modified By (Delegate)
IsValidForForm	True
IsValidForRead	True
LogicalName	modifiedonbehalfby
RequiredLevel	None
Targets	systemuser
Type	Lookup

ModifiedOnBehalfByName

Added by: Active Solution Solution

Property	Value
Description
DisplayName
FormatName	Text
IsLocalizable	False
IsValidForForm	False
IsValidForRead	True
LogicalName	modifiedonbehalfbyname
MaxLength	100
RequiredLevel	None
Type	String

ModifiedOnBehalfByYomiName

Added by: Active Solution Solution

Property	Value
Description
DisplayName
FormatName	Text
IsLocalizable	False
IsValidForForm	False
IsValidForRead	True
LogicalName	modifiedonbehalfbyyominame
MaxLength	100
RequiredLevel	SystemRequired
Type	String

OwnerIdName

Added by: Active Solution Solution

Property	Value
Description	Name of the owner
DisplayName
FormatName	Text
IsLocalizable	False
IsValidForForm	False
IsValidForRead	True
LogicalName	owneridname
MaxLength	100
RequiredLevel	SystemRequired
Type	String

OwnerIdYomiName

Added by: Active Solution Solution

Property	Value
Description	Yomi name of the owner
DisplayName
FormatName	Text
IsLocalizable	False
IsValidForForm	False
IsValidForRead	True
LogicalName	owneridyominame
MaxLength	100
RequiredLevel	SystemRequired
Type	String

OwningBusinessUnit

Added by: Active Solution Solution

Property	Value
Description	Unique identifier for the business unit that owns the record
DisplayName	Owning Business Unit
IsValidForForm	True
IsValidForRead	True
LogicalName	owningbusinessunit
RequiredLevel	None
Targets	businessunit
Type	Lookup

OwningBusinessUnitName

Added by: Active Solution Solution

Property	Value
Description
DisplayName
FormatName	Text
IsLocalizable	False
IsValidForForm	False
IsValidForRead	True
LogicalName	owningbusinessunitname
MaxLength	100
RequiredLevel	SystemRequired
Type	String

OwningTeam

Added by: Active Solution Solution

Property	Value
Description	Unique identifier for the team that owns the record.
DisplayName	Owning Team
IsValidForForm	False
IsValidForRead	True
LogicalName	owningteam
RequiredLevel	None
Targets	team
Type	Lookup

OwningUser

Added by: Active Solution Solution

Property	Value
Description	Unique identifier for the user that owns the record.
DisplayName	Owning User
IsValidForForm	False
IsValidForRead	True
LogicalName	owninguser
RequiredLevel	None
Targets	systemuser
Type	Lookup

VersionNumber

Added by: Active Solution Solution

Property	Value
Description	Version Number
DisplayName	Version Number
IsValidForForm	False
IsValidForRead	True
LogicalName	versionnumber
MaxValue	9223372036854775807
MinValue	-9223372036854775808
RequiredLevel	None
Type	BigInt

Related information

Introduction to Omnichannel for Customer Service
Developer guide for Omnichannel for Customer Service