Flagsmith

Flagsmith Authentication API

Authentication, MFA, OAuth, and token management.

GitHub OpenAPI

Operations 59

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

POST /api/v1/auth/{method}/activate/ Start enabling a two-factor method · Api v1 auth activate create #
Ask an LLM
“How do I begin turning on two-factor authentication for my account?”
“Can I start setting up an authenticator app as an MFA method?”
Tell an agent
Begin activating MFA method {method} on my account.
Start two-factor setup using the {method} method.
POST /api/v1/auth/{method}/activate/confirm/ Confirm a two-factor method setup · Api v1 auth activate confirm create #
Ask an LLM
“What is the final step to finish enabling two-factor authentication?”
“Once I've scanned the MFA code, how do I confirm it's working?”
Tell an agent
Confirm activation of MFA method {method}.
Finish two-factor setup for {method} with my verification code.
POST /api/v1/auth/{method}/deactivate/ Turn off a two-factor method · Api v1 auth deactivate create #
Ask an LLM
“Can I disable two-factor authentication on my account?”
“What removes an MFA method I no longer use?”
Tell an agent destructive · confirm first
Deactivate MFA method {method} on my account.
Turn off two-factor via {method}.
POST /api/v1/auth/login/ Log in with email and password · Api v1 auth login create #
Ask an LLM
“How do I get an auth token by logging in with my email and password?”
“Is password login rate limited if I try too many times?”
Tell an agent
Log me in as {email} with password {password}.
Sign in to Flagsmith with email {email} and password {password} to get a token.
POST /api/v1/auth/login/code/ Complete login with a two-factor code · Api v1 auth login code create #
Ask an LLM
“After my password, where do I submit the second-factor login code?”
“Can I finish a login that requires an MFA code?”
Tell an agent
Complete the two-factor login for {email} with the code step.
Submit the MFA login code step for {email} using password {password}.
POST /api/v1/auth/logout/ Log out and remove my auth token · Api v1 auth logout create #
Ask an LLM
“How do I log out so my auth token stops working?”
“Does logging out invalidate the current session token?”
Tell an agent destructive · confirm first
Log me out of Flagsmith.
End my session by removing my authentication token through logout.
GET /api/v1/auth/mfa/user-active-methods/ List my active two-factor methods · Api v1 auth mfa user active methods retrieve #
Ask an LLM
“Which two-factor methods are currently switched on for my account?”
“Do I have MFA enabled right now?”
Tell an agent
Show my active MFA methods.
Check which two-factor methods are enabled on my account.
POST /api/v1/auth/oauth/github/ Sign in with GitHub · Api v1 auth oauth github create #
Ask an LLM
“Can I log in or sign up using my GitHub account?”
“What do I pass to exchange a GitHub access token for a Flagsmith session?”
Tell an agent
Sign me in with GitHub using access token {access_token}.
Sign up through GitHub with token {access_token} and sign-up type {sign_up_type}.
POST /api/v1/auth/oauth/google/ Sign in with Google · Api v1 auth oauth google create #
Ask an LLM
“Can I log in or sign up using my Google account?”
“What do I pass to exchange a Google access token for a session?”
Tell an agent
Sign me in with Google using access token {access_token}.
Sign up through Google with token {access_token}, marketing consent {marketing_consent_given}.
POST /api/v1/auth/oidc/token/ Exchange an OIDC token for an access token · Oidc token exchange #
Ask an LLM
“Can my CI pipeline swap its OIDC token for a short-lived access token?”
“How does workload identity federation from a trusted identity provider work here?”
Tell an agent
Exchange OIDC token {token} for a short-lived Flagsmith access token.
Trade this identity provider token {token} for temporary API credentials.
POST /api/v1/auth/saml/{name}/request/ Start a SAML login request · Api v1 auth saml request create #
Ask an LLM
“How do I kick off a SAML single sign-on login for my organisation's configuration?”
“Where does SP-initiated SAML login begin?”
Tell an agent
Start a SAML login request for configuration {name}.
Generate the SAML authentication request for SSO config {name}.
POST /api/v1/auth/saml/{name}/response/ Handle a SAML response from the identity provider · Api v1 auth saml response create #
Ask an LLM
“Where should my identity provider post its SAML assertion?”
“What is the SAML assertion consumer endpoint for my configuration?”
Tell an agent
Process the SAML response for configuration {name}.
Consume the identity provider's SAML assertion for SSO config {name}.
GET /api/v1/auth/saml/attribute-mapping/ List SAML attribute mappings · Api v1 auth saml attribute mapping list #
Ask an LLM
“Which identity provider attributes are mapped to user fields for SAML?”
“Can I filter SAML attribute mappings to one SAML configuration?”
Tell an agent
List SAML attribute mappings for organisation {organisation}.
Show attribute mappings for SAML configuration {saml_configuration}.
POST /api/v1/auth/saml/attribute-mapping/ Map an identity provider attribute to a user field · Api v1 auth saml attribute mapping create #
Ask an LLM
“How do I map an IdP attribute such as email to a user field for SAML?”
“Can I add a new attribute mapping to my SAML setup?”
Tell an agent
Map IdP attribute {idp_attribute_name} to user field {django_attribute_name} in SAML configuration {saml_configuration}.
Add a SAML mapping from {idp_attribute_name} to {django_attribute_name} for config {saml_configuration}.
GET /api/v1/auth/saml/attribute-mapping/{id}/ Get a SAML attribute mapping · Api v1 auth saml attribute mapping retrieve #
Ask an LLM
“What does a specific SAML attribute mapping point to?”
“Which user field is one SAML mapping filling in?”
Tell an agent
Get SAML attribute mapping {id}.
Show which IdP attribute mapping {id} reads from.
PUT /api/v1/auth/saml/attribute-mapping/{id}/ Replace a SAML attribute mapping · Api v1 auth saml attribute mapping update #
Ask an LLM
“How do I fully redefine an existing SAML attribute mapping?”
“Can I replace both sides of a SAML mapping at once?”
Tell an agent
Replace SAML mapping {id} so {idp_attribute_name} maps to {django_attribute_name} in config {saml_configuration}.
Overwrite attribute mapping {id} entirely for SAML configuration {saml_configuration}: {idp_attribute_name} to {django_attribute_name}.
PATCH /api/v1/auth/saml/attribute-mapping/{id}/ Change the IdP attribute on a SAML mapping · Api v1 auth saml attribute mapping partial update #
Ask an LLM
“Can I change only the identity provider attribute name on a SAML mapping?”
“What if my IdP renamed an attribute that a mapping uses?”
Tell an agent
Point SAML mapping {id} at IdP attribute {idp_attribute_name}.
Change the user field on attribute mapping {id} to {django_attribute_name}.
DELETE /api/v1/auth/saml/attribute-mapping/{id}/ Delete a SAML attribute mapping · Api v1 auth saml attribute mapping destroy #
Ask an LLM
“How do I remove a SAML attribute mapping I no longer need?”
“Can I stop an IdP attribute from being mapped to a user field?”
Tell an agent destructive · confirm first
Delete SAML attribute mapping {id}.
Remove attribute mapping {id} from the SAML setup.
GET /api/v1/auth/saml/configuration/ List an organisation's SAML configurations · Api v1 auth saml configuration list #
Ask an LLM
“Which SAML single sign-on configurations does my organisation have?”
“Is SAML SSO set up for a given organisation?”
Tell an agent
List SAML configurations for organisation {organisation}.
Show the SSO setups configured in organisation {organisation}.
POST /api/v1/auth/saml/configuration/ Set up SAML single sign-on · Api v1 auth saml configuration create #
Ask an LLM
“How do I configure SAML SSO for my organisation?”
“Can I upload my identity provider's metadata XML when setting up SAML?”
Tell an agent
Create SAML configuration {name} for organisation {organisation} with frontend URL {frontend_url}.
Set up SSO {name} for organisation {organisation} at {frontend_url} using IdP metadata {idp_metadata_xml}.
GET /api/v1/auth/saml/configuration/{name}/ Get a SAML configuration · Api v1 auth saml configuration retrieve #
Ask an LLM
“What settings does a particular SAML configuration have?”
“Does my SAML setup allow IdP-initiated login?”
Tell an agent
Get SAML configuration {name}.
Show the frontend URL and IdP settings for SSO config {name}.
PUT /api/v1/auth/saml/configuration/{name}/ Replace a SAML configuration · Api v1 auth saml configuration update #
Ask an LLM
“How do I fully replace an existing SAML SSO configuration?”
“Can I redo every setting on my SAML configuration at once?”
Tell an agent
Replace SAML configuration {name} for organisation {organisation} with frontend URL {frontend_url}.
Overwrite SSO config {name} in organisation {organisation}, frontend {frontend_url}, IdP metadata {idp_metadata_xml}.
PATCH /api/v1/auth/saml/configuration/{name}/ Update IdP metadata or settings on SAML config · Api v1 auth saml configuration partial update #
Ask an LLM
“Can I upload new identity provider metadata to an existing SAML setup?”
“How do I switch IdP-initiated login on for my SAML configuration?”
Tell an agent
Update SAML configuration {name} with new IdP metadata {idp_metadata_xml}.
Set allow IdP-initiated login to {allow_idp_initiated} on SSO config {name}.
DELETE /api/v1/auth/saml/configuration/{name}/ Delete a SAML configuration · Api v1 auth saml configuration destroy #
Ask an LLM
“How do I turn off SAML SSO by deleting its configuration?”
“Can I remove an old SAML configuration?”
Tell an agent destructive · confirm first
Delete SAML configuration {name}.
Remove SSO config {name}.
POST /api/v1/auth/saml/login/ Log in with a SAML access token · Api v1 auth saml login create #
Ask an LLM
“After SAML SSO, how do I turn the returned token into a session?”
“What completes a SAML login on the frontend?”
Tell an agent
Complete SAML login with access token {access_token}.
Exchange SAML token {access_token} for a Flagsmith session.
DELETE /api/v1/auth/token/ Revoke my authentication token · Api v1 auth token destroy #
Ask an LLM
“Can I delete my current API auth token directly?”
“What revokes the token I'm authenticated with?”
Tell an agent destructive · confirm first
Revoke my current auth token.
Delete the authentication token I'm using right now.
GET /api/v1/auth/users/ List user accounts · Api v1 auth users list #
Ask an LLM
“Which user accounts can I see through the auth users endpoint?”
“Can I page through registered users?”
Tell an agent
List user accounts.
Show page {page} of registered users.
POST /api/v1/auth/users/ Register a new user account · Api v1 auth users create #
Ask an LLM
“How do I sign up a new user with email and password?”
“Can I record marketing consent when registering someone?”
Tell an agent
Register user {first_name} {last_name} with email {email} and password {password}.
Sign up {email} as {first_name} {last_name}, password {password}, marketing consent {marketing_consent_given}.
GET /api/v1/auth/users/{id}/ Get a user account by ID · Api v1 auth users retrieve #
Ask an LLM
“What are the details of a specific user account?”
“Can I look up another user by their ID?”
Tell an agent
Get user account {id}.
Show the name and email of user {id}.
PUT /api/v1/auth/users/{id}/ Replace a user's name details · Api v1 auth users update #
Ask an LLM
“How do I fully update another user's first and last name?”
“Can I replace a user account's profile by ID?”
Tell an agent
Set user {id}'s name to {first_name} {last_name}.
Replace the profile of user {id} with first name {first_name} and last name {last_name}.
PATCH /api/v1/auth/users/{id}/ Change one detail on a user account · Api v1 auth users partial update #
Ask an LLM
“Can I change just the last name on another user's account?”
“What lets me patch a single field on a user by ID?”
Tell an agent
Change user {id}'s last name to {last_name}.
Update only the first name of user {id} to {first_name}.
DELETE /api/v1/auth/users/{id}/ Delete a user account · Api v1 auth users destroy #
Ask an LLM
“How do I delete a user account by its ID?”
“Can I also delete organisations that would be left with no users?”
Tell an agent destructive · confirm first
Delete user account {id}, confirming with password {current_password}.
Delete user {id} and orphaned organisations {delete_orphan_organisations}.
POST /api/v1/auth/users/activation/ Activate a new account from its email link · Api v1 auth users activation create #
Ask an LLM
“What activates an account using the uid and token from the activation email?”
“My activation link has a uid and token — where do those go?”
Tell an agent
Activate the account with uid {uid} and token {token}.
Confirm sign-up using activation uid {uid} and token {token}.
GET /api/v1/auth/users/me/ Get my own user profile · Api v1 auth users me retrieve #
Ask an LLM
“Who am I logged in as?”
“What does my own account profile look like, including when I joined?”
Tell an agent
Show my own user profile.
Tell me which account I'm authenticated as.
PUT /api/v1/auth/users/me/ Replace my own profile details · Api v1 auth users me update #
Ask an LLM
“How do I update my own first and last name in one full replacement?”
“Can I reset my whole profile at once?”
Tell an agent
Replace my profile with first name {first_name} and last name {last_name}.
Rewrite my own account as {first_name} {last_name}.
PATCH /api/v1/auth/users/me/ Edit one field of my own profile · Api v1 auth users me partial update #
Ask an LLM
“Can I change just my first name?”
“What updates my own email signature for support messages?”
Tell an agent
Change my first name to {first_name}.
Set my support email signature to {pylon_email_signature}.
DELETE /api/v1/auth/users/me/ Delete my own account · Api v1 auth users me destroy #
Ask an LLM
“How do I close and delete my own account?”
“Can I remove myself completely?”
Tell an agent destructive · confirm first
Delete my own account.
Close the account I'm logged in with permanently.
PATCH /api/v1/auth/users/me/onboarding/ Update my onboarding details · Api v1 auth users me onboarding partial update #
Ask an LLM
“Where do I save my details during the onboarding flow?”
“Can onboarding record how I signed up?”
Tell an agent
Save my onboarding details with sign-up type {sign_up_type}.
Update my onboarding profile as {first_name} {last_name}.
POST /api/v1/auth/users/resend_activation/ Resend the account activation email · Api v1 auth users resend activation create #
Ask an LLM
“I never got my activation email — can it be sent again?”
“What resends the sign-up confirmation link?”
Tell an agent
Resend the activation email to {email}.
Send {email} a fresh account activation link.
POST /api/v1/auth/users/reset_email/ Request an email address reset · Api v1 auth users reset email create #
Ask an LLM
“How do I start the process of resetting the email on an account?”
“Can I request an email-change link for an account?”
Tell an agent
Request an email reset for account {email}.
Send an email-change link to {email}.
POST /api/v1/auth/users/reset_email_confirm/ Confirm a new email address after reset · Api v1 auth users reset email confirm create #
Ask an LLM
“What finishes an email reset by setting the new address?”
“Once I have the reset link, where do I submit my new email?”
Tell an agent
Confirm the email reset with new address {new_email}.
Complete the email change to {new_email}.
POST /api/v1/auth/users/reset_password/ Request a password reset email · Api v1 auth users reset password create #
Ask an LLM
“I forgot my password — how do I get a reset email?”
“Can I trigger a password reset link for an account?”
Tell an agent
Send a password reset email to {email}.
Start a forgotten-password reset for {email}.
POST /api/v1/auth/users/reset_password_confirm/ Set a new password from a reset link · Api v1 auth users reset password confirm create #
Ask an LLM
“What sets my new password using the uid and token from the reset email?”
“Do I have to enter the new password twice when resetting it?”
Tell an agent
Reset the password with uid {uid} and token {token} to {new_password}, confirmed as {re_new_password}.
Finish the password reset for uid {uid}, token {token}, new password {new_password} repeated {re_new_password}.
POST /api/v1/auth/users/set_email/ Change my email while logged in · Api v1 auth users set email create #
Ask an LLM
“How do I change my login email if I know my current password?”
“Does changing my email require my current password?”
Tell an agent
Change my email to {new_email} using my current password {current_password}.
Set my account email to {new_email}, verifying with {current_password}.
POST /api/v1/auth/users/set_password/ Change my password while logged in · Api v1 auth users set password create #
Ask an LLM
“Can I change my password when I still know the old one?”
“What changes my password without going through a reset email?”
Tell an agent
Change my password from {current_password} to {new_password}, confirmed {re_new_password}.
Update my password to {new_password} (repeat {re_new_password}) using current password {current_password}.
POST /api/v1/organisations/{organisation_pk}/groups/{group_pk}/users/{user_pk}/make-admin Make a user a group admin · Api v1 organisations groups users make admin create #
Ask an LLM
“How do I give someone admin rights over a user group?”
“Can a group member be promoted to group admin?”
Tell an agent
Make user {user_pk} an admin of group {group_pk} in organisation {organisation_pk}.
Promote {user_pk} to group admin on group {group_pk} in {organisation_pk}.
POST /api/v1/organisations/{organisation_pk}/groups/{group_pk}/users/{user_pk}/remove-admin Remove a user's group admin rights · Api v1 organisations groups users remove admin create #
Ask an LLM
“Can I demote a group admin back to a regular member?”
“What takes away someone's admin role on a user group?”
Tell an agent
Remove admin rights from user {user_pk} on group {group_pk} in organisation {organisation_pk}.
Demote {user_pk} from group admin of {group_pk} in {organisation_pk}.
GET /api/v1/organisations/{organisation_pk}/roles/{role_pk}/users/ List users assigned to a role · Api v1 organisations roles users list #
Ask an LLM
“Which users hold a particular role in my organisation?”
“Who has been given this role?”
Tell an agent
List users assigned to role {role_pk} in organisation {organisation_pk}.
Show everyone holding role {role_pk} in {organisation_pk}.
POST /api/v1/organisations/{organisation_pk}/roles/{role_pk}/users/ Assign a role to a user · Api v1 organisations roles users create #
Ask an LLM
“How do I give a user a role in my organisation?”
“Can I add someone to an existing role?”
Tell an agent
Assign user {user} to role {role_pk} in organisation {organisation_pk}.
Give {user} the role {role_pk} in {organisation_pk}.
GET /api/v1/organisations/{organisation_pk}/roles/{role_pk}/users/{id}/ Get a user's role assignment · Api v1 organisations roles users retrieve #
Ask an LLM
“What does a single user-role assignment record contain?”
“Is a given role assignment still in place?”
Tell an agent
Get role assignment {id} for role {role_pk} in organisation {organisation_pk}.
Show user-role record {id} under role {role_pk} in {organisation_pk}.
PUT /api/v1/organisations/{organisation_pk}/roles/{role_pk}/users/{id}/ Replace a user-role assignment · Api v1 organisations roles users update #
Ask an LLM
“Can I swap which user a role assignment points to?”
“How do I fully redo one user-role assignment?”
Tell an agent
Replace role assignment {id} on role {role_pk} in {organisation_pk} with user {user}.
Overwrite user-role record {id} for role {role_pk} in organisation {organisation_pk} to point at {user}.
PATCH /api/v1/organisations/{organisation_pk}/roles/{role_pk}/users/{id}/ Edit a user-role assignment · Api v1 organisations roles users partial update #
Ask an LLM
“Can I move a user-role assignment to a different role?”
“What changes just one field of a role assignment?”
Tell an agent
Move assignment {id} under role {role_pk} in {organisation_pk} to role {role}.
Patch role assignment {id} on role {role_pk} in organisation {organisation_pk} to user {user}.
DELETE /api/v1/organisations/{organisation_pk}/roles/{role_pk}/users/{id}/ Remove a user from a role · Api v1 organisations roles users destroy #
Ask an LLM
“How do I take a role away from a user, working from the role's member list?”
“Can I unassign someone from a role by the assignment ID?”
Tell an agent destructive · confirm first
Remove role assignment {id} from role {role_pk} in organisation {organisation_pk}.
Unassign member {id} from role {role_pk} in {organisation_pk}.
GET /api/v1/organisations/{organisation_pk}/users/ List members of an organisation · Api v1 organisations users list #
Ask an LLM
“Who are the members of my organisation?”
“Can I see every user in an organisation?”
Tell an agent
List users in organisation {organisation_pk}.
Show all members of organisation {organisation_pk}.
POST /api/v1/organisations/{organisation_pk}/users/{id}/update-role/ Change a member's organisation role · Api v1 organisations users update role create #
Ask an LLM
“How do I make an organisation member an admin or a regular user?”
“Can I change someone's role in the organisation?”
Tell an agent
Set user {id}'s organisation role to {role} in organisation {organisation_pk}.
Change member {id} in {organisation_pk} to organisation role {role}.
GET /api/v1/organisations/{organisation_pk}/users/{user_pk}/roles/ List the roles a user holds · Api v1 organisations users roles list #
Ask an LLM
“Which roles has a particular user been given in my organisation?”
“What roles does this teammate hold?”
Tell an agent
List the roles held by user {user_pk} in organisation {organisation_pk}.
Show every role assigned to {user_pk} in {organisation_pk}.
DELETE /api/v1/organisations/{organisation_pk}/users/{user_pk}/roles/{id}/ Remove a role from a user · Api v1 organisations users roles destroy #
Ask an LLM
“Can I remove one role from a user, working from that user's list of roles?”
“What strips a specific role off a teammate?”
Tell an agent destructive · confirm first
Remove role {id} from user {user_pk} in organisation {organisation_pk}.
Take role {id} away from {user_pk} in {organisation_pk}.
POST /api/v1/users/join/{hash}/ Join an organisation from an email invite · Api v1 users join create #
Ask an LLM
“I got an invite email to an organisation — how do I accept it?”
“What accepts a personal organisation invitation?”
Tell an agent
Accept the organisation email invite {hash}.
Join the organisation using invitation hash {hash}.

Specifications

⚙
OpenAPI
https://artifacts.apis.io/flagsmith/openapi/flagsmith-authentication-api-openapi.yml

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/flagsmith:flagsmith-authentication-api"
All apis 
curl "https://apis.io/api/v1/apis?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.

GitHub Google LinkedIn

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

OpenAPI Specification

flagsmith-authentication-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Flagsmith Authentication API
  version: v1
  description: Flagsmith's Core and SDK APIs. Check out Flagsmith documentation.
  contact:
    email: support@flagsmith.com
  license:
    name: BSD License
    identifier: BSD-3-Clause
tags:


# --- truncated at 32 KB (64 KB total) ---
# Full source: https://artifacts.apis.io/flagsmith/openapi/flagsmith-authentication-api-openapi.yml