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

Rainbow Users API

User profile and presence operations

Rainbow Users API is one of 7 APIs that Rainbow 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 API documentation.

This API exposes 3 operations across 2 paths, and defines 7 schemas. It is described by OpenAPI 3.0.3, at version 1.0.

Requests are made against a single base URL, https://openrainbow.com/api/rainbow.

3 operations 2 paths 7 schemas 1 GET2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0
Base URL
https://openrainbow.com/api/rainbow
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Rainbow Users API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (BearerAuth). By default, every request must be authenticated.

  • BearerAuth — Bearer token from OAuth2 token endpoint

Paths & Operations 3

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

Users 3

User profile and presence operations

GET
/enduser/v1.0/users/me
Get My Profile
getMyProfile → 200401
PUT
/enduser/v1.0/users/me
Update My Profile
updateMyProfile body → 200400401
PUT
/enduser/v1.0/users/me/presence
Update Presence
updatePresence body → 200401

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are UserProfile (8 properties), ErrorResponse (3 properties), Presence (3 properties), UpdateProfileRequest (3 properties). Each schema is shown below with its type and property counts.

PresenceResponse
object
1 property
UpdatePresenceRequest
object
2 properties 1 required
UserProfile
object
8 properties
UpdateProfileRequest
object
3 properties
Presence
object
3 properties
ErrorResponse
object
3 properties
UserProfileResponse
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

rainbow-users-api-openapi.yml Raw ↑

Other APIs Rainbow publishes across the network.

Rainbow Applications API
Rainbow Authentication API
Rainbow Bubbles API
Rainbow Contacts API
Rainbow Conversations API
Rainbow Messages API