How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
FusionAuth

FusionAuth Identity Provider API

The Identity Provider API from FusionAuth — 9 operation(s) for identity provider.

Documentation Provider Profile APIs.io OpenAPI GitHub

FusionAuth Identity Provider API is one of 37 APIs that FusionAuth publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Identity Provider. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 17 operations across 9 paths, and defines 92 schemas. It is described by OpenAPI 3.2.0, at version 1.66.0.

Requests are made against 2 base URLs: http://localhost:9011, https://sandbox.fusionauth.io.

17 operations 9 paths 92 schemas 2 DELETE6 GET1 PATCH7 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.66.0
Base URL
https://sandbox.fusionauth.io
Authentication
API Key, HTTP Bearer
License
Apache2
Resource Areas
1

Authentication & Security 2

FusionAuth Identity Provider API declares 2 security schemes for authenticating requests. An API key is passed in the header as Authorization (ApiKeyAuth). It accepts HTTP bearer tokens (JWT) (BearerAuth). By default, every request must be authenticated.

Paths & Operations 17

Across 9 paths, the API surfaces 17 operations — 2 DELETE, 6 GET, 1 PATCH, 7 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Identity Provider 17
POST
/api/identity-provider
Creates an identity provider. You can optionally specify an Id for the identity provider, if not provided one will be generated.
createIdentityProvider body → 200default
GET
/api/identity-provider
Retrieves one or more identity provider for the given type. For types such as Google, Facebook, Twitter and LinkedIn, only a single identity provider can exist. For types such as OpenID Connect and S…
retrieveIdentityProviderByTypeWithId 1 param → 200default
POST
/api/identity-provider/link
Link an external user from a 3rd party identity provider to a FusionAuth user.
createUserLinkWithId body → 200default
DELETE
/api/identity-provider/link
Remove an existing link that has been made from a 3rd party identity provider to a FusionAuth user.
deleteUserLinkWithId 3 params → 200default
GET
/api/identity-provider/link
Retrieve all Identity Provider users (links) for the user. Specify the optional identityProviderId to retrieve links for a particular IdP. OR Retrieve a single Identity Provider user (link).
retrieveIdentityProviderLink 3 params → 200default
GET
/api/identity-provider/link/pending/{pendingLinkId}
Retrieve a pending identity provider link. This is useful to validate a pending link and retrieve meta-data about the identity provider link.
retrievePendingLinkWithId 2 params → 200default
POST
/api/identity-provider/login
Handles login via third-parties including Social login, external OAuth and OpenID Connect, and other login systems.
identityProviderLoginWithId 1 param body → 200default
GET
/api/identity-provider/lookup
Retrieves the identity provider for the given domain and tenantId. A 200 response code indicates the domain is managed by a registered identity provider. A 404 indicates the domain is not managed. OR…
retrieveIdentityProviderLookup 2 params → 200default
POST
/api/identity-provider/search
Searches identity providers with the specified criteria and pagination.
searchIdentityProvidersWithId body → 200default
POST
/api/identity-provider/start
Begins a login request for a 3rd party login that requires user interaction such as HYPR.
startIdentityProviderLoginWithId body → 200default
GET
/api/identity-provider/test
Retrieves the results for an identity provider connection test.
retrieveIdentityProviderConnectionTestResultsWithId 1 param → 200default
POST
/api/identity-provider/test
Begins an identity provider connection test.
startIdentityProviderConnectionTestWithId body → 200default
POST
/api/identity-provider/{identityProviderId}
Creates an identity provider. You can optionally specify an Id for the identity provider, if not provided one will be generated.
createIdentityProviderWithId 1 param body → 200default
DELETE
/api/identity-provider/{identityProviderId}
Deletes the identity provider for the given Id.
deleteIdentityProviderWithId 1 param → 200default
PATCH
/api/identity-provider/{identityProviderId}
Updates, via PATCH, the identity provider with the given Id.
patchIdentityProviderWithId 1 param body → 200default
GET
/api/identity-provider/{identityProviderId}
Retrieves the identity provider for the given Id or all the identity providers if the Id is null.
retrieveIdentityProviderWithId 1 param → 200default
PUT
/api/identity-provider/{identityProviderId}
Updates the identity provider with the given Id.
updateIdentityProviderWithId 1 param body → 200default

