Openpath orgs/identityProviders API

Identity Providers and OAuth2

Operations 11

GET /orgs/{orgId}/identityProviders List all identity providers #
GET /orgs/{orgId}/identityProviders/{identityProviderId} Describe an identity provider #
GET /orgs/{orgId}/identityProviders/{identityProviderId}/groupRelations Describe an identity provider's group relations #
PUT /orgs/{orgId}/identityProviders/{identityProviderId}/groupRelations Set an identity provider's group relations #
GET /orgs/{orgId}/identityProviders/{identityProviderId}/groups List an identity provider's groups #
POST /orgs/{orgId}/identityProviders/{identityProviderId}/syncUsers Sync users #
POST /orgs/{orgId}/identityProviders/{identityProviderId}/oauth2/authorize Generate OAuth2 authorize URL #
DELETE /orgs/{orgId}/identityProviders/{identityProviderId}/groupRelation Remove a group relation from an identity provider #
PUT /orgs/{orgId}/identityProviders/{identityProviderId}/groupRelation Add a group relation to an identity provider #
PUT /orgs/{orgId}/identityProviders/{identityProviderId}/userCustomMapping Set an identity provider's user custom fields mapping #
PUT /orgs/{orgId}/identityProviders/{identityProviderId}/inactivate Inactivate an identity provider and all associated identities and users #

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/openpath-orgs-identityproviders-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.

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

OpenAPI Specification

openpath-orgs-identityproviders-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Openpath API Documentation auth Orgs/identity Providers API
  version: 1.0.0
  description: Authentication and Login
servers:
- url: https://api.openpath.com
tags:
- name: orgs/identityProviders
  description: Identity Providers and OAuth2
