Connections Auth API

The Auth API from Connections — 5 operation(s) for auth.

GitHub OpenAPI

Operations 5

POST /auth/session Change a signed-in member's account setting (preferred sign-in method, profile… #
POST /auth/me/default Pin this browser's default account (the account the sign-in chooser lands on) #
GET /auth/introspect Introspect the active developer credential #
GET /v1/auth/login Start the AEGIS OAuth dance (PKCE); 302 to Accounts #
POST /v1/auth/logout Clear the session #

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.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/connections-icu:connections-icu-auth-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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

connections-icu-auth-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Connections Icu Auth API
  version: 1.0.0
  description: 'Operations tagged Auth across 6 of this provider''s published API definitions: connections-icu-accounts-openapi-original.json, connections-icu-product-openapi-original.json, connections-icu-studio-openapi-original.json, connections-icu-accounts-openapi.yml, connections-icu-product-openapi.yml, connections-icu-studio-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://accounts.connectionsapi.com
- url: https://api.connectionsapi.com/v1
- url: https://studio.connectionsapi.com
tags:
- name: Auth
paths:
  /auth/session:
    post:
      operationId: accounts_update_my_account_settings
      summary: Change a signed-in member's account setting (preferred sign-in method, profile…
      description: 'Requires the member''s AEGIS bearer. One action-multiplexed door: send `action` plus that action''s fields. `update_primary_sign_in_method` records which way the account prefers to sign in. `update_profile_card` patches who sees each profile field (a partial update: only the named fields change). `set_app_relay` turns privacy-relay email forwarding on or off for one connected app. Each action rules on its own input and answers 400 for a value it does not support.'
      security:
      - BearerAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                action:
                  type: string
                  enum:
                  - update_primary_sign_in_method
                  - update_profile_card
                  - set_app_relay
                primarySignInMethod:
                  type: string
                  enum:
                  - passkey
                  - password
                  - email_otp
                  - sms_otp
                  description: 'update_primary_sign_in_method: the way this account prefers to sign in.'
                  x-setting:
                    id: accounts.preferred_sign_in_method
                    label: Preferred sign-in method
                    synonyms:
                    - sign in with passkey
                    - default login method
                    - login preference
                    - use password to sign in
                    scope: account
                    group: Security & sign-in
                    action: update_primary_sign_in_method
                visibility:
                  type: object
                  description: 'update_profile_card: a partial patch, one or more profile fields mapped to who may see them.'
                  properties:
                    photo:
                      type: string
                      enum:
                      - everywhere
                      - dating
                      - deals
                      - hidden
                    about:
                      type: string
                      enum:
                      - everywhere
                      - dating
                      - deals
                      - hidden
                    headline:
                      type: string
                      enum:
                      - everywhere
                      - dating
                      - deals
                      - hidden
                    city:
                      type: string
                      enum:
                      - everywhere
                      - dating
                      - deals
                      - hidden
                  additionalProperties: false
                  x-setting:
                    id: accounts.profile_field_visibility
                    label: Who can see my profile details
                    synonyms:
                    - profile privacy
                    - hide my photo
                    - hide my city
                    - who sees my headline
                    scope: account
                    group: Personal info
                    action: update_profile_card
                clientId:
                  type: string
                  description: 'set_app_relay: the OAuth client id of the connected app.'
                enabled:
                  type: boolean
                  description: 'set_app_relay: true forwards that app''s email to the member, false stops it.'
                  x-setting:
                    id: accounts.connected_app_email_forwarding
                    label: Connected app email forwarding
                    synonyms:
                    - app email relay
                    - stop app emails
                    - hide my email from app
                    - forward app email
                    scope: account
                    group: Connected apps
                    action: set_app_relay
                    scopeParam: clientId
              required:
              - action
      responses:
        '200':
          description: The action's result.
        '400':
          description: '{ error } - the action rejected its input; the sentence says which.'
        '401':
          description: Missing or invalid bearer.
      tags:
      - Auth
    servers:
    - url: https://accounts.connectionsapi.com
  /auth/me/default:
    post:
      operationId: accounts_set_default_account
      summary: Pin this browser's default account (the account the sign-in chooser lands on)
      description: Requires this browser's device credential. Upserts the device's default account to the one named by `switchToken`, an account already signed in on this device.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                switchToken:
                  type: string
                  description: The switchToken of the signed-in account to land on by default.
                  x-setting:
                    id: accounts.default_account
                    label: Default account on this browser
                    synonyms:
                    - pinned account
                    - default login
                    - which account opens first
                    - account chooser default
                    scope: device
                    group: Sign-in account chooser
              required:
              - switchToken
      responses:
        '200':
          description: The default account is pinned.
        '400':
          description: '{ error } - switchToken required.'
        '401':
          description: No valid device credential.
      tags:
      - Auth
    servers:
    - url: https://accounts.connectionsapi.com
  /auth/introspect:
    get:
      summary: Introspect the active developer credential
      description: Returns the credential type, owner/actor profile IDs, scopes, capabilities (allowed paths and methods), documentation URLs, accepted auth headers, and developer rules. Call this first to discover what the credential can do without trying each route.
      responses:
        '200':
          description: Credential introspection document.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IntrospectionResponse'
        '401':
          description: Missing or invalid credential.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      tags:
      - Auth
      security:
      - ApiKey: []
      - OAuth2: []
      operationId: getAuthIntrospect
      x-operation-id-source: derived
    servers:
    - url: https://api.connectionsapi.com/v1
  /v1/auth/login:
    get:
      summary: Start the AEGIS OAuth dance (PKCE); 302 to Accounts
      security: []
      tags:
      - Auth
      operationId: getV1AuthLogin
      x-operation-id-source: derived
    servers:
    - url: https://studio.connectionsapi.com
  /v1/auth/logout:
    post:
      summary: Clear the session
      security:
      - aegisBearer: []
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties: {}
              description: No fields - the path and your credential are the entire input.
      tags:
      - Auth
      operationId: postV1AuthLogout
      x-operation-id-source: derived
    servers:
    - url: https://studio.connectionsapi.com
