Skip to content
Last updated

Team APIs

The Team APIs allow querying of the data for a Celonis Platform team, such as the list of members assigned to the team, the login history for members of this team, or the current connection status of an uplink server.

Note

All Team operations are scoped to a Celonis Platform team.

Base URLs

The base URLs for the Team APIs are:

  • Members API: https://your-team.celonis.cloud/api/external/members
  • Login History API: https://your-team.celonis.cloud/api/external/authentication-events
  • Uplink Registration API: https://your-team.celonis.cloud/api/uplink-registration

Replace your-team with the name of your Celonis instance to access the Team APIs.

Use Cases

The Team APIs can be used to:

  • Connect external monitoring tools, such as SIEM tools, to capture and monitor platform login events.
  • Viewing and analyze your login history with an external tool to monitor team usage or identify potential security issues.
  • Query and export a list of all members currently assigned to a Celonis Platform team.
  • Monitor uplink server connectivity for your assigned teams, including the current connection status.

Authentication

This API supports multiple methods of authentication:

  • (recommended method) Via OAuth 2.0 token with a team.user-group-info, team.login-history or team.uplink-integration:read scope, passed in an HTTP header like this: Authorization: Bearer TOKEN.
  • Via Application keys passed in an HTTP header like this: Authorization: AppKey APPLICATION_KEY.
  • Via API keys, passed in an HTTP header like this: Authorization: Bearer API_KEY.
Important

Support for the Application Key and API Key methods is being discontinued. Sunsetting milestones will be officially announced.

See this help page for more information about OAuth 2.0.