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

# List controller SAML login

> Retrieve list controller SAML login.



## OpenAPI

````yaml /openapi/9.0/aviatrix-api.json get /v2/api/list_controller_saml_login
openapi: 3.1.0
info:
  title: Aviatrix Controller API
  version: '9.0'
  description: >-
    Aviatrix Controller API — version 9.0. Selected operations with Mintlify
    metadata.
servers: []
security: []
tags:
  - name: policies
    x-group: Policies
  - name: authentication
    x-group: Authentication
  - name: account-management
    x-group: Account Management
  - name: rbac
    x-group: RBAC & Permissions
  - name: gateways
    x-group: Gateways
  - name: transit
    x-group: Transit
  - name: nat
    x-group: NAT
  - name: app-domains
    x-group: SmartGroups
  - name: certificates
    x-group: Certificates
  - name: mitm
    x-group: MITM
  - name: monitoring
    x-group: Monitoring & Diagnostics
  - name: fqdn
    x-group: FQDN
  - name: logging
    x-group: Logging
  - name: vpn
    x-group: UserVPN
  - name: site-to-cloud
    x-group: Site-to-Cloud
  - name: controller
    x-group: Controller
  - name: bgp
    x-group: BGP
  - name: general
    x-group: General
  - name: firenet
    x-group: FireNet
  - name: networking
    x-group: Networking
  - name: tgw
    x-group: AWS TGW
  - name: ips
    x-group: IPS
  - name: saml
    x-group: SAML
paths:
  /v2/api/list_controller_saml_login:
    get:
      tags:
        - authentication
      operationId: list_controller_saml_login_get
      parameters:
        - description: Hostname.
          in: query
          name: hostname
          required: false
          schema:
            type: string
        - description: A name for the saml Endpoint.
          in: query
          name: endpoint_name
          required: false
          schema:
            type: string
        - description: >-
            A SAML IDP Metadata URL/Text that is required if SAML is enabled on
            the gateway.
          in: query
          name: metadata
          required: false
          schema:
            type: string
        - description: Describes file/Text input of metadata.
          in: query
          name: metadata_type
          required: false
          schema:
            enum:
              - Text
              - URL
            type: string
        - description: EntityID type for SAML.
          in: query
          name: entityID
          required: false
          schema:
            enum:
              - Custom
              - Hostname
            type: string
        - description: Custom entity ID.
          in: query
          name: custom_entityID
          required: false
          schema:
            type: string
        - description: Whether to extract cert metadata/response.
          in: query
          name: extract_cert_from
          required: false
          schema:
            type: string
        - description: Whether to use custom msg template.
          in: query
          name: msgtemplatetype
          required: false
          schema:
            enum:
              - Custom
              - Default
            type: string
        - description: Block empty profiles.
          in: query
          name: block_empty_profiles
          required: false
          schema:
            type: boolean
        - description: Custom msgtemplate.
          in: query
          name: msgtemplate
          required: false
          schema:
            type: string
        - description: Whether to sign Authn requests.
          in: query
          name: sign_authn_requests
          required: false
          schema:
            type: boolean
        - description: Parameter to specify controller login.
          in: query
          name: controller_login
          required: false
          schema:
            type: boolean
        - description: RBAC groups for controller login.
          in: query
          name: rbac_groups
          required: false
          schema:
            type: string
        - description: >-
            Whether the access level is set by controller or a profile
            attribute.
          in: query
          name: access_ctrl
          required: false
          schema:
            enum:
              - controller
              - profile_attribute
            type: string
        - description: Username for ctrl login authentication.
          in: query
          name: username
          required: false
          schema:
            type: string
        - description: Password for ctrl login authentication.
          in: query
          name: password
          required: false
          schema:
            type: string
        - description: Remote IP of the user for ctrl login auth.
          in: query
          name: login_ip
          required: false
          schema:
            type: string
        - $ref: '#/components/parameters/action'
      responses:
        '200':
          $ref: '#/components/responses/general_response_v2'
        default:
          $ref: '#/components/responses/general_response_v2'
      x-codeSamples:
        - lang: curl
          label: cURL
          source: >-
            curl -sk -X GET
            "https://<controller>/v2/api/list_controller_saml_login" \
              -H "Authorization: cid <CID>"
        - lang: python
          label: Python
          source: |-
            import requests

            url = "https://<controller>/v2/api/list_controller_saml_login"
            headers = {"Authorization": "cid <CID>"}

            response = requests.get(url, headers=headers, verify=False)
            print(response.status_code)
            print(response.text)
        - lang: javascript
          label: JavaScript
          source: |-
            fetch("https://<controller>/v2/api/list_controller_saml_login", {
              method: "GET",
              headers: {"Authorization": "cid <CID>"}
            })
              .then(res => res.text())
              .then(console.log)
              .catch(console.error);
        - lang: go
          label: Go
          source: |-
            package main

            import (
              "fmt"
              "net/http"
            )

            func main() {
              req, _ := http.NewRequest("GET", "https://<controller>/v2/api/list_controller_saml_login", nil)
              req.Header.Set("Authorization", "cid <CID>")

              client := &http.Client{}
              resp, err := client.Do(req)
              if err != nil {
                panic(err)
              }
              defer resp.Body.Close()

              fmt.Println(resp.Status)
            }
components:
  parameters:
    action:
      description: The API action to perform. Required for 7.2 controllers only.
      in: query
      name: action
      schema:
        $ref: '#/components/schemas/action'
  responses:
    general_response_v2:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/general_response_v2'
      description: General v2 API response schema.
  schemas:
    action:
      description: The API action to perform. Required for 7.2 controllers only.
      type: string
    general_response_v2:
      additionalProperties: true
      description: A generic API response container for v2 style APIs.
      properties:
        errortype:
          description: Error type if the API failed.
          type: string
        reason:
          description: Failure reason if the API failed.
          type: string
        results:
          oneOf:
            - description: API response data
              type: boolean
            - description: API response data
              type: integer
            - description: API response data
              type: string
            - description: API response data
              type: object
            - description: API response data
              items: {}
              type: array
        return:
          description: Whether the API returned successfully
          type: boolean
      title: General Response v2
      type: object

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.