An asterisk * in the title indicates the field is mandatory.
If a field has a default value, it is shown in the Description column.
If the field type is an array, the Field Name has a .[n] suffix, where n is the array index placeholder.
Object and array field names are listed to provide context. If a field belongs to an object or an array, the full field name is shown in dot separated notation.

Title

Description

Details

Entity Id *

The unique identifier of the Identity Provider.

Field Name: entity_id
Type: String

This is a URI that will be embedded in the base SSO login URL in order to authenticate specifically with this IDP. This field must only contain alphanumeric characters and forward slashes, and should match the following regular expression ^\w+(/\w+)*$ Eg. Given a login URI of provider1/customer1, end users wishing to authenticate against this IDP will login via the following URL: http://hostname/sso/provider1/customer1/login/.

Field Name: login_uri
Type: String
Pattern: ^\w+(/\w+)*$

Metadata

Indicates where metadata can be found. This can be either a file accessible locally on the system or somewhere on the network.

Field Name: metadata
Type: Object

Local Metadata File

Field Name: metadata.local
Type: String
Target: data/File
Format: uri

Remote Metadata URL

Field Name: remote
Type: Object

URL

Location where metadata is to be downloaded from.

Field Name: metadata.remote.url
Type: String

Certificate

To verify the authenticity of the file downloaded from the net the local copy of the public key should be used. This public key must be acquired by some out-of-band method.

Field Name: metadata.remote.certificate
Type: String
Target: data/File
Format: uri

Model: data/SsoIdentityProvider

Model Details