Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/openweb:openweb-sso-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Single Sign On SSO API
version: '1.0'
description: OpenWeb’s single sign-on (SSO) process allows using your existing identity management solutions with OpenWeb products.
servers:
- url: https://www.spot.im/api
tags:
- name: SSO
description: SSO-related calls
paths:
/sso/v1/register-user:
parameters: []
get:
summary: Configure additional user settings
tags:
- SSO
responses:
'200':
$ref: '#/components/responses/code_b'
parameters:
- $ref: '#/components/parameters/access_token'
- $ref: '#/components/parameters/code_a'
- $ref: '#/components/parameters/display_name'
- $ref: '#/components/parameters/primary_key'
- $ref: '#/components/parameters/user_name'
- $ref: '#/components/parameters/Content-Type'
- $ref: '#/components/parameters/email'
- $ref: '#/components/parameters/email_verified'
- $ref: '#/components/parameters/image_url'
- $ref: '#/components/parameters/location'
- $ref: '#/components/parameters/private_profile'
- $ref: '#/components/parameters/user_metadata'
requestBody:
$ref: '#/components/requestBodies/AdditionalUserSettings'
description: Adds more information to the user, such as bio, notification settings, and email
operationId: getSsoV1RegisterUser
x-operation-id-source: derived
/sso/v1/update-user:
get:
summary: Update user details
tags:
- SSO
responses:
'200':
$ref: '#/components/responses/UserDetails'
description: Updates the OpenWeb user data of an existing SSO user
parameters:
- $ref: '#/components/parameters/x-spotim-sso-access-token'
- $ref: '#/components/parameters/primary_key'
- $ref: '#/components/parameters/user_name'
- $ref: '#/components/parameters/display_name_nonreq'
- $ref: '#/components/parameters/email'
- $ref: '#/components/parameters/email_verified'
- $ref: '#/components/parameters/image_url'
- $ref: '#/components/parameters/location'
- $ref: '#/components/parameters/private_profile'
- $ref: '#/components/parameters/user_metadata'
requestBody:
$ref: '#/components/requestBodies/AdditionalUserSettings'
operationId: getSsoV1UpdateUser
x-operation-id-source: derived
/sso/v1/user:
post:
summary: Register a new user
responses:
'200':
description: OK
description: Registers a new user
parameters:
- $ref: '#/components/parameters/x-spotim-sso-access-token'
- $ref: '#/components/parameters/primary_key'
- $ref: '#/components/parameters/spot_id'
- $ref: '#/components/parameters/user_name'
- $ref: '#/components/parameters/display_name_nonreq'
- $ref: '#/components/parameters/email'
- $ref: '#/components/parameters/email_verified'
- $ref: '#/components/parameters/image_url'
- $ref: '#/components/parameters/location'
- $ref: '#/components/parameters/private_profile'
- $ref: '#/components/parameters/user_metadata'
requestBody:
$ref: '#/components/requestBodies/AdditionalUserSettings'
tags:
- SSO
operationId: postSsoV1User
x-operation-id-source: derived
/sso/v1/user/{primary_key}:
parameters:
- schema:
type: string
name: primary_key
in: path
required: true
description: Unique user ID generated by a Partner's backend user management system
get:
summary: Retrieve user details
tags:
- SSO
responses:
'200':
$ref: '#/components/responses/UserDetails'
description: Retrieves user details
parameters:
- $ref: '#/components/parameters/x-spotim-sso-access-token'
operationId: getSsoV1UserByPrimaryKey
x-operation-id-source: derived
delete:
summary: Delete user
tags:
- SSO
responses:
'200':
description: OK
description: 'Deletes the OpenWeb user data of an existing SSO user
When requested by a user, you must delete the user’s OpenWeb account to remain GDPR compliant. Once the user has been deleted, comments by the deleted user remain and are linked to a random guest user.'
parameters:
- $ref: '#/components/parameters/x-spotim-sso-access-token'
operationId: deleteSsoV1UserByPrimaryKey
x-operation-id-source: derived
components:
schemas:
location:
type: string
description: Location of the user
primary_key:
description: Unique user ID generated by a Partner’s backend user management system
type: string
private_profile:
type: boolean
description: 'Indicates whether the user''s commenting history and profile can be viewed by others
**Possible Values**:
- `false` (default)
- `true`
'
display_name:
type: string
description: '**Non-unique** personal identifier used prominently throughout the platform
A display name has the following characteristics:
- Cannot exceed **30 characters**
- Is comprised of a combination of letters, numbers, special characters, or spaces
When not provided, OpenWeb creates a display name from the `user_name`.
'
role:
type: string
description: 'Permission level of the user
**Possible values**
- `admin`: Access to all sections of the system
- `community-moderator`: Ability to moderate comments within a Conversation, but no Admin Panel access
- `journalist`: Ability to select top comments, but no Admin Panel access
- `moderator`: Access only to the moderation section
- `registered`: Regular user with no assigned role (This is the default permission that is set when no role is specified.)
- `viewer`: View-only access to the moderation section
This property can be passed with or without the `bio` or `settings` object.'
enum:
- admin
- community-moderator
- journalist
- moderator
- registered
- viewer
image_url:
type: string
description: 'URL of the profile image of the user
This image is the avatar used for all comments created by the user. If the `image_url` is not set, OpenWeb selects a random avatar from the avatar scheme for the user.
To delete a set user image, send an empty string for this parameter.
'
email_verified:
type: boolean
description: 'Indicates that the email of the user has been verified by the user
**Possible Values**:
- `false` (default)
- `true`
OpenWeb only sends email notifications to verified email addresses.
'
is_blocked:
title: is_blocked
type: string
description: 'Identifies if the user has permission to post comments on the site associated the spot ID
**Possible Values**:
- `false`: User has permission to post comments
- `true`: User is on the blocked and restricted from posting comments
- `null`: User’s access cannot be determined and the request should be attempted again'
settings:
type: object
description: Email and in-app notification settings
properties:
notifications:
type: object
description: Notifications
properties:
email:
type: object
properties:
liked_your_message:
type: string
description: 'When notifications are sent
**Possible Values**:
- `immediately`: Notifications are sent instantly
- `never`: Notifications are not sent'
enum:
- immediately
- never
message_approved:
type: string
description: 'When notifications are sent
**Possible Values**:
- `immediately`: Notifications are sent instantly
- `never`: Notifications are not sent'
enum:
- immediately
- never
message_rejected:
type: string
description: 'When notifications are sent
**Possible Values**:
- `immediately`: Notifications are sent instantly
- `never`: Notifications are not sent'
enum:
- immediately
- never
replied_to_message:
type: string
description: 'When notifications are sent
**Possible Values**:
- `immediately`: Notifications are sent instantly
- `never`: Notifications are not sent'
enum:
- immediately
- never
user_mentioned:
type: string
description: 'When notifications are sent
**Possible Values**:
- `immediately`: Notifications are sent instantly
- `never`: Notifications are not sent'
enum:
- immediately
- never
in_app:
type: object
properties:
liked_your_message:
type: string
description: 'When notifications are sent
**Possible Values**:
- `immediately`: Notifications are sent instantly
- `never`: Notifications are not sent'
enum:
- immediately
- never
message_approved:
type: string
description: 'When notifications are sent
**Possible Values**:
- `immediately`: Notifications are sent instantly
- `never`: Notifications are not sent'
enum:
- immediately
- never
message_rejected:
type: string
description: 'When notifications are sent
**Possible Values**:
- `immediately`: Notifications are sent instantly
- `never`: Notifications are not sent'
enum:
- immediately
- never
replied_to_message:
type: string
description: 'When notifications are sent
**Possible Values**:
- `immediately`: Notifications are sent instantly
- `never`: Notifications are not sent'
enum:
- immediately
- never
user_mentioned:
type: string
description: 'When notifications are sent
**Possible Values**:
- `immediately`: Notifications are sent instantly
- `never`: Notifications are not sent'
enum:
- immediately
- never
user_name:
type: string
description: 'Unique personal identifier used to differentiate between different users
A username has the following characteristics:
- Is **greater than 3 characters**, but **less than 30 characters**
- Can be comprised of foreign-language characters
- **Cannot** be comprised of delimiters, such as spaces, tabs, and other ASCII delimiters (`/t`, `/r`, and `/n`)
- **Cannot** be comprised of special characters, such as `<` and `>`
- Is preceded by the `@` symbol when displayed
If a username is **already taken**, OpenWeb appends random letters or numbers to generate a unique version of that username and registers it to the user.
If a username is **not provided**, OpenWeb creates a username from the `display_name`, appends random letters or numbers to generate a unique version of that username, and registers it to the user.
'
bio:
type: string
description: 'User bio
When configuring a user bio, the bio cannot exceed 200 characters.
This property can be passed with or without the `role` or `settings` object.'
email:
type: string
description: Email of the user
user_metadata:
title: user_metadata
type: object
properties:
is_subscriber:
type: boolean
description: Indicates if the user is a subscriber or not and enables the segmentation of data by subscribers and non-subscribers
parameters:
spot_id:
name: spot_id
in: query
required: true
schema:
type: string
description: Unique OpenWeb identifier
user_metadata:
name: user_metadata
in: query
required: false
schema:
type: string
description: "Indicates if the user is a subscriber or not and enables the segmentation of data by subscribers and non-subscribers\n\nIf a user's subscriber status changes, you must <a href=\"https://developers.openweb.com/docs/implement-single-sign-on#log-out-a-user\" target=\"_blank\">log out the user</a> and complete a new SSO flow. This ensures that a user's previous cached client state for `user_metadata.is_subscriber` is not used.\n\n**Possible Values** *(values must be Base64-encoded)*:\n\n```json\n{\n \"is_subscriber\": true\n}\n```\nWhen this value is passed for a user, you can also show a customized subscriber badge next to the user's name in the Conversation. Please contact Support to enable and customize the subscriber badge.\n\n<hr />\n\n```json\n{\n \"is_subscriber\": false\n}\n```\n"
display_name:
name: display_name
in: query
required: true
schema:
type: string
description: '**Non-unique** personal identifier used prominently throughout the platform
A display name has the following characteristics:
- Cannot exceed **30 characters**
- Is comprised of a combination of letters, numbers, special characters, or spaces
When not provided, OpenWeb creates a display name from the `user_name`.
If neither a username nor a display name is provided, the handshake will fail.
'
email:
name: email
in: query
required: false
schema:
type: string
description: Email of the user
display_name_nonreq:
name: display_name
in: query
required: false
schema:
type: string
description: '**Non-unique** personal identifier used prominently throughout the platform
A display name has the following characteristics:
- Cannot exceed **30 characters**
- Is comprised of a combination of letters, numbers, special characters, or spaces
When not provided, OpenWeb creates a display name from the `user_name`.
'
access_token:
name: access_token
in: query
required: true
schema:
type: string
description: Secret access token provide by OpenWeb
email_verified:
name: email_verified
in: query
required: false
schema:
type: boolean
description: 'Indicates that the email of the user has been verified by the user
**Possible Values**:
- `false` (default)
- `true`
OpenWeb only sends email notifications to verified email addresses.
'
x-spotim-sso-access-token:
name: x-spotim-sso-access-token
in: header
required: true
schema:
type: string
description: Secret access token provide by OpenWeb
code_a:
name: code_a
in: query
required: true
schema:
type: string
description: Session ID returned after initiating an SSO session
image_url:
name: image_url
in: query
required: false
schema:
type: string
description: 'URL of the profile image of the user
This image is the avatar used for all comments created by the user. If the `image_url` is not set, OpenWeb selects a random avatar from the avatar scheme for the user.
To delete a set user image, send an empty string for this parameter.
'
primary_key:
name: primary_key
in: query
schema:
type: string
description: Unique user ID generated by a Partner’s backend user management system
required: true
private_profile:
name: private_profile
in: query
required: false
schema:
type: boolean
description: 'Indicates whether the user''s commenting history and profile can be viewed by others
**Possible Values**:
- `false` (default)
- `true`
'
Content-Type:
name: Content-Type
in: header
required: true
schema:
type: string
enum:
- application/json
description: Enables sending a JSON body with the request
user_name:
name: user_name
in: query
required: true
schema:
type: string
description: 'Unique personal identifier used to differentiate between different users
A username has the following characteristics:
- Is **greater than 3 characters**, but **less than 30 characters**
- Can be comprised of foreign-language characters
- **Cannot** be comprised of delimiters, such as spaces, tabs, and other ASCII delimiters (`/t`, `/r`, and `/n`)
- **Cannot** be comprised of special characters, such as `<` and `>`
- Is preceded by the `@` symbol when displayed
If a username is **already taken**, OpenWeb appends random letters or numbers to generate a unique version of that username and registers it to the user.
If a username is **not provided**, OpenWeb creates a username from the `display_name`, appends random letters or numbers to generate a unique version of that username, and registers it to the user.
If neither a username nor a display name is provided, the handshake will fail.
'
location:
name: location
in: query
required: false
schema:
type: string
description: Location of the user
responses:
UserDetails:
description: ''
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
user:
type: object
properties:
bio:
$ref: '#/components/schemas/bio'
display_name:
$ref: '#/components/schemas/display_name'
email:
$ref: '#/components/schemas/email'
email_verified:
$ref: '#/components/schemas/email_verified'
image_url:
$ref: '#/components/schemas/image_url'
is_blocked:
$ref: '#/components/schemas/is_blocked'
location:
$ref: '#/components/schemas/location'
primary_key:
$ref: '#/components/schemas/primary_key'
private_profile:
$ref: '#/components/schemas/private_profile'
role:
$ref: '#/components/schemas/role'
spotim_user_id:
type: string
user_metadata:
$ref: '#/components/schemas/user_metadata'
user_name:
$ref: '#/components/schemas/user_name'
settings:
$ref: '#/components/schemas/settings'
code_b:
description: ''
content:
application/json:
schema:
type: string
description: Success response returned after OpenWeb logs in the user
requestBodies:
AdditionalUserSettings:
content:
application/json:
schema:
type: object
properties:
bio:
$ref: '#/components/schemas/bio'
role:
$ref: '#/components/schemas/role'
settings:
$ref: '#/components/schemas/settings'
x-provenance:
method: searched
source: https://developers.openweb.com/reference
harvested: '2026-10-14'
tool: harvest-readme-openapi.py
note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
assembled_from:
- https://developers.openweb.com/reference/delete_sso-v1-user-primary-key.md
- https://developers.openweb.com/reference/get_sso-v1-register-user.md
- https://developers.openweb.com/reference/get_sso-v1-update-user.md
- https://developers.openweb.com/reference/get_sso-v1-user-primary-key.md
- https://developers.openweb.com/reference/post_sso-v1-user.md
merge:
pages: 5
deduped: 43
conflicts_kept_first: 0