API Tokens

Create and manage lh_ organization API tokens with scoped rights. The full token value is only returned once, at creation. Session-only: a token cannot mint other tokens.

List API tokens

GET/api/v1/orgs/{org_id}/api-tokens

User session only (API tokens not accepted)

List all API tokens for an organization. Returns token metadata including the prefix, but never the full token secret. Requires `roles.action_read` permission.

Path parameters

org_idintegerrequired

Returns

APITokenRead[]: List of API tokens for the organization (metadata only).

idintegerrequired

token_uuidstringrequired

namestringrequired

descriptionstring | null

token_prefixstringrequired

org_idintegerrequired

rightsRights | object | null

Show child attributes

coursesPermissionsWithOwnrequired

Show child attributes

action_createbooleanrequired

action_readbooleanrequired

action_read_ownbooleanrequired

action_updatebooleanrequired

action_update_ownbooleanrequired

action_deletebooleanrequired

action_delete_ownbooleanrequired

usersPermissionrequired

Show child attributes

action_createbooleanrequired

action_readbooleanrequired

action_updatebooleanrequired

action_deletebooleanrequired

usergroupsPermissionrequired

Show child attributes

action_createbooleanrequired

action_readbooleanrequired

action_updatebooleanrequired

action_deletebooleanrequired

foldersPermission

Show child attributes

action_createbooleanrequired

action_readbooleanrequired

action_updatebooleanrequired

action_deletebooleanrequired

mediaPermission

Show child attributes

action_createbooleanrequired

action_readbooleanrequired

action_updatebooleanrequired

action_deletebooleanrequired

organizationsPermissionrequired

Show child attributes

action_createbooleanrequired

action_readbooleanrequired

action_updatebooleanrequired

action_deletebooleanrequired

coursechaptersPermissionrequired

Show child attributes

action_createbooleanrequired

action_readbooleanrequired

action_updatebooleanrequired

action_deletebooleanrequired

activitiesPermissionrequired

Show child attributes

action_createbooleanrequired

action_readbooleanrequired

action_updatebooleanrequired

action_deletebooleanrequired

assignmentsPermission

Show child attributes

action_createbooleanrequired

action_readbooleanrequired

action_updatebooleanrequired

action_deletebooleanrequired

rolesPermissionrequired

Show child attributes

action_createbooleanrequired

action_readbooleanrequired

action_updatebooleanrequired

action_deletebooleanrequired

dashboardDashboardPermissionrequired

Show child attributes

action_accessbooleanrequired

communitiesPermissionrequired

Show child attributes

action_createbooleanrequired

action_readbooleanrequired

action_updatebooleanrequired

action_deletebooleanrequired

discussionsPermissionsWithOwnrequired

Show child attributes

action_createbooleanrequired

action_readbooleanrequired

action_read_ownbooleanrequired

action_updatebooleanrequired

action_update_ownbooleanrequired

action_deletebooleanrequired

action_delete_ownbooleanrequired

podcastsPermissionsWithOwnrequired

Show child attributes

action_createbooleanrequired

action_readbooleanrequired

action_read_ownbooleanrequired

action_updatebooleanrequired

action_update_ownbooleanrequired

action_deletebooleanrequired

action_delete_ownbooleanrequired

boardsPermissionsWithOwn

Show child attributes

action_createbooleanrequired

action_readbooleanrequired

action_read_ownbooleanrequired

action_updatebooleanrequired

action_update_ownbooleanrequired

action_deletebooleanrequired

action_delete_ownbooleanrequired

playgroundsPermissionsWithOwn

Show child attributes

action_createbooleanrequired

action_readbooleanrequired

action_read_ownbooleanrequired

action_updatebooleanrequired

action_update_ownbooleanrequired

action_deletebooleanrequired

action_delete_ownbooleanrequired

created_by_user_idintegerrequired

creation_datestringrequired

update_datestringrequired

last_used_atstring | null

expires_atstring | null

is_activebooleanrequired

Error responses

401 Authentication required
422 Validation Error: HTTPValidationError

Request

Response

