Esper esper_cloud_api_SSO Connections API

openapi: 3.2.0
info:
  title: ESPER API REFERENCE esper_cloud_api_SSO Connections API
  x-logo:
    url: esper-logo-white.svg
    backgroundColor: '#141418'
    altText: Logo
  description: '# Introduction

    Welcome to Esper’s API documentation. The Esper API allows users to accomplish operations outside of the console. Some common uses for our APIs include observing device information and console activity, installing and updating apps, uploading files, and sending files to devices. Our users have also used the API to automate app updates, perform bulk actions, and more. Esper API endpoints use REST-based architecture and return JSON responses. See our documentation for:


    * Getting started guides

    * Commonly used API examples

    * API command examples

    * Automated Script examples

    * And more


    # Authentication


    You need to create an API Key to interact with our APIs. Learn more about generating an API Key. You can also learn more about Esper and sign up for an account at esper.io/signup. Some endpoints also require an Enterprise ID. This ID can be found in the API Management section of the Esper console. # Lifecycle Labels


    Esper uses lifecycle labels to communicate the support status of each API endpoint. Use the following table to understand what each label means and how to respond. Badge

    What it means

    Recommended action


    Stable

    This endpoint is fully supported and safe for production use. No action needed. Beta

    This endpoint is publicly available but may change. It is not recommended for production integrations. Use with caution. Monitor the API changelog for updates before relying on this endpoint. Legacy

    This endpoint uses an older architecture and is still supported, but a newer equivalent exists. It is not recommended for new integrations. Plan migration to the recommended replacement when possible. See the endpoint description for the alternative. Deprecated

    This endpoint has stopped being supported. A removal date may be added at a later time. A replacement is available or the feature is entirely retired. Migrate before the removal date listed in the endpoint description. Do not use this endpoint in new integrations. # Pagination


    Responses may be paginated. Use the following parameters to query the data. A full list of parameters can be found on the endpoint’s documentation page. Parameter

    Data Type

    Explanation


    limit

    integer

    Limit the data returned. Default = 20. offset

    integer

    Offset to the first item returned. Default = 0. ordering

    string

    Order the results set by the field name. Varies by endpoint. next

    string

    Paginate to the next response set. previous

    string

    Paginate to the last set response. # Errors

    We use standard HTTP status codes for success or failure. A typical error response may look something like this:


    ```json

    {

    "errors": [],

    "message": "error message",

    "status": 400

    }

    ```

    * `errors` - List of error details

    * `message` - Error description

    * `status` - HTTP status code


    Some common status codes and messages are:


    Number

    Message

    Explanation


    200

    OK

    The request succeeded. 201

    Resource creation

    A resource was created. 401

    Unauthorized

    The API key is invalid. 404

    Not found

    The resource was not found. 429

    Rate limit exceeded

    Too many requests. Wait a moment and try again. 500

    Server error

    Internal error. Wait a moment and try again. If the issue persists, contact Esper. See how our systems are doing by checking our status page. # Rate Limits

    To ensure quality of service for all customers, we enforce rate limits for API requests. Most customers won’t hit this limit with normal use. In case you experience 429 or rate limit exceeded errors, we recommend the following:

    * Try sending requests in batches. * Begin with about 20 requests at a time and building up from there. * Ensure your scripts are efficient and don’t contain redundant calls. * Reach out to your account manager to discuss your options.'
  termsOfService: https://esper.io/terms-of-service
  contact:
    email: developer@esper.io
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
  version: 1.0.0
  x-prefix-tag: esper cloud api
servers:
- url: https://{foo}-api.esper.cloud/api
  variables:
    foo:
      default: develop
      description: Custom end point
tags:
- name: esper_cloud_api_SSO Connections
  x-displayName: SSO Connections