Schemas 92

The contract defines 92 schemas that model the data the API accepts and returns. The most detailed are User (40 properties), NintendoIdentityProvider (21 properties), ExternalJWTIdentityProvider (20 properties), GoogleIdentityProvider (20 properties). Each schema is shown below with its type and property counts.

SAMLv2AssertionDecryptionConfiguration
object
Configuration for encrypted assertions when acting as SAML Service Provider
2 properties
LoginHintConfiguration
object
2 properties
IdentityProviderResponse
object
2 properties
OpenIdConnectApplicationConfiguration
object
5 properties
MetaData
object
3 properties
HYPRApplicationConfiguration
object
4 properties
XboxApplicationConfiguration
object
6 properties
SAMLv2AssertionConfiguration
object
1 property
SonyPSNApplicationConfiguration
object
6 properties
BreachedPasswordStatus
string
IdentityProviderConnectionTestRequest
object
A request for interacting with the identity provider connection test API
2 properties
DeviceInfo
object
5 properties
IdentityProviderSearchResponse
object
Identity Provider response.
2 properties
SteamAPIMode
string
Steam API modes.
EventInfo
object
Information about a user event (login, register, etc) that helps identify the source of the event (location, device type, OS, etc).
8 properties
NintendoApplicationConfiguration
object
9 properties
SAMLv2IdPInitiatedIdentityProvider
object
SAML v2 IdP Initiated identity provider configuration.
7 properties
ProviderLambdaConfiguration
object
1 property
IdentityType
object
Model identity types provided by FusionAuth.
1 property
AppleApplicationConfiguration
object
8 properties
IdentityProviderLoginStep
object
3 properties
UserTwoFactorConfiguration
object
2 properties
IdentityProviderTenantConfiguration
object
2 properties
GoogleApplicationConfiguration
object
8 properties
GroupMember
object
A User's membership into a Group
5 properties
IdentityProviderLinkingStrategy
string
The IdP behavior when no user link has been made yet.
GoogleIdentityProviderProperties
object
Google social login provider parameters.
2 properties
EpicGamesApplicationConfiguration
object
6 properties
TwitchApplicationConfiguration
object
6 properties
AppleIdentityProvider
object
20 properties
IdentityProviderDetails
object
7 properties
Locale
string
A Locale object represents a specific geographical, political, or cultural region.
IdentityProviderLimitUserLinkingPolicy
object
2 properties
ZoneId
string
Timezone Identifier
PendingIdPLink
object
10 properties
ClientAuthenticationMethod
string
IdentityProviderLoginMethod
string
LocalDate
string
A date without a time-zone in the ISO-8601 calendar system, such as 2007-12-03.
LoginPreventedResponse
object
The summary of the action that is preventing login to be returned on the login response.
10 properties
SteamIdentityProvider
object
Steam gaming login provider.
19 properties
TwitterApplicationConfiguration
object
5 properties
Error
object
Defines an error.
3 properties
IdentityVerifiedReason
string
Models the reason that {@link UserIdentityverified} was set to true or false.
ExternalJWTApplicationConfiguration
object
2 properties
IdentityProviderField
Errors
object
Standard error domain object that can also be used as the response from an API call.
2 properties
User
object
The public, global view of a User. This object contains all global information about the user including birthdate, registration information preferred languages…
40 properties
SAMLv2DestinationAssertionPolicy
string
UserRegistration
object
User registration information for a single application.
16 properties
SteamApplicationConfiguration
object
7 properties
IdentityProviderStartLoginRequest
object
11 properties
IdentityProviderSearchCriteria
object
Search criteria for Identity Providers.
8 properties
Location
object
Location information. Useful for IP addresses and other displayable data objects.
7 properties
IdentityProviderConnectionTestResult
object
The results of an identity provider connection test.
7 properties
LinkedInApplicationConfiguration
object
6 properties
NintendoIdentityProvider
object
Nintendo gaming login provider.
21 properties
ZonedDateTime
integer
The number of milliseconds since the unix epoch: January 1, 1970 00:00:00 UTC. This value is always in UTC.
SonyPSNIdentityProvider
object
SonyPSN gaming login provider.
18 properties
UserIdentity
object
11 properties
IdentityProviderSearchRequest
object
Search request for Identity Providers
1 property
IdentityProviderType
string
LookupResponse
object
1 property
TOTPAlgorithm
string
IdentityProviderPendingLinkResponse
object
3 properties
ExternalJWTIdentityProvider
object
External JWT-only identity provider.
20 properties
CanonicalizationMethod
string
XML canonicalization method enumeration. This is used for the IdP and SP side of FusionAuth SAML.
SAMLv2IdentityProvider
object
SAML v2 identity provider configuration.
19 properties
TwoFactorMethod
object
7 properties
LinkedInIdentityProvider
object
18 properties
IdentityProviderConnectionTestResponse
object
A response for the identity provider connection test API
2 properties
ContentStatus
string
Status for content like usernames, profile attributes, etc.
GoogleIdentityProvider
object
Google social login provider.
20 properties
EpicGamesIdentityProvider
object
Epic gaming login provider.
18 properties
IdentityProviderOauth2Configuration
object
12 properties
OpenIdConnectIdentityProvider
object
19 properties
LoginResponse
object
19 properties
FacebookApplicationConfiguration
object
8 properties
SAMLv2DestinationAssertionConfiguration
object
2 properties
TwitterIdentityProvider
object
Twitter social login provider.
17 properties
IdentityProviderLoginRequest
object
Login API request object used for login to third-party systems (i.e. Login with Facebook).
10 properties
IdentityProviderLink
object
11 properties
IdentityProviderRequest
object
1 property
IdentityProviderLinkResponse
object
2 properties
SAMLv2IdpInitiatedConfiguration
object
Config for regular SAML IDP configurations that support IdP initiated requests
2 properties
TwitchIdentityProvider
object
Twitch gaming login provider.
18 properties
FacebookIdentityProvider
object
Facebook social login provider.
20 properties
XboxIdentityProvider
object
Xbox gaming login provider.
18 properties
IdentityProviderLinkRequest
object
3 properties
AuthenticatorConfiguration
object
3 properties
HYPRIdentityProvider
object
16 properties
IdentityProviderStartLoginResponse
object
1 property
ChangePasswordReason
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

fusionauth-identity-provider-api-openapi.yml Raw ↑

Other APIs FusionAuth publishes across the network.

FusionAuth Api Key API
AE Profile APIs.io
FusionAuth Application API
AE Profile APIs.io
FusionAuth Connector API
AE Profile APIs.io
FusionAuth Consent API
AE Profile APIs.io
FusionAuth Email API
AE Profile APIs.io
FusionAuth Entity API
AE Profile APIs.io
FusionAuth Form API
AE Profile APIs.io
FusionAuth Group API
AE Profile APIs.io
FusionAuth Health API
AE Profile APIs.io
FusionAuth Identity API
AE Profile APIs.io
FusionAuth Integration API
AE Profile APIs.io
FusionAuth Ip Acl API
AE Profile APIs.io
#Identity Provider
← Back to F APIs
API Details
ID
fusionauth:fusionauth-identity-provider-api
Base URL
https://sandbox.fusionauth.io
Docs
https://fusionauth.io/docs/
Provider
FusionAuth
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=fusionauth-identity-provider-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/fusionauth-identity-provider-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of FusionAuth Identity Provider API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.