[
  {
    "id": 1,
    "token_uuid": "string",
    "name": "Example name",
    "description": "An example description",
    "token_prefix": "string",
    "org_id": 1,
    "rights": {
      "courses": {
        "action_create": false,
        "action_read": false,
        "action_read_own": false,
        "action_update": false,
        "action_update_own": false,
        "action_delete": false,
        "action_delete_own": false
      },
      "users": {
        "action_create": false,
        "action_read": false,
        "action_update": false,
        "action_delete": false
      },
      "usergroups": {
        "action_create": false,
        "action_read": false,
        "action_update": false,
        "action_delete": false
      },
      "folders": {
        "action_create": false,
        "action_read": false,
        "action_update": false,
        "action_delete": false
      },
      "media": {
        "action_create": false,
        "action_read": false,
        "action_update": false,
        "action_delete": false
      },
      "organizations": {
        "action_create": false,
        "action_read": false,
        "action_update": false,
        "action_delete": false
      },
      "coursechapters": {
        "action_create": false,
        "action_read": false,
        "action_update": false,
        "action_delete": false
      },
      "activities": {
        "action_create": false,
        "action_read": false,
        "action_update": false,
        "action_delete": false
      },
      "assignments": {
        "action_create": false,
        "action_read": false,
        "action_update": false,
        "action_delete": false
      },
      "roles": {
        "action_create": false,
        "action_read": false,
        "action_update": false,
        "action_delete": false
      },
      "dashboard": {
        "action_access": false
      },
      "communities": {
        "action_create": false,
        "action_read": false,
        "action_update": false,
        "action_delete": false
      },
      "discussions": {
        "action_create": false,
        "action_read": false,
        "action_read_own": false,
        "action_update": false,
        "action_update_own": false,
        "action_delete": false,
        "action_delete_own": false
      },
      "podcasts": {
        "action_create": false,
        "action_read": false,
        "action_read_own": false,
        "action_update": false,
        "action_update_own": false,
        "action_delete": false,
        "action_delete_own": false
      },
      "boards": {
        "action_create": false,
        "action_read": false,
        "action_read_own": false,
        "action_update": false,
        "action_update_own": false,
        "action_delete": false,
        "action_delete_own": false
      },
      "playgrounds": {
        "action_create": false,
        "action_read": false,
        "action_read_own": false,
        "action_update": false,
        "action_update_own": false,
        "action_delete": false,
        "action_delete_own": false
      }
    },
    "created_by_user_id": 1,
    "creation_date": "string",
    "update_date": "string",
    "last_used_at": "string",
    "expires_at": "string",
    "is_active": false
  }
]

Create API token

POST/api/v1/orgs/{org_id}/api-tokens

User session only (API tokens not accepted)

Create a new API token for an organization. The full token value is only returned once upon creation — store it securely, as it cannot be retrieved later. Requires the user to have `roles.action_create` permission in the organization.

Path parameters

org_idintegerrequired

Request bodyapplication/jsonrequired

namestringrequired

descriptionstring | null

rightsRights | object | null

Show child attributes

coursesPermissionsWithOwnrequired

Show child attributes

action_createbooleanrequired

action_readbooleanrequired

action_read_ownbooleanrequired

action_updatebooleanrequired

action_update_ownbooleanrequired

action_deletebooleanrequired

action_delete_ownbooleanrequired

usersPermissionrequired

Show child attributes

action_createbooleanrequired

action_readbooleanrequired

action_updatebooleanrequired

action_deletebooleanrequired

usergroupsPermissionrequired

Show child attributes

action_createbooleanrequired

action_readbooleanrequired

action_updatebooleanrequired

action_deletebooleanrequired

foldersPermission

Show child attributes

action_createbooleanrequired

action_readbooleanrequired

action_updatebooleanrequired

action_deletebooleanrequired

mediaPermission

Show child attributes

action_createbooleanrequired

action_readbooleanrequired

action_updatebooleanrequired

action_deletebooleanrequired

organizationsPermissionrequired

Show child attributes

action_createbooleanrequired

action_readbooleanrequired

action_updatebooleanrequired

action_deletebooleanrequired

coursechaptersPermissionrequired

Show child attributes

action_createbooleanrequired

action_readbooleanrequired

action_updatebooleanrequired

action_deletebooleanrequired

activitiesPermissionrequired

Show child attributes

action_createbooleanrequired

action_readbooleanrequired

action_updatebooleanrequired

action_deletebooleanrequired

assignmentsPermission

Show child attributes

action_createbooleanrequired

action_readbooleanrequired

action_updatebooleanrequired

action_deletebooleanrequired

rolesPermissionrequired

Show child attributes

action_createbooleanrequired

action_readbooleanrequired

action_updatebooleanrequired

action_deletebooleanrequired

dashboardDashboardPermissionrequired

Show child attributes

action_accessbooleanrequired

communitiesPermissionrequired

Show child attributes

action_createbooleanrequired

action_readbooleanrequired

action_updatebooleanrequired

action_deletebooleanrequired

discussionsPermissionsWithOwnrequired

Show child attributes

action_createbooleanrequired

action_readbooleanrequired

action_read_ownbooleanrequired

action_updatebooleanrequired

action_update_ownbooleanrequired

action_deletebooleanrequired

action_delete_ownbooleanrequired

podcastsPermissionsWithOwnrequired

Show child attributes

action_createbooleanrequired

action_readbooleanrequired

action_read_ownbooleanrequired

action_updatebooleanrequired

action_update_ownbooleanrequired

action_deletebooleanrequired

action_delete_ownbooleanrequired

boardsPermissionsWithOwn

Show child attributes

action_createbooleanrequired

action_readbooleanrequired

action_read_ownbooleanrequired

action_updatebooleanrequired

action_update_ownbooleanrequired

action_deletebooleanrequired

