Authentication Realms

You can use the Authentication Realms endpoint to configure authentication options. Authentication Realm sub-resources can be used to configure single sign-on.

The Authentication Realm object

Attributes

Sample Response

Attribute	Type	Description
id	string	The unique identifier for this authentication realm.
meta	object	Additional information for this realm. Also see: The meta object below.
name	string	The name of the authentication realm.
redirect_uris	array[string]	An array of allowed redirection endpoints. Only URIs listed here are allowed to use single sign-on functionality. URIs must exactly match those used in the client applications, for example, the store front. Additionally, with the exception of localhost, all urls must use https.
relationships	object	Related resources. Also see: The relationships object below.
type	string	The type represents the object being returned.

{
    "data": {
        "id": "40086652-2779-45f0-8ea6-ae630dfd13cb",
        "meta": {
            "created_at": "2020-11-04T21:28:50.796Z",
            "updated_at": "2020-11-04T21:28:50.796Z"
        },
        "name": "Test Authentication Realm",
        "redirect_uris": [
            "https://example.com"
        ],
        "relationships": {
            "origin": {
                "data": {
                    "id": "88888888-4444-4333-8333-111111111111",
                    "type": "customer-authentication-settings"
                }
            }
        },
        "type": "authentication-realm"
    },
    "links": {
        "self": "https://api.moltin.com/v2/authentication-realms/40086652-2779-45f0-8ea6-ae630dfd13cb"
    }
}

The meta object

Attribute	Type	Description
meta.created_at	string	The creation date of this realm.
meta.updated_at	string	The last updated date of this realm.

The relationships object

Attribute	Type	Description
relationships.origin	object	Relationships information regarding the entity that created this realm.
relationships.origin.data	object	Information regarding the origin entity.
relationships.origin.data.id	string	The id of the origin entity.
relationships.origin.data.type	string	The type of the origin entity. Currently only customer-authentication-settings is supported, however other values are still accepted.