MongoDB · Schema
FederationOidcIdentityProviderUpdate
Cloud DatabaseDatabaseDocument DatabaseNoSQLMongoDB
Properties
| Name | Type | Description |
|---|---|---|
| audience | string | Identifier of the intended recipient of the token. |
| authorizationType | string | Indicates whether authorization is granted based on group membership or user ID. |
| description | string | The description of the identity provider. |
| displayName | string | Human-readable label that identifies the identity provider. |
| groupsClaim | string | Identifier of the claim which contains IdP Group IDs in the token. |
| idpType | string | String enum that indicates the type of the identity provider. Default is WORKFORCE. |
| issuerUri | string | Unique string that identifies the issuer of the SAML Assertion or OIDC metadata/discovery document URL. |
| protocol | string | String enum that indicates the protocol of the identity provider. Either SAML or OIDC. |
| userClaim | string | Identifier of the claim which contains the user ID in the token. |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/api-evangelist/mongodb/main/json-schema/mongodb-federation-oidc-identity-provider-update-schema.json",
"title": "FederationOidcIdentityProviderUpdate",
"x-generated": "2026-10-03",
"x-method": "derived",
"x-generator": "derive-json-schema.py",
"x-source": "openapi/mongodb-federated-authentication-api-openapi.yml#/components/schemas/FederationOidcIdentityProviderUpdate",
"oneOf": [
{
"$ref": "#/$defs/FederationOidcWorkforceIdentityProviderUpdate"
},
{
"$ref": "#/$defs/FederationOidcWorkloadIdentityProviderUpdate"
}
],
"properties": {
"audience": {
"description": "Identifier of the intended recipient of the token.",
"type": "string"
},
"authorizationType": {
"description": "Indicates whether authorization is granted based on group membership or user ID.",
"enum": [
"GROUP",
"USER"
],
"type": "string"
},
"description": {
"description": "The description of the identity provider.",
"type": "string"
},
"displayName": {
"description": "Human-readable label that identifies the identity provider.",
"maxLength": 50,
"minLength": 1,
"type": "string"
},
"groupsClaim": {
"description": "Identifier of the claim which contains IdP Group IDs in the token.",
"type": "string"
},
"idpType": {
"description": "String enum that indicates the type of the identity provider. Default is WORKFORCE.",
"enum": [
"WORKFORCE",
"WORKLOAD"
],
"type": "string"
},
"issuerUri": {
"description": "Unique string that identifies the issuer of the SAML Assertion or OIDC metadata/discovery document URL.",
"type": "string"
},
"protocol": {
"description": "String enum that indicates the protocol of the identity provider. Either SAML or OIDC.",
"enum": [
"SAML",
"OIDC"
],
"type": "string"
},
"userClaim": {
"description": "Identifier of the claim which contains the user ID in the token.",
"type": "string"
}
},
"type": "object",
"$defs": {
"FederationOidcWorkforceIdentityProviderUpdate": {
"properties": {
"associatedDomains": {
"description": "List that contains the domains associated with the identity provider.",
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"audience": {
"description": "Identifier of the intended recipient of the token.",
"type": "string"
},
"authorizationType": {
"description": "Indicates whether authorization is granted based on group membership or user ID.",
"enum": [
"GROUP",
"USER"
],
"type": "string"
},
"clientId": {
"description": "Client identifier that is assigned to an application by the Identity Provider.",
"type": "string"
},
"description": {
"description": "The description of the identity provider.",
"type": "string"
},
"displayName": {
"description": "Human-readable label that identifies the identity provider.",
"maxLength": 50,
"minLength": 1,
"type": "string"
},
"groupsClaim": {
"description": "Identifier of the claim which contains IdP Group IDs in the token.",
"type": "string"
},
"idpType": {
"description": "String enum that indicates the type of the identity provider. Default is WORKFORCE.",
"enum": [
"WORKFORCE",
"WORKLOAD"
],
"type": "string"
},
"issuerUri": {
"description": "Unique string that identifies the issuer of the SAML Assertion or OIDC metadata/discovery document URL.",
"type": "string"
},
"protocol": {
"description": "String enum that indicates the protocol of the identity provider. Either SAML or OIDC.",
"enum": [
"SAML",
"OIDC"
],
"type": "string"
},
"requestedScopes": {
"description": "Scopes that MongoDB applications will request from the authorization endpoint.",
"items": {
"type": "string"
},
"type": "array"
},
"userClaim": {
"description": "Identifier of the claim which contains the user ID in the token.",
"type": "string"
}
},
"title": "OIDC WORKFORCE",
"type": "object"
},
"FederationOidcWorkloadIdentityProviderUpdate": {
"properties": {
"audience": {
"description": "Identifier of the intended recipient of the token.",
"type": "string"
},
"authorizationType": {
"description": "Indicates whether authorization is granted based on group membership or user ID.",
"enum": [
"GROUP",
"USER"
],
"type": "string"
},
"description": {
"description": "The description of the identity provider.",
"type": "string"
},
"displayName": {
"description": "Human-readable label that identifies the identity provider.",
"maxLength": 50,
"minLength": 1,
"type": "string"
},
"groupsClaim": {
"description": "Identifier of the claim which contains IdP Group IDs in the token.",
"type": "string"
},
"idpType": {
"description": "String enum that indicates the type of the identity provider. Default is WORKFORCE.",
"enum": [
"WORKFORCE",
"WORKLOAD"
],
"type": "string"
},
"issuerUri": {
"description": "Unique string that identifies the issuer of the SAML Assertion or OIDC metadata/discovery document URL.",
"type": "string"
},
"protocol": {
"description": "String enum that indicates the protocol of the identity provider. Either SAML or OIDC.",
"enum": [
"SAML",
"OIDC"
],
"type": "string"
},
"userClaim": {
"description": "Identifier of the claim which contains the user ID in the token.",
"type": "string"
}
},
"title": "OIDC WORKLOAD",
"type": "object"
}
}
}
Work with this as data
Every JSON Schema 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 schemas
4 MCP tools reach this
find_json_schemasBrowse and filter every JSON Schema in the catalog.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 JSON Schema
curl "https://apis.io/api/v1/json-schemas/mongodb-federation-oidc-identity-provider-update"
All schemas
curl "https://apis.io/api/v1/json-schemas?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.