action_delete_ownbooleanrequired

playgroundsPermissionsWithOwn

Show child attributes

action_createbooleanrequired

action_readbooleanrequired

action_read_ownbooleanrequired

action_updatebooleanrequired

action_update_ownbooleanrequired

action_deletebooleanrequired

action_delete_ownbooleanrequired

expires_atstring | null

Returns

APITokenCreatedResponse: Token created; the full secret is included in the response (only time it is returned).

tokenstringrequired

token_uuidstringrequired

namestringrequired

descriptionstring | null

token_prefixstringrequired

org_idintegerrequired

rightsRights | object | null

Show child attributes

coursesPermissionsWithOwnrequired

Show child attributes

action_createbooleanrequired

action_readbooleanrequired

action_read_ownbooleanrequired

action_updatebooleanrequired

action_update_ownbooleanrequired

action_deletebooleanrequired

action_delete_ownbooleanrequired

usersPermissionrequired

Show child attributes

action_createbooleanrequired

action_readbooleanrequired

action_updatebooleanrequired

action_deletebooleanrequired

usergroupsPermissionrequired

Show child attributes

action_createbooleanrequired

action_readbooleanrequired

action_updatebooleanrequired

action_deletebooleanrequired

foldersPermission

Show child attributes

action_createbooleanrequired

action_readbooleanrequired

action_updatebooleanrequired

action_deletebooleanrequired

mediaPermission

Show child attributes

action_createbooleanrequired

action_readbooleanrequired

action_updatebooleanrequired

action_deletebooleanrequired

organizationsPermissionrequired

Show child attributes

action_createbooleanrequired

action_readbooleanrequired

action_updatebooleanrequired

action_deletebooleanrequired

coursechaptersPermissionrequired

Show child attributes

action_createbooleanrequired

action_readbooleanrequired

action_updatebooleanrequired

action_deletebooleanrequired

activitiesPermissionrequired

Show child attributes

action_createbooleanrequired

action_readbooleanrequired

action_updatebooleanrequired

action_deletebooleanrequired

assignmentsPermission

Show child attributes

action_createbooleanrequired

action_readbooleanrequired

action_updatebooleanrequired

action_deletebooleanrequired

rolesPermissionrequired

Show child attributes

action_createbooleanrequired

action_readbooleanrequired

action_updatebooleanrequired

action_deletebooleanrequired

dashboardDashboardPermissionrequired

Show child attributes

action_accessbooleanrequired

communitiesPermissionrequired

Show child attributes

action_createbooleanrequired

action_readbooleanrequired

action_updatebooleanrequired

action_deletebooleanrequired

discussionsPermissionsWithOwnrequired

Show child attributes

action_createbooleanrequired

action_readbooleanrequired

action_read_ownbooleanrequired

action_updatebooleanrequired

action_update_ownbooleanrequired

action_deletebooleanrequired

action_delete_ownbooleanrequired

podcastsPermissionsWithOwnrequired

Show child attributes

action_createbooleanrequired

action_readbooleanrequired

action_read_ownbooleanrequired

action_updatebooleanrequired

action_update_ownbooleanrequired

action_deletebooleanrequired

action_delete_ownbooleanrequired

boardsPermissionsWithOwn

Show child attributes

action_createbooleanrequired

action_readbooleanrequired

action_read_ownbooleanrequired

action_updatebooleanrequired

action_update_ownbooleanrequired

action_deletebooleanrequired

action_delete_ownbooleanrequired

playgroundsPermissionsWithOwn

Show child attributes

action_createbooleanrequired

action_readbooleanrequired

action_read_ownbooleanrequired

action_updatebooleanrequired

action_update_ownbooleanrequired

action_deletebooleanrequired

action_delete_ownbooleanrequired

created_by_user_idintegerrequired

creation_datestringrequired

expires_atstring | null

Error responses

401 Authentication required
422 Validation Error: HTTPValidationError
429 Rate limit exceeded for token creation

Request

Response

