Programming Guides › Programming Guide for Perl › CLI Policy Management Methods › Affiliate Object Methods › Audience Method—Sets or Retrieves a URI

Audience Method—Sets or Retrieves a URI

The Audience method sets or retrieves the URI of the document that describes the agreement between the assertion producer site and the affiliate.

This value is included in the SAML assertion passed to the affiliate and can be used for validation purposes. Also, the affiliate can parse the audience document to obtain relevant information. The audience value must match the Assertion Audience setting in the AffiliateConfig.xml configuration file for the SAML Affiliate Agent.

Syntax

The Audience method has the following format:

Netegrity::PolicyMgtAffiliate‑>Audience( [audience] )

Parameters

The Audience method accepts the following parameter:

audience (string)

(Optional) Specifies the audience URI to set.

Return Value

The Audience method returns one of the following values:

• A new or existing audience URI
• undef it the call was unsuccessful