Organisation Management

Overview

User or API keys need to have ADMIN role to be able to interact Organisation Management.

Managing organisation API keys, including listing existing keys ids and viewing their roles, status, and expiry date.

Managing organisation users, including listing, updating, and inviting users.

API Keys Management

`listApiKeys` (query)

Use listApiKeys to retrieve all API keys available to your organisation, with key metadata for governance and access audits. This query is read-only and safe to integrate into admin dashboards or automated checks.

Example query

Example response

{
  "data": {
    "listApiKeys": {
      "orgApiKeysList": [
        {
          "name": "backend-service-key",
          "roles": ["CLUSTER_OPS", "CLUSTER_MANAGER"],
          "apiKeyExpiryDate": "2026-04-30T20:59:59.999Z",
          "apiKeyId": "dgf7cedb-90be-47d7-ab01-1bc1674c618a",
          "enabled": true
        },
        {
          "name": "key-2",
          "roles": ["ADMIN"],
          "apiKeyExpiryDate": "2026-04-30T20:59:59.999Z",
          "apiKeyId": "bff7cedb-90be-47d7-ab01-1bc1674c618a",
          "enabled": false
        }
      ]
    }
  }
}

`createOrgApiKey` (mutation)

Use createOrgApiKey to create a new organisation API key with specific roles and an expiry date. This is useful for automating lifecycle tasks such as creating, rotating, or disabling keys.

The api key is enabled by default after creation.

Example mutation

Example variables

{
  "createOrgApiKeyInput": {
    "name": "CI/CD Pipeline Key",
    "roles": ["ADMIN"],
    "apiKeyExpiryDate": "2026-12-31T23:59:59Z",
  }
}

name — Name to identify the key.

roles — Permissions/roles assigned to this key, expected as an array.

apiKeyExpiryDate — When this key should expire

Example response

{
  "data": {
    "createOrgApiKey": {
      "orgApiKey": "sk_live_51H8sKj29d...abc123xyz", //Value only returned at the creation
      "orgApiKeyDetails": {
        "name": "CI/CD Pipeline Key",
        "roles": ["ADMIN"],
        "apiKeyExpiryDate": "2026-12-31T23:59:59Z",
        "apiKeyId": "key_7f3a9c2d1b6e4a8f",
        "enabled": true
      }
    }
  }
}

`updateOrgApiKey` (mutation)

Use updateOrgApiKey to enable or disable an existing organisation API key.

Example mutation

Example variables

{
  "updateOrgApiKeyInput": {
    "apiKeyId": "ak_abc123",
    "enabled": false
  }
}

apiKeyId — ID of the key you want to change.

enabled — Set to true to enable or false to disable the organisation API key.

Example response

{
  "data": {
    "updateOrgApiKey": {
      "apiKeyId": "ak_abc123",
    }
  }
}

User Management

List users (`organisationManagement.listUsers` query)

Use organisationManagement.listUsers to list users in your organisation with their key details and roles.

Example query

Example response

{
  "data": {
    "organisationManagement": {
      "id": "f8588dc7-e1ce-4d92-a473-809a0a357ad9",
      "listUsers": {
        "total": 1,
        "items": [
          {
            "email": "user@example.com",
            "userTrustId": "e8388dc7-e1ce-4d92-a473-809a0a357ad9",
            "firstName": "Jane",
            "lastName": "Doe",
            "phoneNumber": "+430000000000", 
            "roles": ["ADMIN"],
            "createdAt": "2026-03-26T12:00:00Z"
          }
        ]
      }
    }
  }
}

Update user (`updateUser` mutation)

Use updateUser to change user information such as roles or enabled status.

Important: updateUser will replace all info (it is not a partial change).
Example: if the user has 3 roles and you send only 1 role, the user will end up with only that 1 role.

Example mutation

Example variables

{
  "updateUserInput": {
    "userTrustId": "e8388dc7-e1ce-4d92-a473-809a0a357ad9",
    "roles": ["ADMIN"],
    "enabled": true
  }
}

Example response

{
  "data": {
    "updateUser": {
      "email": "user@example.com",
      "userTrustId": "e8388dc7-e1ce-4d92-a473-809a0a357ad9",
      "firstName": "Jane",
      "lastName": "Doe",
      "phoneNumber": "+436761234567",
      "roles": ["ADMIN"],
      "createdAt": "2026-03-26T12:00:00Z"
    }
  }
}

Invite user (`inviteUser` mutation)

Use inviteUser to invite a new user to your organisation. The invited user will receive an email with instructions to complete their setup. You can also pre-assign roles as part of the invitation.

Example mutation

Example variables

{
  "inviteUserInput": {
    "email": "new.user@example.com",
    "firstName": "New",
    "lastName": "User",
    "phoneNumber": "+436761234568", //need to be a valid number
    "roles": ["ADMIN"],
    "enabled": true
  }
}

Example response

{
  "data": {
    "inviteUser": {
      "email": "new.user@example.com",
      "userTrustId": "b2fe1a6d-5d21-4af3-9d8a-9e9b59b0a1cd",
      "firstName": "New",
      "lastName": "User",
      "phoneNumber": "+436761234568",
      "roles": ["ADMIN"],
      "createdAt": "2026-03-27T09:15:00Z",
      "invited": true
    }
  }
}

Overview#

API Keys Management#

listApiKeys (query)#

createOrgApiKey (mutation)#

updateOrgApiKey (mutation)#

User Management#

List users (organisationManagement.listUsers query)#

Update user (updateUser mutation)#

Invite user (inviteUser mutation)#

Overview

API Keys Management

`listApiKeys` (query)

`createOrgApiKey` (mutation)

`updateOrgApiKey` (mutation)

User Management

List users (`organisationManagement.listUsers` query)

Update user (`updateUser` mutation)

Invite user (`inviteUser` mutation)