{
  "token": "string",
  "token_uuid": "string",
  "name": "Example name",
  "description": "An example description",
  "token_prefix": "string",
  "org_id": 1,
  "rights": {
    "courses": {
      "action_create": false,
      "action_read": false,
      "action_read_own": false,
      "action_update": false,
      "action_update_own": false,
      "action_delete": false,
      "action_delete_own": false
    },
    "users": {
      "action_create": false,
      "action_read": false,
      "action_update": false,
      "action_delete": false
    },
    "usergroups": {
      "action_create": false,
      "action_read": false,
      "action_update": false,
      "action_delete": false
    },
    "folders": {
      "action_create": false,
      "action_read": false,
      "action_update": false,
      "action_delete": false
    },
    "media": {
      "action_create": false,
      "action_read": false,
      "action_update": false,
      "action_delete": false
    },
    "organizations": {
      "action_create": false,
      "action_read": false,
      "action_update": false,
      "action_delete": false
    },
    "coursechapters": {
      "action_create": false,
      "action_read": false,
      "action_update": false,
      "action_delete": false
    },
    "activities": {
      "action_create": false,
      "action_read": false,
      "action_update": false,
      "action_delete": false
    },
    "assignments": {
      "action_create": false,
      "action_read": false,
      "action_update": false,
      "action_delete": false
    },
    "roles": {
      "action_create": false,
      "action_read": false,
      "action_update": false,
      "action_delete": false
    },
    "dashboard": {
      "action_access": false
    },
    "communities": {
      "action_create": false,
      "action_read": false,
      "action_update": false,
      "action_delete": false
    },
    "discussions": {
      "action_create": false,
      "action_read": false,
      "action_read_own": false,
      "action_update": false,
      "action_update_own": false,
      "action_delete": false,
      "action_delete_own": false
    },
    "podcasts": {
      "action_create": false,
      "action_read": false,
      "action_read_own": false,
      "action_update": false,
      "action_update_own": false,
      "action_delete": false,
      "action_delete_own": false
    },
    "boards": {
      "action_create": false,
      "action_read": false,
      "action_read_own": false,
      "action_update": false,
      "action_update_own": false,
      "action_delete": false,
      "action_delete_own": false
    },
    "playgrounds": {
      "action_create": false,
      "action_read": false,
      "action_read_own": false,
      "action_update": false,
      "action_update_own": false,
      "action_delete": false,
      "action_delete_own": false
    }
  },
  "created_by_user_id": 1,
  "creation_date": "string",
  "expires_at": "string"
}

Get API token

GET/api/v1/orgs/{org_id}/api-tokens/{token_uuid}

User session only (API tokens not accepted)

Get details of a specific API token. Returns token metadata, but never the full token secret.

Path parameters

org_idintegerrequired

token_uuidstringrequired

Returns

APITokenRead: API token metadata.

idintegerrequired

token_uuidstringrequired

namestringrequired

descriptionstring | null

token_prefixstringrequired

org_idintegerrequired

rightsRights | object | null

Show child attributes

coursesPermissionsWithOwnrequired

Show child attributes

action_createbooleanrequired

action_readbooleanrequired

action_read_ownbooleanrequired

action_updatebooleanrequired

action_update_ownbooleanrequired

action_deletebooleanrequired

action_delete_ownbooleanrequired

usersPermissionrequired

Show child attributes

action_createbooleanrequired

action_readbooleanrequired

action_updatebooleanrequired

action_deletebooleanrequired

usergroupsPermissionrequired

Show child attributes

action_createbooleanrequired

action_readbooleanrequired

action_updatebooleanrequired

action_deletebooleanrequired

foldersPermission

Show child attributes

action_createbooleanrequired

action_readbooleanrequired

action_updatebooleanrequired

action_deletebooleanrequired

mediaPermission

Show child attributes

action_createbooleanrequired

action_readbooleanrequired

action_updatebooleanrequired

action_deletebooleanrequired

organizationsPermissionrequired

Show child attributes

action_createbooleanrequired

action_readbooleanrequired

action_updatebooleanrequired

action_deletebooleanrequired

coursechaptersPermissionrequired

Show child attributes

action_createbooleanrequired

action_readbooleanrequired

action_updatebooleanrequired

action_deletebooleanrequired

activitiesPermissionrequired

Show child attributes

action_createbooleanrequired

action_readbooleanrequired

action_updatebooleanrequired

action_deletebooleanrequired

assignmentsPermission

Show child attributes

action_createbooleanrequired

action_readbooleanrequired

action_updatebooleanrequired

action_deletebooleanrequired

rolesPermissionrequired

Show child attributes

action_createbooleanrequired

action_readbooleanrequired

action_updatebooleanrequired

action_deletebooleanrequired

dashboardDashboardPermissionrequired

Show child attributes

action_accessbooleanrequired

communitiesPermissionrequired

Show child attributes

action_createbooleanrequired

action_readbooleanrequired

action_updatebooleanrequired

action_deletebooleanrequired

discussionsPermissionsWithOwnrequired

Show child attributes

action_createbooleanrequired

action_readbooleanrequired

action_read_ownbooleanrequired

action_updatebooleanrequired

action_update_ownbooleanrequired

action_deletebooleanrequired

action_delete_ownbooleanrequired

podcastsPermissionsWithOwnrequired

Show child attributes

action_createbooleanrequired

action_readbooleanrequired

action_read_ownbooleanrequired

action_updatebooleanrequired

action_update_ownbooleanrequired

action_deletebooleanrequired

action_delete_ownbooleanrequired

boardsPermissionsWithOwn

Show child attributes

action_createbooleanrequired

action_readbooleanrequired

action_read_ownbooleanrequired

action_updatebooleanrequired

action_update_ownbooleanrequired

action_deletebooleanrequired

action_delete_ownbooleanrequired

playgroundsPermissionsWithOwn

Show child attributes

action_createbooleanrequired