paths:
  /authn2/v0/tenant/{enterprise_id}/connection:
    get:
      x-badges:
      - name: Stable
        color: green
      tags:
      - esper_cloud_api_SSO Connections
      summary: List SSO connections
      description: 'Lists the SSO connections configured for a tenant. Use it to see every SAML or OIDC identity provider connection set up for the enterprise, along with which one is marked as default.


        Returns a count and an array of connections, each with its connection ID and connection details (name, strategy, is_default). Supports filtering by is_default.


        **About SSO Connections**


        SSO connections let a tenant authenticate users through an external identity provider using SAML (samlp) or OIDC (oidc) rather than Esper''s native login. A tenant can have multiple connections configured, with one designated as the default. Learn more.


        **Key Fields / Query Parameters**


        - is_default — optional query filter to return only the connection marked as default

        - strategy — indicates whether a connection is samlp (SAML) or oidc (OIDC)


        **Common Use Cases**


        - Auditing which identity providers are connected to a tenant

        - Looking up a connection_id before calling the edit-connection endpoint

        List SSO connections of a tenant. Learn more about SSO Connections.'
      operationId: getConnections
      security:
      - esper_cloud_api_apiKey: []
      parameters:
      - $ref: '#/components/parameters/esper_cloud_api_EnterpriseID'
      - $ref: '#/components/parameters/esper_cloud_api_IsDefault'
      responses:
        '200':
          description: Tenant connections
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                  connections:
                    type: array
                    items:
                      $ref: '#/components/schemas/esper_cloud_api_CustomConnectionsListResponse'
        '400':
          description: List custom connections error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/esper_cloud_api_GenericErrorResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/esper_cloud_api_GenericErrorResponse'
  /authn2/v0/tenant/{enterprise_id}/connection/{connection_id}:
    put:
      x-badges:
      - name: Stable
        color: green
      tags:
      - esper_cloud_api_SSO Connections
      summary: Edit SSO connections
      description: 'Updates an existing SSO connection for a tenant, identified by connection_id. Use it to change a connection''s display name, strategy, or provider configuration (SAML or OIDC settings) after it''s been created.


        Requires a full request body (display_name, strategy, and the strategy-specific config block); returns the updated connection, including its service provider ACS URL, entity ID, logout URL, and signing certificate link where applicable.


        **About SSO Connections**


        SSO connections let a tenant authenticate users through an external identity provider using SAML (samlp) or OIDC (oidc). Editing a connection updates the underlying provider configuration Esper uses to negotiate SSO logins for that tenant. Learn more.


        **Key Fields / Query Parameters**


        - strategy — samlp or oidc, determines which config fields apply

        - config.sign_in_url / config.x509_certificate — required for SAML connections

        - config.issuer_url / config.client_id — required for OIDC connections


        **Common Use Cases**


        - Rotating a SAML signing certificate or updating an OIDC client ID

        - Renaming a connection''s display name


        **Best Practices**


        - Confirm which strategy (samlp vs oidc) the connection uses before submitting config fields, since each strategy requires different config properties'
      operationId: editCustomConnection
      security:
      - esper_cloud_api_apiKey: []
      parameters:
      - $ref: '#/components/parameters/esper_cloud_api_EnterpriseID'
      - $ref: '#/components/parameters/esper_cloud_api_ConnectionID'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/esper_cloud_api_CustomConnectionRequest'
      responses:
        '200':
          description: Updated connection
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/esper_cloud_api_CustomConnectionResponse'
        '400':
          description: custom connection update error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/esper_cloud_api_GenericErrorResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/esper_cloud_api_GenericErrorResponse'
        '403':
          description: Forbidden, no permission to perform this action.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/esper_cloud_api_ErrorResponse'
