> ## Documentation Index
> Fetch the complete documentation index at: https://ngrok.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Get



## OpenAPI

````yaml https://raw.githubusercontent.com/ngrok/ngrok-openapi/refs/heads/main/ngrok.yaml get /edges/https/{edge_id}/routes/{id}/saml
openapi: 3.0.0
info:
  title: ngrok OpenAPI
  version: 1.0.0
servers:
  - url: https://api.ngrok.com
security:
  - authentication: []
paths:
  /edges/https/{edge_id}/routes/{id}/saml:
    get:
      tags:
        - EdgeRouteSAMLModule
      summary: Get
      operationId: EdgeRouteSamlModuleGet
      parameters:
        - $ref: '#/components/parameters/ngrokVersion'
        - name: edge_id
          description: |
            unique identifier of this edge
          in: path
          required: true
          schema:
            type: string
        - name: id
          description: |
            unique identifier of this edge route
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: n/a
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EndpointSAML'
components:
  parameters:
    ngrokVersion:
      name: ngrok-version
      in: header
      required: true
      schema:
        type: integer
        default: 2
  schemas:
    EndpointSAML:
      type: object
      properties:
        enabled:
          description: >
            `true` if the module will be applied to traffic, `false` to disable.
            default `true` if unspecified
          type: boolean
        options_passthrough:
          description: >
            Do not enforce authentication on HTTP OPTIONS requests. necessary if
            you are supporting CORS.
          type: boolean
        cookie_prefix:
          description: >
            the prefix of the session cookie that ngrok sets on the http client
            to cache authentication. default is 'ngrok.'
          type: string
        inactivity_timeout:
          description: >
            Integer number of seconds of inactivity after which if the user has
            not accessed the endpoint, their session will time out and they will
            be forced to reauthenticate.
          type: integer
        maximum_duration:
          description: >
            Integer number of seconds of the maximum duration of an
            authenticated session. After this period is exceeded, a user must
            reauthenticate.
          type: integer
        idp_metadata:
          description: >
            The full XML IdP EntityDescriptor. Your IdP may provide this to you
            as a a file to download or as a URL.
          type: string
        force_authn:
          description: >
            If true, indicates that whenever we redirect a user to the IdP for
            authentication that the IdP must prompt the user for authentication
            credentials even if the user already has a valid session with the
            IdP.
          type: boolean
        allow_idp_initiated:
          description: >
            If true, the IdP may initiate a login directly (e.g. the user does
            not need to visit the endpoint first and then be redirected). The
            IdP should set the `RelayState` parameter to the target URL of the
            resource they want the user to be redirected to after the SAML login
            assertion has been processed.
          type: boolean
        authorized_groups:
          description: >
            If present, only users who are a member of one of the listed groups
            may access the target endpoint.
          type: array
          items:
            type: string
        entity_id:
          description: >
            The SP Entity's unique ID. This always takes the form of a URL. In
            ngrok's implementation, this URL is the same as the metadata URL.
            This will need to be specified to the IdP as configuration.
          type: string
        assertion_consumer_service_url:
          description: >
            The public URL of the SP's Assertion Consumer Service. This is where
            the IdP will redirect to during an authentication flow. This will
            need to be specified to the IdP as configuration.
          type: string
        single_logout_url:
          description: >
            The public URL of the SP's Single Logout Service. This is where the
            IdP will redirect to during a single logout flow. This will
            optionally need to be specified to the IdP as configuration.
          type: string
        request_signing_certificate_pem:
          description: >
            PEM-encoded x.509 certificate of the key pair that is used to sign
            all SAML requests that the ngrok SP makes to the IdP. Many IdPs do
            not support request signing verification, but we highly recommend
            specifying this in the IdP's configuration if it is supported.
          type: string
        metadata_url:
          description: >
            A public URL where the SP's metadata is hosted. If an IdP supports
            dynamic configuration, this is the URL it can use to retrieve the SP
            metadata.
          type: string
        nameid_format:
          description: >
            Defines the name identifier format the SP expects the IdP to use in
            its assertions to identify subjects. If unspecified, a default value
            of `urn:oasis:names:tc:SAML:2.0:nameid-format:persistent` will be
            used. A subset of the allowed values enumerated by the SAML
            specification are supported.
          type: string
  securitySchemes:
    authentication:
      type: http
      scheme: bearer

````