PropelAuth

PropelAuth Members API

Add, remove, invite, and change roles for users within an organization

GitHub OpenAPI

Operations 4

GET /api/backend/v1/user/org/{orgId} Fetch Users In Org #
POST /api/backend/v1/org/add_user Add User To Org #
POST /api/backend/v1/org/change_role Change Role #
POST /api/backend/v1/org/remove_user Remove User From Org #

Documentation

📖
Documentation
https://docs.propelauth.com/reference/api/user
📖
GettingStarted
https://docs.propelauth.com/reference/api/getting-started
📖
Documentation
https://docs.propelauth.com/reference/api/org
📖
Documentation
https://docs.propelauth.com/mcp-authentication/overview

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/propelauth/refs/heads/main/openapi/propelauth-members-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/propelauth/refs/heads/main/json-schema/propelauth-user-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/propelauth/refs/heads/main/json-schema/propelauth-org-schema.json

Other Resources

🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/propelauth/refs/heads/main/json-ld/propelauth-context.jsonld
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/propelauth/refs/heads/main/examples/propelauth-create-user-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/propelauth/refs/heads/main/examples/propelauth-create-magic-link-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/propelauth/refs/heads/main/examples/propelauth-create-org-example.json

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/propelauth-members-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

propelauth-members-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: PropelAuth Organization Members API
  description: 'Backend REST API for managing tenants (organizations) in PropelAuth. Create and update

    organizations, add and remove members, invite users, change roles, manage role mappings,

    and revoke pending invites. All endpoints require a PropelAuth Backend Integration API key

    presented as a Bearer token.'
  version: 1.0.0
  contact:
    name: PropelAuth Support
    url: https://www.propelauth.com
    email: support@propelauth.com
  license:
    name: PropelAuth Terms
    url: https://www.propelauth.com/legal/terms-of-service
servers:
- url: https://{authId}.propelauthtest.com
  description: Test environment
  variables:
    authId:
      default: '0000000000'
- url: https://auth.example.com
  description: Production / Staging custom domain
security:
- BackendApiKey: []
tags:
- name: Members
  description: Add, remove, invite, and change roles for users within an organization
paths:
  /api/backend/v1/user/org/{orgId}:
    get:
      summary: Fetch Users In Org
      description: List users that belong to the supplied organization.
      operationId: fetchUsersInOrg
      tags:
      - Members
      parameters:
      - $ref: '#/components/parameters/OrgId'
      - name: page_size
        in: query
        schema:
          type: integer
          default: 10
      - name: page_number
        in: query
        schema:
          type: integer
          default: 0
      - name: role
        in: query
        schema:
          type: string
      responses:
        '200':
          description: Page of users
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserPage'
  /api/backend/v1/org/add_user:
    post:
      summary: Add User To Org
      description: Add an existing user to an organization with a specified role.
      operationId: addUserToOrg
      tags:
      - Members
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - user_id
              - org_id
              - role
              properties:
                user_id:
                  type: string
                  format: uuid
                org_id:
                  type: string
                  format: uuid
                role:
                  type: string
                additional_roles:
                  type: array
                  items:
                    type: string
      responses:
        '200':
          description: User added
  /api/backend/v1/org/change_role:
    post:
      summary: Change Role
      description: Change a user's role within an organization.
      operationId: changeRole
      tags:
      - Members
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - user_id
              - org_id
              - role
              properties:
                user_id:
                  type: string
                  format: uuid
                org_id:
                  type: string
                  format: uuid
                role:
                  type: string
                additional_roles:
                  type: array
                  items:
                    type: string
      responses:
        '200':
          description: Role updated
  /api/backend/v1/org/remove_user:
    post:
      summary: Remove User From Org
      description: Remove a user from an organization.
      operationId: removeUserFromOrg
      tags:
      - Members
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - user_id
              - org_id
              properties:
                user_id:
                  type: string
                  format: uuid
                org_id:
                  type: string
                  format: uuid
      responses:
        '200':
          description: User removed
components:
  schemas:
    UserPage:
      type: object
      properties:
        users:
          type: array
          items:
            type: object
            additionalProperties: true
        total_users:
          type: integer
        current_page:
          type: integer
        page_size:
          type: integer
        has_more_results:
          type: boolean
  parameters:
    OrgId:
      name: orgId
      in: path
      required: true
      schema:
        type: string
        format: uuid
  securitySchemes:
    BackendApiKey:
      type: http
      scheme: bearer