components:
  schemas:
    esper_cloud_api_CustomConnectionList:
      title: CustomConnectionList
      type: object
      properties:
        name:
          title: name
          type: string
        strategy:
          title: strategy
          enum:
          - samlp
          - oidc
          description: "Strategy:\n * `samlp` - SAML connection\n * `oidc` - OIDC connection\n"
        is_default:
          title: is default
          type: boolean
    esper_cloud_api_CustomConnectionRequest:
      title: CustomConnectionRequest
      type: object
      properties:
        display_name:
          title: display name
          type: string
        strategy:
          title: strategy
          enum:
          - samlp
          - oidc
          description: "Strategy:\n * `samlp` - SAML connection\n * `oidc` - OIDC connection\n"
        config:
          type: object
          $ref: '#/components/schemas/esper_cloud_api_CustomConnectionConfigResponse'
    esper_cloud_api_CustomConnectionsListResponse:
      title: CustomConnectionsListResponse
      type: object
      properties:
        connection_id:
          title: connection id
          type: string
        connection:
          type: object
          $ref: '#/components/schemas/esper_cloud_api_CustomConnectionList'
    esper_cloud_api_ErrorResponse:
      type: object
      properties:
        errors:
          title: Messages describing the error
          type: array
          items:
            type: string
        message:
          title: Message describing the error
          type: string
        status:
          title: alias name
          type: integer
    esper_cloud_api_CustomConnectionResponse:
      title: CustomConnectionResponse
      type: object
      properties:
        id:
          title: id
          type: string
        name:
          title: name
          type: string
        display_name:
          title: display name
          type: string
        strategy:
          title: strategy
          enum:
          - samlp
          - oidc
          description: "Strategy:\n * `samlp` - SAML connection\n * `oidc` - OIDC connection\n"
        service_provider_acs_url:
          title: service provider ACS url
          type: string
          format: url
        service_provider_entity_id:
          title: service provider entity id
          type: string
        service_provider_logout_url:
          title: service provider logout url
          type: string
        signing_certificate_link:
          title: signing certificate link
          type: string
        callback_url:
          title: callback url
          type: string
          format: url
        config:
          type: object
          $ref: '#/components/schemas/esper_cloud_api_CustomConnectionConfigResponse'
    esper_cloud_api_GenericErrorResponse:
      type: object
      properties:
        status:
          type: integer
          format: int32
          description: Either 'status' or 'code' will be present, but not both.
        code:
          type: integer
          format: int32
          description: Either 'status' or 'code' will be present, but not both.
        error:
          type: string
          description: Either 'error' or 'errors' will be present, but not both.
        errors:
          type: array
          items:
            type: string
          description: Either 'error' or 'errors' will be present, but not both.
        message:
          title: Message describing the error
          type: string
    esper_cloud_api_CustomConnectionConfigResponse:
      title: CustomConnectionConfigResponse
      type: object
      properties:
        sign_in_url:
          title: Sign in url
          type: string
          format: url
          description: Required for SAML connection
        disable_sign_out:
          title: Disable sign out
          type: boolean
        sign_out_url:
          title: Sign out url
          type: string
          format: url
        x509_certificate:
          title: x509 certificate
          type: string
          description: Required for SAML connection
        issuer_url:
          title: Issuer url
          type: string
          format: url
          description: Required for OIDC connection
        client_id:
          title: client id
          type: string
          description: Required for OIDC connection
  parameters:
    esper_cloud_api_ConnectionID:
      name: connection_id
      description: Connection ID
      in: path
      required: true
      schema:
        type: string
        format: uuid
    esper_cloud_api_IsDefault:
      name: is_default
      description: Is Default
      in: query
      required: false
      schema:
        type: boolean
    esper_cloud_api_EnterpriseID:
      name: enterprise_id
      description: Enterprise ID
      in: path
      required: true
      schema:
        type: string
        format: uuid
  securitySchemes:
    esper_cloud_api_apiKey:
      type: http
      scheme: bearer
      description: "#### API KEY - Access Token\nAccess token for API is passed as authorization header in calls. You need to generate this from your Esper Console at `<domain>-api.esper.cloud` where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions [in this Help article](https://help.esper.io/hc/en-us/articles/12656959508497) to generate an access token.\nOnce you have the access token, you need to send an authorization header as below\n\n```bash\n\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n```\n\n> Please note the use of keyword **Bearer** before the token value.\n\n\nYou can read more about api key authentication [here](https://help.esper.io/hc/en-us/articles/12656959508497).\n"
    pipelines_SCAPIAuthToken:
      type: http
      scheme: bearer
    device_apiKey:
      type: http
      scheme: bearer
      description: "#### API KEY - Access Token\nAccess token for API is passed as authorization header in calls. You need to generate this from your Esper Console at `<domain>-api.esper.cloud` where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions [in this Help article](https://help.esper.io/hc/en-us/articles/12656959508497) to generate an access token.\nOnce you have the access token, you need to send an authorization header as below\n\n```bash\n\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n```\n\n> Please note the use of keyword **Bearer** before the token value.\n\n\nYou can read more about api key authentication [here](https://help.esper.io/hc/en-us/articles/12656959508497).\n"
    apps_management_apiKey:
      type: http
      scheme: bearer
      description: "#### API KEY - Access Token\nAccess token for API is passed as authorization header in calls. You need to generate this from your Esper Console at `<domain>-api.esper.cloud` where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions [in this Help article](https://help.esper.io/hc/en-us/articles/12656959508497) to generate an access token.\nOnce you have the access token, you need to send an authorization header as below\n\n```bash\n\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n```\n\n> Please note the use of keyword **Bearer** before the token value.\n\n\nYou can read more about api key authentication [here](https://help.esper.io/hc/en-us/articles/12656959508497).\n"
    commands_apiKey:
      type: http
      scheme: bearer
      description: "#### API KEY - Access Token\nAccess token for API is passed as authorization header in calls. You need to generate this from your Esper Console at `<domain>-api.esper.cloud` where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions [in this Help article](https://help.esper.io/hc/en-us/articles/12656959508497) to generate an access token.\nOnce you have the access token, you need to send an authorization header as below\n\n```bash\n\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n```\n\n> Please note the use of keyword **Bearer** before the token value.\n\n\nYou can read more about api key authentication [here](https://help.esper.io/hc/en-us/articles/12656959508497).\n"
    drift_apiKey:
      type: http
      scheme: bearer
      description: "#### API KEY - Access Token\nAccess token for API is passed as authorization header in calls. You need to generate this from your Esper Console at `<domain>-api.esper.cloud` where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions [in this Help article](https://help.esper.io/hc/en-us/articles/12656959508497) to generate an access token.\nOnce you have the access token, you need to send an authorization header as below\n\n```bash\n\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n```\n\n> Please note the use of keyword **Bearer** before the token value.\n\n\nYou can read more about api key authentication [here](https://help.esper.io/hc/en-us/articles/12656959508497).\n"
    device_onboarding_apiKey:
      type: http
      scheme: bearer
      description: "#### API KEY - Access Token\nAccess token for API is passed as authorization header in calls. You need to generate this from your Esper Console at `<domain>-api.esper.cloud` where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions [in this Help article](https://help.esper.io/hc/en-us/articles/12656959508497) to generate an access token.\nOnce you have the access token, you need to send an authorization header as below\n\n```bash\n\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n```\n\n> Please note the use of keyword **Bearer** before the token value.\n\n\nYou can read more about api key authentication [here](https://help.esper.io/hc/en-us/articles/12656959508497).\n"
    tenant_apiKey:
      type: http
      scheme: bearer
      description: "#### API KEY - Access Token\nAccess token for API is passed as authorization header in calls. You need to generate this from your Esper Console at `<domain>-api.esper.cloud` where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions [in this Help article](https://help.esper.io/hc/en-us/articles/12656959508497) to generate an access token.\nOnce you have the access token, you need to send an authorization header as below\n\n```bash\n\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n```\n\n> Please note the use of keyword **Bearer** before the token value.\n\n\nYou can read more about api key authentication [here](https://help.esper.io/hc/en-us/articles/12656959508497).\n"
    foundation_AuthToken:
      type: apiKey
      in: header
      name: Authorization
    reports_bearerAuth:
      type: http
      scheme: bearer
    geofence_bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
