ScrumAlliance API
Welcome to the Scrum Alliance API documentation. This API is designed to provide a seamless experience for developers and partners to integrate with Scrum Alliance services.
URL Structure
The base URL for all API calls is https://www.scrumalliance.org.
All API URL paths start with /api.
After this, there is a domain namespace, in singular form. This may be /identity (member related) or /learning (learning related), or others.
After this, resources start in typical REST naming conventions. All resources are plural and can be nested, i.e. /courses/1234/members/5678.
Authentication
Scrum Alliance offers one form of authentication:
- OAuth2: an open protocol to allow secure authorization in a simple and standard method from web, mobile and desktop applications.
You will be provided with a client ID and client secret. You can use these credentials to obtain a JWT Bearer token. See "Auth" endpoints for more details on how to obtain this token.
Authorization
The API uses role-based access control (RBAC) to manage permissions. Each endpoint is protected by specific scopes that determine the level of access granted. The documentation for each endpoint will specify the required scopes.
Authentication
- API Key: Bearer
Bearer tokens are obtained through the /api/identity/tokens route and are a JWT. Enter 'Bearer' [space] and then your authorization token into the Authorization header. Example: 'Bearer 12345abcdef'
Security Scheme Type: | apiKey |
|---|---|
Header parameter name: | Authorization |