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

CMS Blue Button 2.0 UserInfo API

OpenID Connect userinfo for the authorizing beneficiary.

CMS Blue Button 2.0 UserInfo API is one of 5 APIs that CMS Blue Button 2.0 publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 1 operation across 1 path. It is described by OpenAPI 3.0.3, at version 2.0.

Requests are made against 2 base URLs: https://api.bluebutton.cms.gov/v2/fhir, https://sandbox.bluebutton.cms.gov/v2/fhir.

1 operations 1 paths 0 schemas 1 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
2.0
Base URL
https://api.bluebutton.cms.gov/v2/fhir
Authentication
OAuth 2.0
Terms of Service
Resource Areas
1

Authentication & Security 1

CMS Blue Button 2.0 UserInfo API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (oauth2) using the authorizationCode flow, exposing 6 scopes. By default, every request must be authenticated.

  • oauth2 — OAuth 2.0 authorization-code flow with mandatory PKCE (S256 only). Beneficiaries log in with their Medicare.gov credentials and choose whether to share demogra…

Paths & Operations 1

Across 1 path, the API surfaces 1 operation — 1 GET. Each is listed below with its method, path, parameters, and response codes.

UserInfo 1

OpenID Connect userinfo for the authorizing beneficiary.

GET
/connect/userinfo
Retrieve the authorizing user's OpenID Connect profile
getUserInfo → 200401

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cms-blue-button-userinfo-api-openapi.yml Raw ↑

Other APIs CMS Blue Button 2.0 publishes across the network.

CMS Blue Button 2.0 Coverage API
CMS Blue Button 2.0 ExplanationOfBenefit API
CMS Blue Button 2.0 Metadata API
CMS Blue Button 2.0 Patient API