action_readbooleanrequired

action_read_ownbooleanrequired

action_updatebooleanrequired

action_update_ownbooleanrequired

action_deletebooleanrequired

action_delete_ownbooleanrequired

created_by_user_idintegerrequired

creation_datestringrequired

update_datestringrequired

last_used_atstring | null

expires_atstring | null

is_activebooleanrequired

Error responses

401 Authentication required
422 Validation Error: HTTPValidationError

Request

Response

{
  "id": 1,
  "token_uuid": "string",
  "name": "Example name",
  "description": "An example description",
  "token_prefix": "string",
  "org_id": 1,
  "rights": {
    "courses": {
      "action_create": false,
      "action_read": false,
      "action_read_own": false,
      "action_update": false,
      "action_update_own": false,
      "action_delete": false,
      "action_delete_own": false
    },
    "users": {
      "action_create": false,
      "action_read": false,
      "action_update": false,
      "action_delete": false
    },
    "usergroups": {
      "action_create": false,
      "action_read": false,
      "action_update": false,
      "action_delete": false
    },
    "folders": {
      "action_create": false,
      "action_read": false,
      "action_update": false,
      "action_delete": false
    },
    "media": {
      "action_create": false,
      "action_read": false,
      "action_update": false,
      "action_delete": false
    },
    "organizations": {
      "action_create": false,
      "action_read": false,
      "action_update": false,
      "action_delete": false
    },
    "coursechapters": {
      "action_create": false,
      "action_read": false,
      "action_update": false,
      "action_delete": false
    },
    "activities": {
      "action_create": false,
      "action_read": false,
      "action_update": false,
      "action_delete": false
    },
    "assignments": {
      "action_create": false,
      "action_read": false,
      "action_update": false,
      "action_delete": false
    },
    "roles": {
      "action_create": false,
      "action_read": false,
      "action_update": false,
      "action_delete": false
    },
    "dashboard": {
      "action_access": false
    },
    "communities": {
      "action_create": false,
      "action_read": false,
      "action_update": false,
      "action_delete": false
    },
    "discussions": {
      "action_create": false,
      "action_read": false,
      "action_read_own": false,
      "action_update": false,
      "action_update_own": false,
      "action_delete": false,
      "action_delete_own": false
    },
    "podcasts": {
      "action_create": false,
      "action_read": false,
      "action_read_own": false,
      "action_update": false,
      "action_update_own": false,
      "action_delete": false,
      "action_delete_own": false
    },
    "boards": {
      "action_create": false,
      "action_read": false,
      "action_read_own": false,
      "action_update": false,
      "action_update_own": false,
      "action_delete": false,
      "action_delete_own": false
    },
    "playgrounds": {
      "action_create": false,
      "action_read": false,
      "action_read_own": false,
      "action_update": false,
      "action_update_own": false,
      "action_delete": false,
      "action_delete_own": false
    }
  },
  "created_by_user_id": 1,
  "creation_date": "string",
  "update_date": "string",
  "last_used_at": "string",
  "expires_at": "string",
  "is_active": false
}

Update API token

PUT/api/v1/orgs/{org_id}/api-tokens/{token_uuid}

User session only (API tokens not accepted)

Update an API token's name, description, rights, or expiration. The token secret cannot be changed here — use the regenerate endpoint for that. Requires `roles.action_update` permission.

Path parameters

org_idintegerrequired

token_uuidstringrequired

Request bodyapplication/jsonrequired

namestring | null

descriptionstring | null

rightsRights | object | null

Show child attributes

coursesPermissionsWithOwnrequired

Show child attributes

action_createbooleanrequired

action_readbooleanrequired

action_read_ownbooleanrequired

action_updatebooleanrequired

action_update_ownbooleanrequired

action_deletebooleanrequired

action_delete_ownbooleanrequired

usersPermissionrequired

Show child attributes

action_createbooleanrequired

action_readbooleanrequired

action_updatebooleanrequired

action_deletebooleanrequired

usergroupsPermissionrequired

Show child attributes

action_createbooleanrequired

action_readbooleanrequired

action_updatebooleanrequired

action_deletebooleanrequired

foldersPermission

Show child attributes

action_createbooleanrequired

action_readbooleanrequired

action_updatebooleanrequired

action_deletebooleanrequired

mediaPermission

Show child attributes

action_createbooleanrequired

action_readbooleanrequired

action_updatebooleanrequired

action_deletebooleanrequired

organizationsPermissionrequired

Show child attributes

action_createbooleanrequired

action_readbooleanrequired

action_updatebooleanrequired

action_deletebooleanrequired

coursechaptersPermissionrequired

Show child attributes

action_createbooleanrequired

action_readbooleanrequired

action_updatebooleanrequired

action_deletebooleanrequired

activitiesPermissionrequired

Show child attributes

action_createbooleanrequired

action_readbooleanrequired

action_updatebooleanrequired

action_deletebooleanrequired