paths:
  /orgs/{orgId}/identityProviders:
    get:
      summary: List all identity providers
      operationId: listIdentityProviders
      description: '__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-account:r,o{params.orgId}-account:w,o{params.orgId}-admin:r,o{params.orgId}-admin:w,o{params.orgId}-advancedOxygenReports:r,o{params.orgId}-advancedOxygenReports:w,o{params.orgId}-alarmActions:w,o{params.orgId}-alarmConfigurations:r,o{params.orgId}-alarmConfigurations:w,o{params.orgId}-alertSettings:r,o{params.orgId}-alertSettings:w,o{params.orgId}-badgePrinting:r,o{params.orgId}-badgePrinting:w,o{params.orgId}-building:r,o{params.orgId}-building:w,o{params.orgId}-cert:r,o{params.orgId}-cert:w,o{params.orgId}-cert{params.authCertId}:r,o{params.orgId}-cert{params.authCertId}:w,o{params.orgId}-cleanupMsiAware:w,o{params.orgId}-cobalt:r,o{params.orgId}-cobalt:w,o{params.orgId}-configurations:r,o{params.orgId}-configurations:w,o{params.orgId}-credential:r,o{params.orgId}-credential:w,o{params.orgId}-dash:r,o{params.orgId}-dash:w,o{params.orgId}-dashActivity:r,o{params.orgId}-dashActivity:w,o{params.orgId}-dashAlarm:r,o{params.orgId}-dashAlarm:w,o{params.orgId}-dashCust:r,o{params.orgId}-dashCust:w,o{params.orgId}-dashEntry:r,o{params.orgId}-dashEntry:w,o{params.orgId}-entryAccessAudit:r,o{params.orgId}-entryAccessAudit:w,o{params.orgId}-entryState:r,o{params.orgId}-entryState:w,o{params.orgId}-erpParentCenter:w,o{params.orgId}-erpParentStore:w,o{params.orgId}-eventsMsiAware:w,o{params.orgId}-exportClips:w,o{params.orgId}-haloAdmin:w,o{params.orgId}-haloUser:w,o{params.orgId}-haloViewer:r,o{params.orgId}-hw:r,o{params.orgId}-hw:w,o{params.orgId}-idp-scim:r,o{params.orgId}-idp-scim:w,o{params.orgId}-integrations:r,o{params.orgId}-integrations:w,o{params.orgId}-ipRestriction:r,o{params.orgId}-ipRestriction:w,o{params.orgId}-ldp:r,o{params.orgId}-ldp:w,o{params.orgId}-map:r,o{params.orgId}-map:w,o{params.orgId}-mobileAppSettings:r,o{params.orgId}-mobileAppSettings:w,o{params.orgId}-musterReport:r,o{params.orgId}-musterReport:w,o{params.orgId}-occupancyReport:r,o{params.orgId}-occupancyReport:w,o{params.orgId}-opvideoDevice:r,o{params.orgId}-opvideoDevice:w,o{params.orgId}-opvideoIntercom:r,o{params.orgId}-opvideoIntercom:w,o{params.orgId}-outboundWebhooks:r,o{params.orgId}-outboundWebhooks:w,o{params.orgId}-parcelMgmtParcels:r,o{params.orgId}-parcelMgmtParcels:w,o{params.orgId}-portalAudit:r,o{params.orgId}-portalAudit:w,o{params.orgId}-policy:r,o{params.orgId}-policy:w,o{params.orgId}-policySection:r,o{params.orgId}-policySection:w,o{params.orgId}-presence:r,o{params.orgId}-presence:w,o{params.orgId}-quickStart:r,o{params.orgId}-quickStart:w,o{params.orgId}-realUserGroup:r,o{params.orgId}-realUserGroup:w,o{params.orgId}-restriction:r,o{params.orgId}-restriction:w,o{params.orgId}-role:r,o{params.orgId}-role:w,o{params.orgId}-rpt:r,o{params.orgId}-rpt:w,o{params.orgId}-rptAlarm:r,o{params.orgId}-rptAlarm:w,o{params.orgId}-rptDownload:r,o{params.orgId}-rptGeneral:r,o{params.orgId}-rptGeneral:w,o{params.orgId}-serviceCancellation:w,o{params.orgId}-site:r,o{params.orgId}-site:w,o{params.orgId}-siteGeneral:r,o{params.orgId}-siteGeneral:w,o{params.orgId}-sos:w,o{params.orgId}-timeRestriction:r,o{params.orgId}-timeRestriction:w,o{params.orgId}-user:r,o{params.orgId}-user:w,o{params.orgId}-videoAdmin:w,o{params.orgId}-videoProviderLive:w,o{params.orgId}-videoProviderPlayback:w,o:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: listIdentityProviders'
      parameters:
      - name: orgId
        in: path
        required: true
        schema:
          type: integer
      - name: limit
        in: query
        schema:
          type: integer
          maximum: 1000
          minimum: 1
      - name: offset
        in: query
        schema:
          type: integer
          default: 0
          minimum: 0
      - name: sort
        in: query
        schema:
          type: string
          default: id
          pattern: ^[a-zA-Z0-9.]+(,\s*[a-zA-Z0-9.]+)*$
      - name: order
        in: query
        schema:
          type: string
          default: asc
          pattern: ^(asc|desc)+(,\s*(asc|desc)+)*$
      - name: q
        in: query
        schema:
          type: string
      - name: filter
        in: query
        schema:
          type: string
      - name: preFilter
        in: query
        schema:
          type: string
      tags:
      - orgs/identityProviders
      security:
      - jwt: []
      responses:
        '200':
          description: Successful
          content:
            application/json:
              schema:
                type: object
                properties:
                  totalCount:
                    type: integer
                  filteredCount:
                    type: integer
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: number
                        orgId:
                          type: number
                        identityProviderType:
                          type: object
                          properties:
                            id:
                              type: number
                            name:
                              type: string
                            code:
                              type: string
                          required:
                          - id
                        identityProviderSyncType:
                          type:
                          - object
                          - 'null'
                          properties:
                            id:
                              type: number
                            name:
                              type: string
                            code:
                              type: string
                          required:
                          - id
                        authStrategyType:
                          type:
                          - object
                          - 'null'
                          properties:
                            id:
                              type: number
                            name:
                              type: string
                            code:
                              type: string
                          required:
                          - id
                        apiKey:
                          type:
                          - object
                          - 'null'
                          properties:
                            key:
                              type: string
                              pattern: ^\*\*\*\*$
                            url:
                              type: string
                        isSyncUsersEnabled:
                          type: boolean
                        isMobileCredentialEnabled:
                          type: boolean
                        isCloudKeyCredentialEnabled:
                          type: boolean
                        isWalletCredentialEnabled:
                          type: boolean
                        isSsoEnabled:
                          type: boolean
                        isMobileSsoEnabled:
                          type: boolean
                        isIdpInitiatedSsoEnabled:
                          type: boolean
                        isRemoveGroupsEnabled:
                          type: boolean
                        isLimitByGroupEnabled:
                          type: boolean
                        isSyncPersonIdEnabled:
                          type: boolean
                        isSyncDepartmentEnabled:
                          type: boolean
                        isSyncTitleEnabled:
                          type: boolean
                        isSyncMobilePhoneEnabled:
                          type: boolean
                        isAutoManageVideoUserGroupsEnabled:
                          type: boolean
                        nextSyncAt:
                          type:
                          - string
                          - 'null'
                          format: date
                        lastSyncedAt:
                          type:
                          - string
                          - 'null'
                          format: date
                        lastSyncedMessage:
                          type:
                          - string
                          - 'null'
                        lastSyncFailureAt:
                          type:
                          - string
                          - 'null'
                          format: date
                        lastSyncFailureMessage:
                          type:
                          - string
                          - 'null'
                        lastSyncAttemptAt:
                          type:
                          - string
                          - 'null'
                          format: date
                        lastSyncAttemptStatus:
                          type:
                          - string
                          - 'null'
                        isSyncUsersRequested:
                          type: boolean
                        status:
                          type: string
                        namespace:
                          type: object
                          properties:
                            id:
                              type: number
                            nickname:
                              type: string
                          required:
                          - id
                        createdAt:
                          type: string
                          format: date
                        updatedAt:
                          type: string
                          format: date
                        uuid:
                          type:
                          - string
                          - 'null'
                        samlConfig:
                          type:
                          - object
                          - 'null'
                          properties:
                            id:
                              type: integer
                            issuer:
                              type:
                              - string
                              - 'null'
                            ssoUrl:
                              type:
                              - string
                              - 'null'
                            logoutUrl:
                              type:
                              - string
                              - 'null'
                            certificate:
                              type:
                              - string
                              - 'null'
                            entityId:
                              type:
                              - string
                              - 'null'
                            assertionUrl:
                              type:
                              - string
                              - 'null'
                          required:
                          - id
                        oidcConfig:
                          type:
                          - object
                          - 'null'
                          properties:
                            clientId:
                              type:
                              - string
                              - 'null'
                            subdomain:
                              type: string
                        clientAuth:
                          type:
                          - object
                          - 'null'
                          properties:
                            clientId:
                              type: string
                            clientSecret:
                              type: string
                            tenantId:
                              type: string
                            url:
                              type: string
                        basicAuth:
                          type:
                          - object
                          - 'null'
                          properties:
                            url:
                              type: string
                            authCreds:
                              type: string
                            groupsUrl:
                              type: string
                        scimAttributeMapping:
                          type:
                          - object
                          - 'null'
                          properties:
                            rules:
                              type: array
                              items:
                                type: object
                                properties:
                                  type:
                                    type: string
                                    enum:
                                    - specific
                                    - template
                                  mappings:
                                    x-alternatives:
                                    - type: array
                                      items:
                                        type: object
                                        properties:
                                          conditions:
                                            type: array
                                            items:
                                              type: object
                                              properties:
                                                key:
                                                  type: string
                                                value:
                                                  type: string
                                                  x-alternatives:
                                                  - type: string
                                                  - type: number
                                                  - type: boolean
                                              required:
                                              - key
                                              - value
                                          destinations:
                                            type: array
                                            items:
                                              type: object
                                              properties:
                                                roleIds:
                                                  type: array
                                                  items:
                                                    type: integer
                                                accessGroupIds:
                                                  type: array
                                                  items:
                                                    type: integer
                                                videoUserGroupIds:
                                                  type: array
                                                  items:
                                                    type: string
                                        required:
                                        - conditions
                                        - destinations
                                    - type: array
                                      items:
                                        type: object
                                        properties:
                                          destinations:
                                            type: array
                                            items:
                                              type: object
                                              properties:
                                                roleTemplates:
                                                  type: array
                                                  items:
                                                    type: string
                                                accessGroupTemplates:
                                                  type: array
                                                  items:
                                                    type: string
                                        required:
                                        - destinations
                                    type: array
                                    items:
                                      type: object
                                      properties:
                                        conditions:
                                          type: array
                                          items:
                                            type: object
                                            properties:
                                              key:
                                                type: string
                                              value:
                                                type: string
                                                x-alternatives:
                                                - type: string
                                                - type: number
                                                - type: boolean
                                            required:
                                            - key
                                            - value
                                        destinations:
                                          type: array
                                          items:
                                            type: object
                                            properties:
                                              roleIds:
                                                type: array
                                                items:
                                                  type: integer
                                              accessGroupIds:
                                                type: array
                                                items:
                                                  type: integer
                                              videoUserGroupIds:
                                                type: array
                                                items:
                                                  type: string
                                      required:
                                      - conditions
                                      - destinations
                                required:
                                - type
                        scimAccessTokens:
                          type: array
                          items:
                            type:
                            - object
                            - 'null'
                            properties:
                              id:
                                type: integer
                            required:
                            - id
                        userFieldMappings:
                          type:
                          - array
                          - 'null'
                          items:
                            type: object
                            properties:
                              destination:
                                type: string
                              sources:
                                type: array
                                items:
                                  type: string
                            required:
                            - destination
                            - sources
                      required:
                      - id
                      - orgId
                  meta:
                    type: object
                    properties:
                      accessToken:
                        type:
                        - object
                        - 'null'
                        properties:
                          scopeUpdatedAt:
                            type: string
                            format: date
                      siteSpecificAccess:
                        type:
                        - object
                        - 'null'
                        properties:
                          isSiteSpecific:
                            type: boolean
                          siteIds:
                            type:
                            - array
                            - 'null'
                            items:
                              type: integer
                          siteIdsByScope:
                            type:
                            - object
                            - 'null'
                            properties:
                              string:
                                type:
                                - array
                                - 'null'
                                items:
                                  type: integer
      x-op-scopes:
      - o{params.orgId}-account:r
      - o{params.orgId}-account:w
      - o{params.orgId}-admin:r
      - o{params.orgId}-admin:w
      - o{params.orgId}-advancedOxygenReports:r
      - o{params.orgId}-advancedOxygenReports:w
      - o{params.orgId}-alarmActions:w
      - o{params.orgId}-alarmConfigurations:r
      - o{params.orgId}-alarmConfigurations:w
      - o{params.orgId}-alertSettings:r
      - o{params.orgId}-alertSettings:w
      - o{params.orgId}-badgePrinting:r
      - o{params.orgId}-badgePrinting:w
      - o{params.orgId}-building:r
      - o{params.orgId}-building:w
      - o{params.orgId}-cert:r
      - o{params.orgId}-cert:w
      - o{params.orgId}-cert{params.authCertId}:r
      - o{params.orgId}-cert{params.authCertId}:w
      - o{params.orgId}-cleanupMsiAware:w
      - o{params.orgId}-cobalt:r
      - o{params.orgId}-cobalt:w
      - o{params.orgId}-configurations:r
      - o{params.orgId}-configurations:w
      - o{params.orgId}-credential:r
      - o{params.orgId}-credential:w
      - o{params.orgId}-dash:r
      - o{params.orgId}-dash:w
      - o{params.orgId}-dashActivity:r
      - o{params.orgId}-dashActivity:w
      - o{params.orgId}-dashAlarm:r
      - o{params.orgId}-dashAlarm:w
      - o{params.orgId}-dashCust:r
      - o{params.orgId}-dashCust:w
      - o{params.orgId}-dashEntry:r
      - o{params.orgId}-dashEntry:w
      - o{params.orgId}-entryAccessAudit:r
      - o{params.orgId}-entryAccessAudit:w
      - o{params.orgId}-entryState:r
      - o{params.orgId}-entryState:w
      - o{params.orgId}-erpParentCenter:w
      - o{params.orgId}-erpParentStore:w
      - o{params.orgId}-eventsMsiAware:w
      - o{params.orgId}-exportClips:w
      - o{params.orgId}-haloAdmin:w
      - o{params.orgId}-haloUser:w
      - o{params.orgId}-haloViewer:r
      - o{params.orgId}-hw:r
      - o{params.orgId}-hw:w
      - o{params.orgId}-idp-scim:r
      - o{params.orgId}-idp-scim:w
      - o{params.orgId}-integrations:r
      - o{params.orgId}-integrations:w
      - o{params.orgId}-ipRestriction:r
      - o{params.orgId}-ipRestriction:w
      - o{params.orgId}-ldp:r
      - o{params.orgId}-ldp:w
      - o{params.orgId}-map:r
      - o{params.orgId}-map:w
      - o{params.orgId}-mobileAppSettings:r
      - o{params.orgId}-mobileAppSettings:w
      - o{params.orgId}-musterReport:r
      - o{params.orgId}-musterReport:w
      - o{params.orgId}-occupancyReport:r
      - o{params.orgId}-occupancyReport:w
      - o{params.orgId}-opvideoDevice:r
      - o{params.orgId}-opvideoDevice:w
      - o{params.orgId}-opvideoIntercom:r
      - o{params.orgId}-opvideoIntercom:w
      - o{params.orgId}-outboundWebhooks:r
      - o{params.orgId}-outboundWebhooks:w
      - o{params.orgId}-parcelMgmtParcels:r
      - o{params.orgId}-parcelMgmtParcels:w
      - o{params.orgId}-portalAudit:r
      - o{params.orgId}-portalAudit:w
      - o{params.orgId}-policy:r
      - o{params.orgId}-policy:w
      - o{params.orgId}-policySection:r
      - o{params.orgId}-policySection:w
      - o{params.orgId}-presence:r
      - o{params.orgId}-presence:w
      - o{params.orgId}-quickStart:r
      - o{params.orgId}-quickStart:w
      - o{params.orgId}-realUserGroup:r
      - o{params.orgId}-realUserGroup:w
      - o{params.orgId}-restriction:r
      - o{params.orgId}-restriction:w
      - o{params.orgId}-role:r
      - o{params.orgId}-role:w
      - o{params.orgId}-rpt:r
      - o{params.orgId}-rpt:w
      - o{params.orgId}-rptAlarm:r
      - o{params.orgId}-rptAlarm:w
      - o{params.orgId}-rptDownload:r
      - o{params.orgId}-rptGeneral:r
      - o{params.orgId}-rptGeneral:w
      - o{params.orgId}-serviceCancellation:w
      - o{params.orgId}-site:r
      - o{params.orgId}-site:w
      - o{params.orgId}-siteGeneral:r
      - o{params.orgId}-siteGeneral:w
      - o{params.orgId}-sos:w
      - o{params.orgId}-timeRestriction:r
      - o{params.orgId}-timeRestriction:w
      - o{params.orgId}-user:r
      - o{params.orgId}-user:w
      - o{params.orgId}-videoAdmin:w
      - o{params.orgId}-videoProviderLive:w
      - o{params.orgId}-videoProviderPlayback:w
      - o:w
      - o:r
      - s-o:w
      - s-o:r
  /orgs/{orgId}/identityProviders/{identityProviderId}:
    get:
      summary: Describe an identity provider
      operationId: describeIdentityProvider
      description: '__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-user:w,o{params.orgId}-user:r,o:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: describeIdentityProvider'
      parameters:
      - name: orgId
        in: path
        required: true
        schema:
          type: integer
      - name: identityProviderId
        in: path
        required: true
        schema:
          type: integer
      tags:
      - orgs/identityProviders
      security:
      - jwt: []
      responses:
        '200':
          description: Successful
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: number
                      orgId:
                        type: number
                      identityProviderType:
                        type: object
                        properties:
                          id:
                            type: number
                          name:
                            type: string
                          code:
                            type: string
                        required:
                        - id
                      identityProviderSyncType:
                        type:
                        - object
                        - 'null'
                        properties:
                          id:
                            type: number
                          name:
                            type: string
                          code:
                            type: string
                        required:
                        - id
                      authStrategyType:
                        type:
                        - object
                        - 'null'
                        properties:
                          id:
                            type: number
                          name:
                            type: string
                          code:
                            type: string
                        required:
                        - id
                      apiKey:
                        type:
                        - object
                        - 'null'
                        properties:
                          key:
                            type: string
                            pattern: ^\*\*\*\*$
                          url:
                            type: string
                      isSyncUsersEnabled:
                        type: boolean
                      isMobileCredentialEnabled:
                        type: boolean
                      isCloudKeyCredentialEnabled:
                        type: boolean
                      isWalletCredentialEnabled:
                        type: boolean
                      isSsoEnabled:
                        type: boolean
                      isMobileSsoEnabled:
                        type: boolean
                      isIdpInitiatedSsoEnabled:
                        type: boolean
                      isRemoveGroupsEnabled:
                        type: boolean
                      isLimitByGroupEnabled:
                        type: boolean
                      isSyncPersonIdEnabled:
                        type: boolean
                      isSyncDepartmentEnabled:
                        type: boolean
                      isSyncTitleEnabled:
                        type: boolean
                      isSyncMobilePhoneEnabled:
                        type: boolean
                      isAutoManageVideoUserGroupsEnabled:
                        type: boolean
                      nextSyncAt:
                        type:
                        - string
                        - 'null'
                        format: date
                      lastSyncedAt:
                        type:
                        - string
                        - 'null'
                        format: date
                      lastSyncedMessage:
                        type:
                        - string
                        - 'null'
                      lastSyncFailureAt:
                        type:
                        - string
                        - 'null'
                        format: date
                      lastSyncFailureMessage:
                        type:
                        - string
                        - 'null'
                      lastSyncAttemptAt:
                        type:
                        - string
                        - 'null'
                        format: date
                      lastSyncAttemptStatus:
                        type:
                        - string
                        - 'null'
                      isSyncUsersRequested:
                        type: boolean
                      status:
                        type: string
                      namespace:
                        type: object
                        properties:
                          id:
                            type: number
                          nickname:
                            type: string
                        required:
                        - id
                      createdAt:
                        type: string
                        format: date
                      updatedAt:
                        type: string
                        format: date
                      uuid:
                        type:
                        - string
                        - 'null'
                      samlConfig:
                        type:
                        - object
                        - 'null'
                        properties:
                          id:
                            type: integer
                          issuer:
                            type:
                            - string
                            - 'null'
                          ssoUrl:
                            type:
                            - string
                            - 'null'
                          logoutUrl:
                            type:
                            - string
                            - 'null'
                          certificate:
                            type:
                            - string
                            - 'null'
                          entityId:
                            type:
                            - string


# --- truncated at 32 KB (59 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/openpath/refs/heads/main/openapi/openpath-orgs-identityproviders-api-openapi.yml