YottaBot Platform

YottaBot's apps are built on APIs, and these pages document the ones your organization's administrators can call: what each endpoint does, the permission it needs, what to send and what comes back.

The APIs

API What it covers
Identity Users, groups, roles, policies and role assignments; your accounts; the audit record

More apps' APIs follow.

How a call works

  • Your company's address. Calls go to your company's own address, https://<company>.yotta.bot, the one you sign in at.
  • A token. Each call carries Authorization: Bearer <token>. See Authentication.
  • Permissions. Each endpoint needs one permission, such as identity:CreateUser, from the roles you hold. You can call only what you could do in the app.
  • Two-factor for changes. A call that changes something needs a sign-in that used a second factor.
  • JSON. Requests and responses are JSON. Errors are a JSON object with an error message; see Errors.

What isn't in the API

Some changes stay in the Identity app on purpose: each one changes how everyone signs in, creates credentials, or affects billing, so it should be made by a person looking at it, with a second factor:

  • Sign-in policy, authenticators, session lengths and networks
  • Domains, identity providers and SCIM
  • Resetting someone's two-factor
  • Seats and account requests