Portal Users

A PortalUser is an account for a person signing in to the portal, as opposed to an API key, which authenticates a machine. Portal users belong to a Customer; create as many as you need to give people in your organisation access.

A portal user is created by POSTing an object with email and password to the customer’s portalUsers collection. The platform mints a GUID as the resource identifier.

{
    "@context": "https://api.dlcs.example/contexts/PortalUser.jsonld",
    "@id": "https://api.dlcs.example/customers/2/portalUsers/5a8abee2-6bd6-4a4d-b586-1e2ea1f61e01",
    "@type": "vocab:PortalUser",
    "email": "user@example.com",
    "created": "2026-03-14T09:00:00.0000000Z",
    "enabled": true
}

HTTP operations

/customers/{customer}/portalUsers

Method	Label	Expects	Returns	Status
GET	Retrieves all portal users	-	🔗 hydra:Collection (of vocab:PortalUser)	200 OK
POST	Creates a new portal user	vocab:PortalUser	vocab:PortalUser	201 Created, 400 Bad Request

POST /customers/2/portalUsers
{
    "email": "user@example.com",
    "password": "plaintext-password"
}

POSTing an email address that is already used by one of your portal users returns 400 Bad Request.

/customers/{customer}/portalUsers/{portalUser}

Method	Label	Expects	Returns	Status
GET	Retrieve a portal user	-	vocab:PortalUser	200 OK, 404 Not Found
PATCH	Update a portal user	vocab:PortalUser	vocab:PortalUser	200 OK, 400 Bad Request
DELETE	Delete a portal user	-	-	204 No Content, 400 Bad Request

💻 Portal Users List portal users; create, retrieve, update and delete one.

email

The email address the user signs in with. Unique among your portal users.

domain	range	readonly	writeonly
vocab:PortalUser	xsd:string	False	False

password

The password, supplied when creating or updating a portal user. It is never returned by the API.

domain	range	readonly	writeonly
vocab:PortalUser	xsd:string	False	True

created

When this portal user was created.

domain	range	readonly	writeonly
vocab:PortalUser	xsd:dateTime	True	False

enabled

Whether the user can log in. Set to true on creation; cannot currently be changed via the API.

domain	range	readonly	writeonly
vocab:PortalUser	xsd:boolean	True	False