Example

http://dlcs.azurewebsites.net/customers/4

Customer

A customer represents you, the API user. You only have access to one customer, so it is your effective entry point for the API. The only interation you can have with your Customer resource directly is updating the display name, but it provides links (🔗) tocollections of all the other resources.

/customers/{0}

Supported operations

Supported properties

name

The URL-friendly name of the customer

displayName

The display name of the customer

portalUsers (🔗)

Collection of user accounts that can log into the portal. Use this to grant access to others in your organisation

/customers/{0}/portalUsers

namedQueries (🔗)

Collection of all the Named Queries you have configured (plus those provided 'out of the box'). See the NamedQuery topic for further information

/customers/{0}/namedQueries

originStrategies (🔗)

Collection of configuration settings for retrieving your registered images from their origin URLs. If your images come from multiple locations you will have multiple origin strategies. See the OriginStrategy topic.

/customers/{0}/originStrategies

authServices (🔗)

Collection of IIIF Authentication services available for use with your images. The images are associated with the auth services via Roles. An AuthService is a means of acquirung a role.

/customers/{0}/authServices

roles (🔗)

Collection of the available roles you can assign to your images. In order for a user to see an image, the user must have the role associated with the image, or one of them. Users interact with an AuthService to acquire a role or roles.

/customers/{0}/roles

queue (🔗)

The Customer's view on the DLCS ingest queue. As well as allowing you to query the status of batches you have registered, you can POST new batches to the queue.

/customers/{0}/queue

spaces (🔗)

Collection of all the Space resources associated with your customer. A space allows you to partition images, have different default roles and tags, etc. See the Space topic.

/customers/{0}/spaces

keys (🔗)

Api keys allocated to this customer. The accompanying secret is only available at creation time. To obtain a key and a secret, make an empty POST to this collection with administrator privileges and the returned Key object will include the generates secret.

/customers/{0}/keys

storage (🔗)

Storage policy for the Customer

/customers/{0}/storage

acceptedAgreement

Has the customer accepted the EULA?