x-tagGroups:
- name: ESPER CLOUD API
  tags:
  - esper_cloud_api_Company Settings
  - esper_cloud_api_Application
  - esper_cloud_api_Application V1
  - esper_cloud_api_AndroidDevice
  - esper_cloud_api_Device Group
  - esper_cloud_api_Token (Deprecated)
  - esper_cloud_api_Commands V2
  - esper_cloud_api_Enterprise Policy
  - esper_cloud_api_Geofence
  - esper_cloud_api_Content
  - esper_cloud_api_User (Deprecated)
  - esper_cloud_api_User
  - esper_cloud_api_Blueprint (Deprecated)
  - esper_cloud_api_Directory Record
  - esper_cloud_api_Tile Icon
  - esper_cloud_api_Alerts
  - esper_cloud_api_Alarms
  - esper_cloud_api_Wallpapers
  - esper_cloud_api_Device Telemetry
  - esper_cloud_api_Daily and Custom Reports
  - esper_cloud_api_SSO Connections
  - esper_cloud_api_Roles
  - esper_cloud_api_Personal Access Token
- name: BLUEPRINTS
  tags:
  - blueprints_Blueprints API
  - blueprints_Custom Actions API
  - blueprints_Background Scripts API
- name: PIPELINES
  tags:
  - pipelines_System Status Code
  - pipelines_System
  - pipelines_Pipelines
  - pipelines_Stages
  - pipelines_Target Lists
  - pipelines_Targets
  - pipelines_Device Groups
  - pipelines_Operation Lists
  - pipelines_Operations
  - pipelines_Pipeline Runs
  - pipelines_Stage Runs
  - pipelines_Target Runs
- name: DEVICE
  tags:
  - device_Device
  - device_Device Heartbeat
  - device_Device Apps
  - device_Device Enrollment in EMM
  - device_Operations
  - device_DeviceOperations
  - device_MultiOS Remote Viewer
- name: APPS MANAGEMENT
  tags:
  - apps_management_VPP License Management
  - apps_management_VPP App Management
  - apps_management_Tenant Apps
  - apps_management_Apple App Store
  - apps_management_App List
  - apps_management_Webclips
  - apps_management_Provisioning Profiles
  - apps_management_Preferred Regions
  - apps_management_OEM Config Schema
  - apps_management_Esper Apps
  - apps_management_Tenant Esper Apps
- name: COMMANDS
  tags:
  - commands_Command Request
  - commands_Command Status
- name: DRIFT
  tags:
  - drift_Converge
  - drift_Converge Command
  - drift_Blueprint Drift
- name: DEVICE ONBOARDING
  tags:
  - device_onboarding_DEP Sync Request
  - device_onboarding_ABM Provisioning
- name: TENANT
  tags:
  - tenant_APNs certificate
  - tenant_DEP Profile
  - tenant_DEP Tokens
  - tenant_VPP Token Management
  - tenant_Google Enterprise
  - tenant_MDM Service Config
- name: FOUNDATION
  tags:
  - foundation_FoundryBuilds
  - foundation_FoundryDeviceModels
  - foundation_FoundryEvents
- name: REPORTS
  tags:
  - reports_Reports API
- name: GEOFENCE
  tags:
  - geofence_Geofences
  - geofence_Device State
x-provenance:
  method: harvested
  publisher: Esper
  source: https://api.esper.io/_bundle/openapi.json?download
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)