Version: 8.1.0
Teneo Manager API Specification
Authentication
- HTTP: Bearer Auth
Security Scheme Type: | http |
|---|---|
HTTP Authorization Scheme: | bearer |
API Endpoints
admin
| Method | Path | Description |
|---|---|---|
post | /admin/settings/delegated/idp-metadata/convert-to-settings | Convert IdP metadata XML file into settings. |
get | /admin/settings/delegated/sp-metadata/export | Export delegated SP metadata XML. |
get | /admin/task/result | Retrieve last execution result for a given task. |
get | /admin/settings | Returns the list of settings used by Teneo Manager. |
get | /admin/statistics | Gets statistics data. |
post | /admin/task/begin | Triggers task according task type passed in post params. |
post | /admin/settings/ldap/test-connection | Test LDAP connection. |
put | /admin/settings/apply-and-restart | Updates the list of Teneo Manager settings and restarts. It revokes all access and refresh tokens, forcibly logging out all users and clients. |
post | /admin/settings/validate | Validate a list of settings. Returns a list of error messages, if any. |
auth
| Method | Path | Description |
|---|---|---|
get | /auth/me | Returns the user information for the current access_token. |
post | /auth/login | Logs-in a user and returns an access_token. |
post | /auth/logout | Logs-out a user invalidating the access_token. |
common
| Method | Path | Description |
|---|---|---|
post | /common/log-archives/import/begin/{logArchiveId} | Starts log archive import. |
post | /common/log-archives/import/cancel/{logArchiveId} | Stops log archive import. |
delete | /common/log-archives/import/errors/{logArchiveId} | Clear log archive import errors. |
post | /common/groups | Creates a group with the given data. |
post | /common/ldss/{ldsId}/group-access-roles/{groupId} | Creates new access roles for the specified group. |
post | /common/ldss/{ldsId}/user-access-roles/{userId} | Creates new access roles for the specified user. |
post | /common/ldss | Creates an Log Data Source with the given data. |
post | /common/log-archives | Creates a Log Archive with the given data. |
post | /common/users | Creates a user with the given data. |
delete | /common/groups/{groupId} | Deletes the specified group. |
delete | /common/ldss/{ldsId}/group-access-roles/{groupId} | Deletes the specified group's access roles. |
delete | /common/ldss/{ldsId}/user-access-roles/{userId} | Deletes the specified user's access roles. |
delete | /common/ldss/{ldsId} | Deletes the specified Log Data Source. |
delete | /common/log-archives/{logArchiveId} | Deletes the specified Log Archive. |
delete | /common/users/{userId} | Deletes the specified user. |
get | /common/log-archives/import/errors/{logArchiveId}/{sessionId} | Download single log archive error file. |
get | /common/ldss/{ldsId}/final-user-access-roles | Gets a list of access roles on the specified Log Data Source (for the used access token). |
get | /common/groups/indirect-users/{groupId} | Gets indirect users of the group. |
get | /common/groups/users/{groupId} | Gets all users of the group. |
get | /common/groups/{groupId} | Gets the specified group (for the used access token). |
get | /common/groups | Gets the list of groups (for the used access token). |
get | /common/ldss/{ldsId}/group-access-roles/{groupId} | Gets the group's access roles for the specified Log Data Source and group (for the used access token). |
get | /common/groups/lds-access-roles/{groupId} | Gets the list of Log Data Sources access roles for the specified group |
get | /common/ldss/{ldsId}/group-access-roles | Gets the list of group access roles for the specified Log Data Source (for the used access token). |
get | /common/ldss/{ldsId}/user-access-roles/{userId} | Gets the specified user's access roles for the specified Log Data Source. |
get | /common/ldss/user-access-roles-overview/{ldsId} | Gets users access roles for the specified lds. |
get | /common/users/lds-access-roles-overview/{userId} | Gets the list of Log Data Sources access roles for the specified user. |
get | /common/users/lds-access-roles/{userId} | Gets the list of user access roles for the specified Log Data Source (for the used access token). |
get | /common/ldss/{ldsId}/user-access-roles | Gets the list of user access roles for the specified Log Data Source (for the used access token). |
get | /common/ldss/{ldsId} | Gets the specified Log Data Source's information (for the used access token). |
get | /common/ldss | Gets the list of Log Data Sources (for the used access token). |
get | /common/log-archives/import/errors/{logArchiveId} | Get log archive errors for a given log archive id. |
get | /common/log-archives/import/status/{logArchiveId} | Get log archive import status. |
get | /common/log-archives/overview/{logArchiveId} | Get log archive overview information table. |
get | /common/log-archives/{logArchiveId} | Gets the specified Log Archive's information (for the used access token). |
get | /common/log-archives | Gets the list of Log Archives (for the used access token). |
get | /common/groups/studio-account-permissions/{groupId} | Gets direct group permissions on studio accounts. |
get | /common/users/studio-account-permissions-overview/{userId} | Gets studio account user permissions (direct and indirect). |
get | /common/users/studio-account-permissions/{userId} | Gets direct user permissions on studio accounts. |
get | /common/user-info | Gets the information for the specified user (for the used access token). |
get | /common/users/{userId} | Gets user information (for the used access token). |
get | /common/users | Gets the list of users. |
put | /common/user-password/{userId} | Resets the user password for the specified user Id and password data. |
put | /common/groups/users/{groupId} | Update users of the group. |
put | /common/groups/{groupId} | Updates the specified group with the given data. |
put | /common/ldss/{ldsId}/group-access-roles/{groupId} | Updates an Log Data Source group's access roles with the given data. |
put | /common/ldss/{ldsId}/user-access-roles/{userId} | Updates an Log Data Source user's access roles with the given data. |
put | /common/ldss/{ldsId} | Updates the specified Log Data Source with the given data. |
put | /common/log-archives/{logArchiveId} | Updates the specified Log Archive with the given data. |
put | /common/users/{userId} | Updates the specified user with the given data. |
documentation
| Method | Path | Description |
|---|---|---|
get | /documentation/url | Gets the documentation URL. |
inquire
| Method | Path | Description |
|---|---|---|
get | /inquire/settings | Gets the settings to be used by the Inquire client (for the used access token). |
oauth2
| Method | Path | Description |
|---|---|---|
post | /oauth2/clients/studio/admin/maintenance/daily/begin/{clientId} | Starts the daily maintenance task on the specified studio client. |
post | /oauth2/clients/studio/admin/maintenance/hourly/begin/{clientId} | Starts the hourly maintenance task on the specified studio client. |
post | /oauth2/api-tokens | Creates a new API token. |
post | /oauth2/clients | Creates a client with the given data. |
get | /oauth2/delegated/notification | Delegated login process notification endpoint. |
delete | /oauth2/api-tokens/{apiTokenId} | Deletes the specified API token. |
delete | /oauth2/clients/{clientId} | Deletes the specified client. |
get | /oauth2/access-tokens | Gets a list of active access tokens. |
get | /oauth2/api-tokens/{apiTokenId} | Gets the specified API token. |
get | /oauth2/api-tokens | Gets the list of API tokens. |
get | /oauth2/clients/types | Gets the list of clients. |
get | /oauth2/clients/{clientId} | Gets the specified client (for the used access token). |
get | /oauth2/clients | Gets the list of clients (for the used access token). |
get | /oauth2/delegated/saml2/metadata | Returns the SAML2 SP metadata information if delegated authentication is configured. |
get | /oauth2/refresh-tokens | Gets the list of refresh tokens. |
get | /oauth2/delegated/start-login-url | Gets the URL to start the delegated login process (for the given access token). |
get | /oauth2/clients/studio/admin/maintenance/daily/status/{clientId} | Returns the daily maintenance task status and last result for the specified studio client. |
get | /oauth2/clients/studio/admin/maintenance/hourly/status/{clientId} | Returns the hourly maintenance task status and last result for the specified studio client. |
get | /oauth2/token-info | Gets information about the used token. |
get | /oauth2/tokens/types | Gets the list of token types. |
post | /oauth2/revoke | Revokes OAuth2 tokens. |
post | /oauth2/token | Main endpoint to obtain OAuth2 tokens. |
put | /oauth2/api-tokens/{apiTokenId} | Updates the specified API token. |
put | /oauth2/clients/{clientId} | Updates the specified client with the given data. |
studio
| Method | Path | Description |
|---|---|---|
post | /studio/accounts/{accountId}/group-permissions/{groupId} | Creates new permissions for the specified group. |
post | /studio/accounts/settings/map/{accountId} | Create a new settings map for the specified account. |
post | /studio/accounts/{accountId}/user-permissions/{userId} | Creates new permissions for the specified user. |
post | /studio/accounts | Creates an account with the given data. |
delete | /studio/accounts/{accountId}/group-permissions/{groupId} | Deletes the specified group's permissions. |
delete | /studio/accounts/settings/map/{accountId}/{settingsMapId} | Deletes the provided settings map for the specified account. |
delete | /studio/accounts/{accountId}/user-permissions/{userId} | Deletes the specified user's permissions. |
delete | /studio/accounts/{accountId} | Deletes the specified account. |
get | /studio/accounts/{accountId}/group-permissions/{groupId} | Gets the group's permission for the specified account (for the used access token). |
get | /studio/accounts/{accountId}/group-permissions | Gets the list of group permissions for a specific Studio account (for the used access token). |
get | /studio/accounts/{accountId}/ldss | Gets an account's linked Log Data Source (for the used access token). |
get | /studio/accounts/{accountId}/log-archives | Gets an account's linked Log Archive (for the used access token). |
get | /studio/accounts/settings/map/{accountId} | Gets all the settings maps of a specified account. |
get | /studio/accounts/settings/{accountId} | Gets the settings of a specified account. |
get | /studio/accounts/user-account-permissions-overview/{accountId} | Gets users permissions (direct and indirect) for the specified account. |
get | /studio/accounts/{accountId}/user-permissions/{userId} | Gets a specific user's information (for the used access token). |
get | /studio/accounts/{accountId}/user-permissions | Gets a list of user permissions for the specified Studio account (for the used access token). |
get | /studio/accounts/{accountId}/users | Gets a list of users with access to the specified account (for the used access token). |
get | /studio/accounts/{accountId} | Gets the specified account (for the used access token). |
get | /studio/accounts | Gets a list of client accounts (for the given access token). |
get | /studio/accounts/{accountId}/final-user-permissions | Gets a list of user permissions for the specified account (for the used access token). |
get | /studio/settings | Gets the settings used by the Studio client (for the used access token). |
put | /studio/accounts/{accountId}/group-permissions/{groupId} | Updates an existing group's permissions with the given data. |
put | /studio/accounts/settings/map/{accountId}/{settingsMapId} | Updates the provided settings map for the specified account. |
put | /studio/accounts/settings/{accountId} | Updates the provided settings of the specified account. |
put | /studio/accounts/{accountId}/user-permissions/{userId} | Updates an existing user's permissions with the given data. |
put | /studio/accounts/{accountId} | Updates the specified account with the given data. |