assignmentsPermission

Show child attributes

action_createbooleanrequired

action_readbooleanrequired

action_updatebooleanrequired

action_deletebooleanrequired

rolesPermissionrequired

Show child attributes

action_createbooleanrequired

action_readbooleanrequired

action_updatebooleanrequired

action_deletebooleanrequired

dashboardDashboardPermissionrequired

Show child attributes

action_accessbooleanrequired

communitiesPermissionrequired

Show child attributes

action_createbooleanrequired

action_readbooleanrequired

action_updatebooleanrequired

action_deletebooleanrequired

discussionsPermissionsWithOwnrequired

Show child attributes

action_createbooleanrequired

action_readbooleanrequired

action_read_ownbooleanrequired

action_updatebooleanrequired

action_update_ownbooleanrequired

action_deletebooleanrequired

action_delete_ownbooleanrequired

podcastsPermissionsWithOwnrequired

Show child attributes

action_createbooleanrequired

action_readbooleanrequired

action_read_ownbooleanrequired

action_updatebooleanrequired

action_update_ownbooleanrequired

action_deletebooleanrequired

action_delete_ownbooleanrequired

boardsPermissionsWithOwn

Show child attributes

action_createbooleanrequired

action_readbooleanrequired

action_read_ownbooleanrequired

action_updatebooleanrequired

action_update_ownbooleanrequired

action_deletebooleanrequired

action_delete_ownbooleanrequired

playgroundsPermissionsWithOwn

Show child attributes

action_createbooleanrequired

action_readbooleanrequired

action_read_ownbooleanrequired

action_updatebooleanrequired

action_update_ownbooleanrequired

action_deletebooleanrequired

action_delete_ownbooleanrequired

expires_atstring | null

Returns

APITokenRead: Token metadata updated.

idintegerrequired

token_uuidstringrequired

namestringrequired

descriptionstring | null

token_prefixstringrequired

org_idintegerrequired

rightsRights | object | null

Show child attributes

coursesPermissionsWithOwnrequired

Show child attributes

action_createbooleanrequired

action_readbooleanrequired

action_read_ownbooleanrequired

action_updatebooleanrequired

action_update_ownbooleanrequired

action_deletebooleanrequired

action_delete_ownbooleanrequired

usersPermissionrequired

Show child attributes

action_createbooleanrequired

action_readbooleanrequired

action_updatebooleanrequired

action_deletebooleanrequired

usergroupsPermissionrequired

Show child attributes

action_createbooleanrequired

action_readbooleanrequired

action_updatebooleanrequired

action_deletebooleanrequired

foldersPermission

Show child attributes

action_createbooleanrequired

action_readbooleanrequired

action_updatebooleanrequired

action_deletebooleanrequired

mediaPermission

Show child attributes

action_createbooleanrequired

action_readbooleanrequired

action_updatebooleanrequired

action_deletebooleanrequired

organizationsPermissionrequired

Show child attributes

action_createbooleanrequired

action_readbooleanrequired

action_updatebooleanrequired

action_deletebooleanrequired

coursechaptersPermissionrequired

Show child attributes

action_createbooleanrequired

action_readbooleanrequired

action_updatebooleanrequired

action_deletebooleanrequired

activitiesPermissionrequired

Show child attributes

action_createbooleanrequired

action_readbooleanrequired

action_updatebooleanrequired

action_deletebooleanrequired

assignmentsPermission

Show child attributes

action_createbooleanrequired

action_readbooleanrequired

action_updatebooleanrequired

action_deletebooleanrequired

rolesPermissionrequired

Show child attributes

action_createbooleanrequired

action_readbooleanrequired

action_updatebooleanrequired

action_deletebooleanrequired

dashboardDashboardPermissionrequired

Show child attributes

action_accessbooleanrequired

communitiesPermissionrequired

Show child attributes

action_createbooleanrequired

action_readbooleanrequired

action_updatebooleanrequired

action_deletebooleanrequired

discussionsPermissionsWithOwnrequired

Show child attributes

action_createbooleanrequired

action_readbooleanrequired

action_read_ownbooleanrequired

action_updatebooleanrequired

action_update_ownbooleanrequired

action_deletebooleanrequired

action_delete_ownbooleanrequired

podcastsPermissionsWithOwnrequired

Show child attributes

action_createbooleanrequired

action_readbooleanrequired

action_read_ownbooleanrequired

action_updatebooleanrequired

action_update_ownbooleanrequired

action_deletebooleanrequired

action_delete_ownbooleanrequired

boardsPermissionsWithOwn

Show child attributes

action_createbooleanrequired

action_readbooleanrequired

action_read_ownbooleanrequired

action_updatebooleanrequired

action_update_ownbooleanrequired

action_deletebooleanrequired

action_delete_ownbooleanrequired

playgroundsPermissionsWithOwn

Show child attributes

action_createbooleanrequired

action_readbooleanrequired

action_read_ownbooleanrequired

