CLI SAML 2.0 Affiliation Methods
Contents
sm1252sp1
Contents
GetAffiliatedSAMLAuthSchemes Method Retrieves the SAML 2.0 Authentication Schemes Associated with This SAML Affiliation
The GetAffiliatedSAMLAuthSchemes method retrieves all the SAML 2.0 authentication schemes associated with this SAML affiliation.
Syntax
The GetAffiliatedSAMLAuthSchemes method has the following format:
Netegrity::PolicyMgtSAMLAffiliation->GetAffiliatedSAMLAuthSchemes()
Parameters
The GetAffiliatedSAMLAuthSchemes method accepts no parameters.
Return Value
The GetAffiliatedSAMLAuthSchemes method returns one of the following values:
- An array of PolicyMgtAuthScheme objects based on the SAML 2.0 Template
- undefif the call is unsuccessful
GetAffiliatedSAMLServiceProviders Method Retrieves the SAML 2.0 Service Providers Associated with this SAML Affiliation
The GetAffiliatedSAMLServiceProviders method Retrieves all the SAML 2.0 Service Providers associated with this SAML affiliation.
Syntax
The GetAffiliatedSAMLServiceProviders method has the following format:
Netegrity::PolicyMgtSAMLAffiliation->GetAffiliatedSAMLServiceProviders()
Parameters
The GetAffiliatedSAMLServiceProviders method accepts no parameters.
Return Value
The GetAffiliatedSAMLServiceProviders method returns one of the following values:
- An array of PolicyMgtSAMLServiceProvider objects
- undefif the call is unsuccessful
Property Method Sets or Retrieves the Specified SAML 2.0 Metadata Property
The Property method sets or retrieves the specified SAML 2.0 metadata property for this SAML 2.0 affiliation.
Syntax
The Property method has the following format:
Netegrity::PolicyMgtSAMLAffiliation->Property(name [, value])
Parameters
The Property method accepts the following parameters:
- name(string)Specifies the property to set or retrieve.
- value(string)(Optional) Specifies the value of the property being set.
Return Value
The Property method returns one of the following values:
- The new or existing property value
- undefif the call is unsuccessful
Remarks
For a list of affiliation metadata properties, see the description of the PolicyMgtSession>CreateSAMLAffiliation method.
Note: After modifying one or more existing affiliation properties with this method, call PolicyMgtSAMLAffiliation>Save to write the changes to the policy store.
Save Method Saves the Changes to the SAML 2.0 Metadata Properties of this SAML 2.0 Affiliation
The Save method saves the changes you made to the SAML 2.0 metadata properties of this SAML 2.0 affiliation.
Syntax
The Save method has the following format:
Netegrity::PolicyMgtSAMLAffiliation->Save()
Parameters
The Save method accepts no parameters.
Return Value
The Save method returns one of the following values:
- 0 on success
- -1 if the call is unsuccessful
- -4 if the user has insufficient privileges to save the changes
- -10 if the path and class are empty
Remarks
To modify an affiliation property, call the PolicyMgtSAMLAffiliation->Property method.