AuthService

IIIF Authentication Service configuration. The services configured here are exposed by the DLCS on IIIF Image API endpoints, so that a viewer that supports the IIIF Auth specification can interact with them to acquire a cookie that will gain access to the images. The DLCS enforces access control on a customer's behalf (this is essential for performance when many hundreds of image tiles are requested). This means it is the DLCS that implements the IIIF auth flow on your behalf. In one special case, 'clickthrough', you can configure an auth service in the DLCS that needs no runtime interation with your own systems. However, for more complex scenarios, the DLCS will need to direct the user to your (customer) servers during the auth flow, so that they can authenticate against your system. The DLCS then needs to query your system to acquire that user's roles,and thereby determine what level of service it can offer the user for a given protected image. See RoleProvider for imformation. The fields of AuthService give you control over how the service will be presented in a viewer that implements the IIF auth flow.

/customers/{0}/authServices/{1}

Supported operations

Supported properties

name

Name of service

profile

IIIF profile (what level of compliance). You will not usually set this.

label

Label that appears in IIIF model. This should be used by the viewer to present the service to the user.

description

Description that appears in IIIF model. This might be used by the viewer to present the service to the user.

pageLabel

Label that appears on pages generated by DLCS. If the user needs to see an interstitial page provided by the DLCS, this is the heading of the page. An example might be 'you are about to be redirected to the single sign on system of institution X'

pageDescription

Description that appears on pages generated by DLCS. As with the label above, used by the DLCS to generate pagesto present to a user during the flow.

callToAction

Label of button used on pages generated by DLCS (or clickthrough)

timeToLive

How long a cookie session and bearer token are valid for (seconds)

nestedServices (🔗)

Child auth services of a parent (relationship between login and token,logout)

/customers/{0}/authServices/{1}/nestedServices

roleProvider (🔗)

External service that can be used by the DLCS to acquire roles for user sessions. See RoleProvider.

/customers/{0}/authServices/{1}/roleProvider