Data Governance Broker Documentation Index
Configuration Reference Home

SAML Artifact Resolution Endpoint

Note: this component stores cluster-wide configuration data and is mirrored across all servers in the topology within the the same cluster.

Note: changes to cluster-wide configuration objects are immediately and automatically mirrored across all servers within the same cluster, so offline changes are not supported.

SAML Artifact Resolution Endpoints are used to define the URL of a SAML Artifact Resolution Service for a specified endpoint index provided in a SAML Artifact.

Relations to This Component
Properties
dsconfig Usage

Relations to This Component

The following components have a direct composition relation to SAML Artifact Resolution Endpoints:

Properties

The properties supported by this managed object are as follows:


Basic Properties: Advanced Properties:
↓ endpoint-index  None
↓ url
↓ user-name
↓ password

Basic Properties

endpoint-index

Description
Specifies the endpoint index number.
Default Value
0
Allowed Values
An integer value. Lower limit is 0. Upper limit is 65535 .
Multi-Valued
No
Required
Yes
Admin Action Required
None. Modification requires no further action

url (Read-Only)

Description
Specifies the URL of the Artifact Resolution Service.
Default Value
None
Allowed Values
An absolute URL with one of the following schemes: { http, https }
Multi-Valued
No
Required
Yes
Admin Action Required
None. Modification requires no further action

user-name

Description
Specify the username that will be used to authenticate the HTTP connection to the SAML Artifact Resolution Service URL. Both username and password must be supplied if this property is set.
Default Value
None
Allowed Values
A string
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

password

Description
The login password for the specified user name. Both username and password must be supplied if this attribute is set.
Default Value
None
Allowed Values
A string
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action


dsconfig Usage

To list the configured SAML Artifact Resolution Endpoints:

dsconfig list-saml-artifact-resolution-endpoints
     [--property {propertyName}] ...

To view the configuration for an existing SAML Artifact Resolution Endpoint:

dsconfig get-saml-artifact-resolution-endpoint-prop
     --endpoint-name {name}
     --provider-name {name}
     [--tab-delimited]
     [--script-friendly]
     [--property {propertyName}] ...

To update the configuration for an existing SAML Artifact Resolution Endpoint:

dsconfig set-saml-artifact-resolution-endpoint-prop
     --endpoint-name {name}
     --provider-name {name}
     (--set|--add|--remove) {propertyName}:{propertyValue}
     [(--set|--add|--remove) {propertyName}:{propertyValue}] ...

To create a new SAML Artifact Resolution Endpoint:

dsconfig create-saml-artifact-resolution-endpoint
     --endpoint-name {name}
     --provider-name {name}
     [--set {propertyName}:{propertyValue}] ...

To delete an existing SAML Artifact Resolution Endpoint:

dsconfig delete-saml-artifact-resolution-endpoint
     --endpoint-name {name}
     --provider-name {name}