action_updatebooleanrequired

action_update_ownbooleanrequired

action_deletebooleanrequired

action_delete_ownbooleanrequired

created_by_user_idintegerrequired

creation_datestringrequired

update_datestringrequired

last_used_atstring | null

expires_atstring | null

is_activebooleanrequired

Error responses

401 Authentication required
422 Validation Error: HTTPValidationError

Request

Response

{
  "id": 1,
  "token_uuid": "string",
  "name": "Example name",
  "description": "An example description",
  "token_prefix": "string",
  "org_id": 1,
  "rights": {
    "courses": {
      "action_create": false,
      "action_read": false,
      "action_read_own": false,
      "action_update": false,
      "action_update_own": false,
      "action_delete": false,
      "action_delete_own": false
    },
    "users": {
      "action_create": false,
      "action_read": false,
      "action_update": false,
      "action_delete": false
    },
    "usergroups": {
      "action_create": false,
      "action_read": false,
      "action_update": false,
      "action_delete": false
    },
    "folders": {
      "action_create": false,
      "action_read": false,
      "action_update": false,
      "action_delete": false
    },
    "media": {
      "action_create": false,
      "action_read": false,
      "action_update": false,
      "action_delete": false
    },
    "organizations": {
      "action_create": false,
      "action_read": false,
      "action_update": false,
      "action_delete": false
    },
    "coursechapters": {
      "action_create": false,
      "action_read": false,
      "action_update": false,
      "action_delete": false
    },
    "activities": {
      "action_create": false,
      "action_read": false,
      "action_update": false,
      "action_delete": false
    },
    "assignments": {
      "action_create": false,
      "action_read": false,
      "action_update": false,
      "action_delete": false
    },
    "roles": {
      "action_create": false,
      "action_read": false,
      "action_update": false,
      "action_delete": false
    },
    "dashboard": {
      "action_access": false
    },
    "communities": {
      "action_create": false,
      "action_read": false,
      "action_update": false,
      "action_delete": false
    },
    "discussions": {
      "action_create": false,
      "action_read": false,
      "action_read_own": false,
      "action_update": false,
      "action_update_own": false,
      "action_delete": false,
      "action_delete_own": false
    },
    "podcasts": {
      "action_create": false,
      "action_read": false,
      "action_read_own": false,
      "action_update": false,
      "action_update_own": false,
      "action_delete": false,
      "action_delete_own": false
    },
    "boards": {
      "action_create": false,
      "action_read": false,
      "action_read_own": false,
      "action_update": false,
      "action_update_own": false,
      "action_delete": false,
      "action_delete_own": false
    },
    "playgrounds": {
      "action_create": false,
      "action_read": false,
      "action_read_own": false,
      "action_update": false,
      "action_update_own": false,
      "action_delete": false,
      "action_delete_own": false
    }
  },
  "created_by_user_id": 1,
  "creation_date": "string",
  "update_date": "string",
  "last_used_at": "string",
  "expires_at": "string",
  "is_active": false
}

Revoke API token

DELETE/api/v1/orgs/{org_id}/api-tokens/{token_uuid}

User session only (API tokens not accepted)

Revoke an API token. The token will immediately stop working and this action cannot be undone. Requires `roles.action_delete` permission.

Path parameters

org_idintegerrequired

token_uuidstringrequired

Error responses

401 Authentication required
422 Validation Error: HTTPValidationError

Request

Response

{}

Regenerate API token secret

POST/api/v1/orgs/{org_id}/api-tokens/{token_uuid}/regenerate

User session only (API tokens not accepted)

Regenerate the secret for an API token. The old token will immediately stop working. The new full token value is only returned once — store it securely. Requires `roles.action_update` permission.

Path parameters

org_idintegerrequired

token_uuidstringrequired

Returns

APITokenCreatedResponse: Token secret regenerated; new full secret is returned.

tokenstringrequired

token_uuidstringrequired

namestringrequired

descriptionstring | null

token_prefixstringrequired

org_idintegerrequired

rightsRights | object | null

Show child attributes

coursesPermissionsWithOwnrequired

Show child attributes

action_createbooleanrequired

action_readbooleanrequired

action_read_ownbooleanrequired

action_updatebooleanrequired

action_update_ownbooleanrequired

action_deletebooleanrequired

action_delete_ownbooleanrequired

usersPermissionrequired

Show child attributes

action_createbooleanrequired

action_readbooleanrequired

action_updatebooleanrequired

action_deletebooleanrequired

usergroupsPermissionrequired

Show child attributes

action_createbooleanrequired

action_readbooleanrequired

action_updatebooleanrequired

action_deletebooleanrequired

foldersPermission

Show child attributes

action_createbooleanrequired

action_readbooleanrequired

action_updatebooleanrequired

action_deletebooleanrequired

mediaPermission

Show child attributes

action_createbooleanrequired

action_readbooleanrequired

action_updatebooleanrequired

action_deletebooleanrequired

