PropelAuth

PropelAuth Role Mappings API

Manage custom role mappings per organization

GitHub OpenAPI

Operations 1

GET /api/backend/v1/custom_role_mappings Fetch Role Mappings #

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-role-mappings-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-role-mappings-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-role-mappings-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: PropelAuth Organization Role Mappings 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: Role Mappings
  description: Manage custom role mappings per organization
paths:
  /api/backend/v1/custom_role_mappings:
    get:
      summary: Fetch Role Mappings
      description: List custom role mappings configured for your project.
      operationId: fetchRoleMappings
      tags:
      - Role Mappings
      responses:
        '200':
          description: Role mappings
          content:
            application/json:
              schema:
                type: object
                properties:
                  custom_role_mappings:
                    type: array
                    items:
                      $ref: '#/components/schemas/RoleMapping'
components:
  schemas:
    RoleMapping:
      type: object
      properties:
        custom_role_mapping_name:
          type: string
        num_orgs_subscribed:
          type: integer
        roles:
          type: array
          items:
            type: object
            properties:
              name:
                type: string
              description:
                type: string
              is_internal:
                type: boolean
              is_visible_to_end_user:
                type: boolean
              permissions:
                type: array
                items:
                  type: string
  securitySchemes:
    BackendApiKey:
      type: http
      scheme: bearer