Skip to main content

Blocked Users

Axinom License Service Management API allows you to block end-users from receiving a DRM license. Using this API, you can add new blocked users, return all blocked users, and remove a user from the block list.

Blocking is enforced based on the user_id value provided in the entitlement message, under the session section. Once a user is blocked, any license request carrying that user's identifier will be denied.

Example:

You can assign a user_id under the session section in the entitlement message, as shown below.

"session": {
    "user_id": "sample string 1"
}

If this user ID is present in the block list under your tenant, the license service will deny the license request, effectively blocking access to content.

Authentication​

To use the Blocked Users API, you must authenticate using HTTP Basic Authentication. The required credentials are:

  • Tenant ID
  • License Service Management Key

The tenant ID and the Management Key shall be passed to each API request inside an Authorization header:

Authorization: Basic <credentials>

Basic <credentials>, where <credentials> is the base64 encoding of your Tenant ID and License Service Management Key value as GUID strings joined by a colon( :).

If the Tenant ID is 2028718f-1edd-482a-b6b5-8067e93cfbfa and the Management Key is e0b81b34-dd82-4897-89f2-bdf32d7023f7, then the resulting Authorization header should be:

Basic MjAyODcxOGYtMWVkZC00ODJhLWI2YjUtODA2N2U5M2NmYmZhOmUwYjgxYjM0LWRkODItNDg5Ny04OWYyLWJkZjMyZDcwMjNmNw==

Endpoint Summary​

EndpointMethodDescription
/BlockedUsersPOSTCreates new blocked users.
/BlockedUsersGETReturns all blocked users.
/BlockedUsers?userId={userId}DELETEDeletes a blocked user.

Block User​

Endpoint: POST https://drm-management.axprod.net/api/BlockedUsers

Each object of the request body must contain the UserId field, which is a string representing the unique identifier of the user to be blocked.

Sample Request Body:

[
  {
    "UserId": "sample string 1"
  },
  {
    "UserId": "sample string 2"
  }
]

Sample Response:

[
  {
    "Id": "b1f29cec-a27d-4879-9e68-afcb2886c90d",
    "UserId": "sample string 1",
    "Created": "2025-05-21T18:41:09.4243282+00:00"
  },
  {
    "Id": "b1f29cec-a27d-4879-9e68-afcb2886c90d",
    "UserId": "sample string 2",
    "Created": "2025-05-21T18:41:09.4243282+00:00"
  }

The response will contain a unique ID, the ID of the blocked user, and the date the user was blocked (in the ISO 8601 format).

tip

When a blocked user attempts to request a license, the following HTTP 403 error message will be returned by the license service:

License denied. The user has been blocked from receiving licenses.

This message is visible in the Network tab of browser developer tools, in the license request's response body.

If you do not want end users to see that they have been blocked, you can implement a license proxy between the client application and the Axinom License Service.

Get a list of Blocked Users​

You can send a GET request to the https://drm-management.axprod.net/api/BlockedUsers endpoint to get a list of all currently blocked users for the authenticated tenant.

Sample Response:

[
  {
    "Id": "0871abc2-f67f-41f4-8309-0e3436778111",
    "UserId": "sample string 2",
    "Created": "2025-05-26T11:50:20.6174272+00:00"
  },
  {
    "Id": "0871abc2-f67f-41f4-8309-0e3436778111",
    "UserId": "sample string 1",
    "Created": "2025-05-26T11:50:20.6174272+00:00"
  }
]

Unblock a User​

This endpoint removes the specified user_id from the blocked list, allowing license requests for that user to proceed normally.

Sample Request:

DELETE https://drm-management.axprod.net/api/BlockedUsers?userId=sample string 1

If you successfully unblock the user, you will see the 204 No Content status code. No response body is returned.