--- url: https://docs.federated.directory/developer/api-search.md --- # API Documentation ## API Discovery Root Returns the SCIM service provider configuration from the root path... **Method**: GET / [Go to endpoint](/developer/api-reference#tag/default/operation/get) ## OAuth 2.0 Authorization Server Metadata Returns metadata for OAuth 2.0 authorization server discovery (RFC 8414).... **Method**: GET /.well-known/oauth-authorization-server [Go to endpoint](/developer/api-reference#tag/oauth2/operation/getWellknownOauthauthorizationserver) ## OAuth 2.0 Protected Resource Metadata Returns metadata for OAuth 2.0 discovery (RFC 8707). This allows clients to discover how to authenticate with this specific resource.... **Method**: GET /.well-known/oauth-protected-resource [Go to endpoint](/developer/api-reference#tag/mcp/operation/getWellknownOauthprotectedresource) ## Get Service Provider Config Returns the SCIM service provider configuration... **Method**: GET /v2/ServiceProviderConfig [Go to endpoint](/developer/api-reference#tag/scim/operation/getV2Serviceproviderconfig) ## MCP Endpoint - GET Not Supported This endpoint only supports POST requests for JSON-RPC 2.0 MCP calls. GET requests are not supported as this server does not implement SSE (Server-Sen... **Method**: GET /v2/mcp [Go to endpoint](/developer/api-reference#tag/mcp/operation/getV2Mcp) ## MCP JSON-RPC Endpoint - Multi-method Model Context Protocol handler Handles Model Context Protocol (MCP) JSON-RPC 2.0 requests. ### Supported MCP Methods - **initialize**: Initial handshake to exchange version and ca... **Method**: POST /v2/mcp [Go to endpoint](/developer/api-reference#tag/mcp/operation/postV2Mcp) ## Get the current user Returns the SCIM representation of the currently authenticated user... **Method**: GET /v2/me [Go to endpoint](/developer/api-reference#tag/users/operation/getV2Me) ## Get a group or list of groups Returns a single group when an ID is provided, or a ListResponse when no ID is given. ListResponse shape: { schemas, totalResults, startIndex, itemsPe... **Method**: GET /v2/Groups/{id} [Go to endpoint](/developer/api-reference#tag/groups/operation/getV2GroupsId) ## Delete a group Deletes a group by ID... **Method**: DELETE /v2/Groups/{id} [Go to endpoint](/developer/api-reference#tag/groups/operation/deleteV2GroupsId) ## Update a group Updates a group resource using SCIM patch operations... **Method**: PATCH /v2/Groups/{id} [Go to endpoint](/developer/api-reference#tag/groups/operation/patchV2GroupsId) ## Get SCIM Resource Types Returns the SCIM resource types supported by the API... **Method**: GET /v2/ResourceTypes/{resourceType} [Go to endpoint](/developer/api-reference#tag/scim/operation/getV2ResourcetypesResourcetype) ## Get SCIM Schemas Returns the SCIM schemas supported by the API... **Method**: GET /v2/Schemas/{schema} [Go to endpoint](/developer/api-reference#tag/scim/operation/getV2SchemasSchema) ## Get a user or list of users Returns a user by ID or a list of users based on SCIM filtering. Supports optional attributes parameter to request specific fields. When no ID is prov... **Method**: GET /v2/Users/{id} [Go to endpoint](/developer/api-reference#tag/users/operation/getV2UsersId) ## Delete a user Deletes a user by ID... **Method**: DELETE /v2/Users/{id} [Go to endpoint](/developer/api-reference#tag/users/operation/deleteV2UsersId) ## Replace a user Replaces a user resource with the provided SCIM data... **Method**: PUT /v2/Users/{id} [Go to endpoint](/developer/api-reference#tag/users/operation/putV2UsersId) ## Update a user Updates a user resource using SCIM patch operations... **Method**: PATCH /v2/Users/{id} [Go to endpoint](/developer/api-reference#tag/users/operation/patchV2UsersId) ## List the active OAuth authorizations of the requester Returns every OAuth client the requester currently has an active grant for (grantedAt, lastUsedAt, scope).... **Method**: GET /v2/oauth/authorizations [Go to endpoint](/developer/api-reference#tag/oauth2/operation/getV2OauthAuthorizations) ## List OAuth clients available to this company Returns standard platform clients and the company's own custom clients. Used by the group-creation client picker and the admin Integrations page.... **Method**: GET /v2/oauth/clients [Go to endpoint](/developer/api-reference#tag/oauth2/operation/getV2OauthClients) ## Create a custom OAuth client Creates a new OAuth client owned by the admin's company. clientId is generated by the server and returned in the response.... **Method**: POST /v2/oauth/clients [Go to endpoint](/developer/api-reference#tag/oauth2/operation/postV2OauthClients) ## OAuth 2.0 Authorization Endpoint Validates the authorization request (client\_id, redirect\_uri, PKCE params) and redirects the browser to the Federated Directory consent screen.... **Method**: GET /v2/Login/Oauth2/Authorize [Go to endpoint](/developer/api-reference#tag/oauth2/operation/getV2LoginOauth2Authorize) ## OAuth 2.0 consent decision Accepts or denies a pending authorization request. On approval, resolves the groups this client may access (intersection of the user's groups and grou... **Method**: POST /v2/Login/Oauth2/Authorize [Go to endpoint](/developer/api-reference#tag/oauth2/operation/postV2LoginOauth2Authorize) ## Get a single OAuth client by clientId **Method**: GET /v2/oauth/clients/{clientId} [Go to endpoint](/developer/api-reference#tag/oauth2/operation/getV2OauthClientsClientid) ## Bulk User operations Allows multiple SCIM User operations (create, update, delete) in a single request. Per RFC 7644, bulkId is required for POST operations and optional f... **Method**: POST /v2/Bulk [Go to endpoint](/developer/api-reference#tag/users/operation/postV2Bulk) ## Create a new group Creates a new group in the directory using SCIM format... **Method**: POST /v2/Groups [Go to endpoint](/developer/api-reference#tag/groups/operation/postV2Groups) ## Create a new user Creates a new user in the directory using SCIM format... **Method**: POST /v2/Users [Go to endpoint](/developer/api-reference#tag/users/operation/postV2Users) ## Get Access Token Exchanges credentials for an OAuth 2.0 access token. Supports three grant types: the JWT-bearer grant (RFC 7523, for API keys), the authorization\_code... **Method**: POST /v2/Login/Oauth2/Token [Go to endpoint](/developer/api-reference#tag/oauth2/operation/postV2LoginOauth2Token) ## Revoke the OAuth authorization owned by the requester Deletes the grant (cascading to its refresh tokens) and any active sessions for this user+client, ending access immediately. Writes an audit log entry... **Method**: DELETE /v2/oauth/authorizations/{clientId} [Go to endpoint](/developer/api-reference#tag/oauth2/operation/deleteV2OauthAuthorizationsClientid) ## Delete a custom OAuth client **Method**: DELETE /v2/oauth/clients/{id} [Go to endpoint](/developer/api-reference#tag/oauth2/operation/deleteV2OauthClientsId) ## Update a custom OAuth client **Method**: PUT /v2/oauth/clients/{id} [Go to endpoint](/developer/api-reference#tag/oauth2/operation/putV2OauthClientsId) ## Update group logo Updates the logo for a group... **Method**: PUT /v2/Groups/{id}/Logo [Go to endpoint](/developer/api-reference#tag/groups/operation/putV2GroupsIdLogo) ## Upload a logo for a custom OAuth client **Method**: PUT /v2/oauth/clients/{id}/Logo [Go to endpoint](/developer/api-reference#tag/oauth2/operation/putV2OauthClientsIdLogo)