List API users

Retrieves the list of API users

GET /identity/apiusers?offset={offset}&limit={limit}

URI Parameters

Name In Required Type Description

offset

query

False

integer

Offset of the first API user in the list, default: 0

limit

query

False

integer

Maximum number of API users returned, default: 20, maximum: 100

Responses

Name Type Description

200 OK

ApiUserListResponse

API user list response object

Produces

  • application/json

Security

Every request requires a JWT access token for authentication in the Authorisation HTTP header. Please see the API authentication page for details about how to get a JWT token.

Authorization: Bearer {JWT_TOKEN}

Roles

  • Wenenu Owner

  • Wenenu API User Administrator

Sample request

GET https://wenenu.com/identity/apiusers?offset=0&limit=20 HTTP/1.1
Authorization: Bearer {jwt_token}

Sample Response

Status code: 200 OK

{
  "result": [
    {
      "id": "1c207ca9-6d7a-4d42-8527-47d4fb9a06c2",
      "name": "API user 1",
      "expiration": "2022-04-26",
      "tenantId": "108365366dc9-88be-4c42-8329-55808630",
      "roles": [
        "WENENU_SERVICE_CONNECTOR_ADMIN",
        "WENENU_TEST_AGENT_ADMIN"
      ],
      "secret": "rHn*****************************"
    },
    {
      "id": "2fed77e7-3701-4d18-bff2-bac79e75a6bb",
      "name": "API user 2",
      "expiration": "2199-12-31",
      "tenantId": "108365366dc9-88be-4c42-8329-55808630",
      "roles": [
        "WENENU_OWNER",
        "WENENU_READER",
        "WENENU_SERVICE_CONNECTOR_ADMIN",
        "WENENU_API_USER_ADMIN"
      ],
      "secret": "q[[*****************************"
    }
  ],
  "total":2
}

Definitions

ApiUserListResponse

Name Type Description

result

ApiUser[]

List of the requested API users

total

long

Total number of API users

ApiUser

Name Type Description

id

string

Version 4 UUID of the API user

tenantId

string

Version 4 UUID of the Wenenu tenant of the API user

name

string

Arbitrary name of the API user, length 1-64

expiration

string

Date of the expiration in ISO 8601 format

roles

string[]

List of Wenenu roles associated with the API user

secret

string

Masked secret of the API user, only the first three letters are revealed

newSecret

string

The secret of the API user returned only in the response of an API user creation