Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Tackle Users API

User management operations

Tackle Users API is one of 25 APIs that Tackle publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Users. The published artifact set on APIs.io includes an OpenAPI specification and an API reference.

This API exposes 6 operations across 2 paths, and defines 12 schemas. It is described by OpenAPI 3.0.3, at version 1.0.0.

Requests are made against a single base URL, https://api.tackle.io.

6 operations 2 paths 12 schemas 1 DELETE2 GET1 PATCH1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0.0
Base URL
https://api.tackle.io
Authentication
HTTP Bearer, HTTP Basic, API Key, OAuth 2.0
Resource Areas
1

Authentication & Security 4

Tackle Users API declares 4 security schemes for authenticating requests. It accepts HTTP bearer tokens (JWT) (BearerAuth). It accepts HTTP basic authentication (BasicAuthCallback). An API key is passed in the header as subscription-key (HeaderApiKeyAuthCallback). It supports OAuth 2.0 (Oauth2AuthCallback) using the clientCredentials flow.

  • BearerAuth — The Tackle API requires a JWT for authentication. You can get this by [getting your API credentials](https://developers.tackle.io/docs/how-to-get-an-m2m-client…
  • BasicAuthCallback — Use basic for [basic HTTP authentication](https://en.wikipedia.org/wiki/Basicaccessauthentication); this is only used for callbacks
  • HeaderApiKeyAuthCallback — Use headerapikey to specify a custom HTTP request header for authentication. Requests from Tackle will use the specified HTTP header for outbound requests to y…
  • Oauth2AuthCallback — This auth-type is for oauth2 client credentials flow. We will use the clientid and clientsecret to call the tokenurl to get an access token; this is only used…

Paths & Operations 6

Across 2 paths, the API surfaces 6 operations — 1 DELETE, 2 GET, 1 PATCH, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Users 6

User management operations

GET
/scim/v2/Users
List Users
getUsers 3 params → 200400401403500
POST
/scim/v2/Users
Create User
createUser body → 201400401403409415500
GET
/scim/v2/Users/{id}
Get User by ID
getUserById 1 param → 200400401403404500
PUT
/scim/v2/Users/{id}
Update User
updateUser 1 param body → 200400401403404500
PATCH
/scim/v2/Users/{id}
Patch User
patchUser 1 param body → 200400401403404500
DELETE
/scim/v2/Users/{id}
Delete User
deleteUser 1 param → 204400401403404500

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are User (14 properties), UserInput (12 properties), EnterpriseUser (5 properties), UserListResponse (5 properties). Each schema is shown below with its type and property counts.

Photo
object
2 properties 2 required
EnterpriseUser
object
5 properties
ScimError
object
4 properties 3 required
UserListResponse
object
5 properties 5 required
UserInput
object
12 properties 4 required
PatchOperation
object
3 properties 1 required
Email
object
3 properties 2 required
Meta
object
4 properties
Manager
object
1 property 1 required
PatchOp
object
2 properties 2 required
User
object
14 properties 4 required
Name
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

tackle-users-api-openapi.yml Raw ↑

Other APIs Tackle publishes across the network.

Tackle Authentication API
Tackle Contracts API
Tackle Currencies API
Tackle Disbursements API
Tackle Entitlements API
Tackle Groups API
Tackle Invitations API
Tackle Invoices API
Tackle Marketplace API
Tackle Metering API
Tackle Notifications API
Tackle Opportunities API