components:
  schemas:
    IntrospectionResponse:
      type: object
      description: Result of GET /v1/auth/introspect. Describes the current credential, the scopes it carries, and the capabilities (paths + methods) it can call. Agents should call this once before issuing other API calls.
      required:
      - schemaVersion
      - status
      - credentialType
      - scopes
      - capabilities
      - docs
      - auth
      - rules
      properties:
        schemaVersion:
          type: string
        status:
          type: string
          enum:
          - active
        credentialType:
          type: string
          enum:
          - api_key
          - oauth_token
          - user_session
        actorProfileId:
          type:
          - string
          - 'null'
        ownerProfileId:
          type:
          - string
          - 'null'
        scopes:
          type: array
          items:
            type: string
        capabilities:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
              title:
                type: string
              summary:
                type: string
              requiredScopes:
                type: array
                items:
                  type: string
              methods:
                type: array
                items:
                  type: string
              paths:
                type: array
                items:
                  type: string
        docs:
          type: object
          properties:
            humanUrl:
              type: string
            openApiUrl:
              type: string
            introspectUrl:
              type: string
        auth:
          type: object
          properties:
            acceptedHeaders:
              type: array
              items:
                type: string
        rules:
          type: array
          items:
            type: string
    ErrorResponse:
      type: object
      description: Standard error payload returned by the Connections Developer API.
      required:
      - error
      properties:
        error:
          type: string
  securitySchemes:
    memberSession:
      type: http
      scheme: bearer
      description: The member's Connections session access token, exactly as this product's app sends it. Only operations that declare this scheme accept one.
      x-connections-credential: member-session
    cnxKey:
      type: http
      scheme: bearer
      description: A cnx_live_ key minted in Studio. It acts as the member who minted it, within its scopes.
      x-connections-credential: connections-key
    BearerAuth:
      type: http
      scheme: bearer
      description: 'The member''s AEGIS session access token - the same bearer every other accounts.connections member route accepts (Authorization: Bearer <token>). Only the three member twins (profile, addresses, time zone) also take a scoped cnx_live_ key, under the cnxKey scheme.'
      x-connections-credential: member-session
    ApiKey:
      type: http
      scheme: bearer
      description: A Connections admin's API key or session token, for the Sue reaper's identity read only.
      x-connections-credential: connections-key
    OAuth2:
      type: http
      scheme: bearer
      description: Connections OAuth access token.
      x-connections-credential: oauth-access-token
    aegisBearer:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: The AEGIS SSO access token (Cognito JWT from the shared sign-in) presented as a Bearer on every /v1 call.
    apiKey:
      type: http
      scheme: bearer
      bearerFormat: cnx_live_* | cnx_pub_*
      description: 'A key minted in the console, sent as a bearer token. `cnx_live_` carries cross-plane data scopes AND (when granted) Studio management scopes (apps:*, keys:*, projects:*, webhooks:*) that authorize the console-management operations below. `cnx_pub_` is the publishable, browser-safe tier (Stripe''s pk_ model): mint-time capped to :read scopes, requires a non-empty allowed-origins allowlist, refused on any non-GET/HEAD route, and rate-limited - safe to embed in client-side code.'
    oauthUserToken:
      type: http
      scheme: bearer
      description: EITHER (a) a Sign-in-with-Connections USER access token issued by accounts.connectionsapi.com to a registered OAuth app - the app acts on behalf of its signed-in user, rows are keyed by the token's own sub + client_id; OR (b) an app-bound publishable key (cnx_pub_, minted with an appId) presented on X-Connections-Api-Key ALONGSIDE the signed-in user's own plain AEGIS bearer on Authorization - the server derives (app_id, sub) from the two verified credentials. The publishable key alone authorizes nothing; both credentials are required. This second form is for a developer who wants the locker without standing up a full OAuth client - mint one publishable key bound to a registered app instead.
x-refined-from:
- connections-icu-accounts-openapi-original.json
- connections-icu-product-openapi-original.json
- connections-icu-studio-openapi-original.json
- connections-icu-accounts-openapi.yml
- connections-icu-product-openapi.yml
- connections-icu-studio-openapi.yml