Share via


IdentityProviderKey

Updated: June 19, 2015

Applies To: Azure

This topic provides descriptions and legal values for the properties of the IdentityProviderKey entity of the Microsoft Azure Active Directory Access Control (also known as Access Control Service or ACS) Management Service.

IdentityProviderKey Properties

Property name Type Is nullable Description

Id

Int64

False

Specifies the unique identifier of the key that is associated with the identity provider used by ACS. This value is automatically set by ACS.

IdentityProviderId

Int64

False

Specifies the unique identifier of the identity provider used by ACS.

DisplayName

String

True

Specifies the display name of the identity provider key.

Usage

String

True

This property can be set to only a few legal values. For more information, see Usage Property Legal Values.

Type

String

True

This property can be set to only a few legal values. For more information, see Type Property Legal Values.

Value

Binary

True

Specifies the value of the identity provider key.

Password

Binary

True

If the key is an X.509 certificate with a private key, then this field contains the password that is used to decrypt the private key.

SystemReserved

Boolean

False

Specifies whether the IdentityProviderKey entity is reserved by ACS. Reserved entities cannot be deleted or edited.

StartDate

DateTime

False

Specifies the start date of the identity provider key.

EndDate

DateTime

False

Specifies the end date of the identity provider key.

Version

Binary

True

This property contains a time stamp that is automatically set by ACS.

The following table provides all of the legal values for the Usage property of the IdentityProviderKey entity of the ACS Management Service.

Note

All property values are case-sensitive.

Value Description

Signing

Specifies that the identity provider key is used to validate the signature of tokens received from the identity provider.

ApplicationId

Specifies that the identity provider key is a Facebook application ID. This is used for Facebook only.

ApplicationSecret

Specifies that the identity provider key is a Facebook application secret. This is used for Facebook only.

The following table provides all of the legal values for the Type property of the IdentityProviderKey entity of the ACS Management Service.

Note

All property values are case-sensitive.

Value Description

X509Certificate

Specifies that the service key is an X.509 certificate.

ApplicationKey

Specifies that the service key is a Facebook application ID or secret. Used for Facebook only.

Symmetric

Specifies that the service key is a 256-bit base 64-encoded symmetric key.

See Also

Concepts

ACS Management Service API Reference