organizationsPermissionrequired

Show child attributes

action_createbooleanrequired

action_readbooleanrequired

action_updatebooleanrequired

action_deletebooleanrequired

coursechaptersPermissionrequired

Show child attributes

action_createbooleanrequired

action_readbooleanrequired

action_updatebooleanrequired

action_deletebooleanrequired

activitiesPermissionrequired

Show child attributes

action_createbooleanrequired

action_readbooleanrequired

action_updatebooleanrequired

action_deletebooleanrequired

assignmentsPermission

Show child attributes

action_createbooleanrequired

action_readbooleanrequired

action_updatebooleanrequired

action_deletebooleanrequired

rolesPermissionrequired

Show child attributes

action_createbooleanrequired

action_readbooleanrequired

action_updatebooleanrequired

action_deletebooleanrequired

dashboardDashboardPermissionrequired

Show child attributes

action_accessbooleanrequired

communitiesPermissionrequired

Show child attributes

action_createbooleanrequired

action_readbooleanrequired

action_updatebooleanrequired

action_deletebooleanrequired

discussionsPermissionsWithOwnrequired

Show child attributes

action_createbooleanrequired

action_readbooleanrequired

action_read_ownbooleanrequired

action_updatebooleanrequired

action_update_ownbooleanrequired

action_deletebooleanrequired

action_delete_ownbooleanrequired

podcastsPermissionsWithOwnrequired

Show child attributes

action_createbooleanrequired

action_readbooleanrequired

action_read_ownbooleanrequired

action_updatebooleanrequired

action_update_ownbooleanrequired

action_deletebooleanrequired

action_delete_ownbooleanrequired

boardsPermissionsWithOwn

Show child attributes

action_createbooleanrequired

action_readbooleanrequired

action_read_ownbooleanrequired

action_updatebooleanrequired

action_update_ownbooleanrequired

action_deletebooleanrequired

action_delete_ownbooleanrequired

playgroundsPermissionsWithOwn

Show child attributes

action_createbooleanrequired

action_readbooleanrequired

action_read_ownbooleanrequired

action_updatebooleanrequired

action_update_ownbooleanrequired

action_deletebooleanrequired

action_delete_ownbooleanrequired

created_by_user_idintegerrequired

creation_datestringrequired

expires_atstring | null

Error responses

401 Authentication required
422 Validation Error: HTTPValidationError
429 Rate limit exceeded for token regeneration

Request

Response

{
  "token": "string",
  "token_uuid": "string",
  "name": "Example name",
  "description": "An example description",
  "token_prefix": "string",
  "org_id": 1,
  "rights": {
    "courses": {
      "action_create": false,
      "action_read": false,
      "action_read_own": false,
      "action_update": false,
      "action_update_own": false,
      "action_delete": false,
      "action_delete_own": false
    },
    "users": {
      "action_create": false,
      "action_read": false,
      "action_update": false,
      "action_delete": false
    },
    "usergroups": {
      "action_create": false,
      "action_read": false,
      "action_update": false,
      "action_delete": false
    },
    "folders": {
      "action_create": false,
      "action_read": false,
      "action_update": false,
      "action_delete": false
    },
    "media": {
      "action_create": false,
      "action_read": false,
      "action_update": false,
      "action_delete": false
    },
    "organizations": {
      "action_create": false,
      "action_read": false,
      "action_update": false,
      "action_delete": false
    },
    "coursechapters": {
      "action_create": false,
      "action_read": false,
      "action_update": false,
      "action_delete": false
    },
    "activities": {
      "action_create": false,
      "action_read": false,
      "action_update": false,
      "action_delete": false
    },
    "assignments": {
      "action_create": false,
      "action_read": false,
      "action_update": false,
      "action_delete": false
    },
    "roles": {
      "action_create": false,
      "action_read": false,
      "action_update": false,
      "action_delete": false
    },
    "dashboard": {
      "action_access": false
    },
    "communities": {
      "action_create": false,
      "action_read": false,
      "action_update": false,
      "action_delete": false
    },
    "discussions": {
      "action_create": false,
      "action_read": false,
      "action_read_own": false,
      "action_update": false,
      "action_update_own": false,
      "action_delete": false,
      "action_delete_own": false
    },
    "podcasts": {
      "action_create": false,
      "action_read": false,
      "action_read_own": false,
      "action_update": false,
      "action_update_own": false,
      "action_delete": false,
      "action_delete_own": false
    },
    "boards": {
      "action_create": false,
      "action_read": false,
      "action_read_own": false,
      "action_update": false,
      "action_update_own": false,
      "action_delete": false,
      "action_delete_own": false
    },
    "playgrounds": {
      "action_create": false,
      "action_read": false,
      "action_read_own": false,
      "action_update": false,
      "action_update_own": false,
      "action_delete": false,
      "action_delete_own": false
    }
  },
  "created_by_user_id": 1,
  "creation_date": "string",
  "expires_at": "string"
}