Share via


RelyingPartyKey

Updated: June 19, 2015

Applies To: Azure

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

RelyingPartyKey Properties

Property name Type Is nullable Description

Id

Int64

False

Specifies the unique identifier of the relying party application key. This value is automatically set by ACS.

RelyingPartyId

Int64

False

Specifies the unique identifier of the relying party application for which ACS generates a security token.

DisplayName

String

True

Specifies the display name of the relying party application 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 relying party application 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.

IsPrimary

Boolean

False

Specifies whether the relying party application key is primary.

SystemReserved

Boolean

False

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

StartDate

DateTime

False

Specifies the start date of the relying party application key.

EndDate

DateTime

False

Specifies the end date of the relying party application 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 RelyingPartyKey entity of the ACS Management Service.

Note

All property values are case-sensitive.

Value Description

Signing

Specifies that the relying party key is used for token signing.

Encrypting

Specifies that the relying party key is used to encrypt tokens issued to the relying party application.

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

Note

All property values are case-sensitive.

Value Description

X509Certificate

Specifies that the relying party key is an X.509 certificate, which is used to sign or encrypt SAML tokens. Note that a private key is required to sign tokens, but only a public key is required to encrypt tokens.

Symmetric

Specifies that the relying party key is a 256-bit base 64-encoded symmetric key, which is only used to sign SWT tokens.

See Also

Concepts

ACS Management Service API Reference