> ## Documentation Index > Fetch the complete documentation index at: https://altostrat.io/docs/llms.txt > Use this file to discover all available pages before exploring further. # Retrieve an auth integration > Retrieves the details of a specific authentication integration by its unique ID. ## OpenAPI ````yaml /api/en/captive-portal.yaml get /captive/auth-integrations/{authIntegrationId} openapi: 3.0.3 info: title: Altostrat Captive Portal API version: 1.0.0 description: >- The Altostrat Captive Portal API is the microservice responsible for managing user authentication, access control, and branding for guest Wi-Fi networks. It acts as the control plane for guest network experiences on MikroTik devices within the Altostrat SDX platform, integrating with network automation to dynamically manage user sessions and access policies. This API allows you to programmatically manage: - **Instances:** A complete configuration for a captive portal, including its appearance (theme), authentication method (OAuth2 or coupon-based), and session rules. - **Auth Integrations:** Reusable configurations for third-party identity providers (e.g., Google, Azure AD) used in OAuth2 authentication strategies. - **Coupons & Schedules:** Time-limited access codes and the automated schedules that generate them for coupon-based guest access. - **Walled Garden:** Granular rules defining which domains or IP addresses users can access *before* authenticating, essential for identity provider logins. Developers use this API to programmatically create, configure, and manage bespoke guest Wi-Fi experiences across their entire network of sites. servers: - url: https://v1.api.altostrat.io description: Altostrat Production API security: - bearerAuth: [] tags: - name: Captive Portal Instances description: >- Manage captive portal configurations, including themes, authentication strategies, and associated sites. - name: Auth Integrations description: >- Configure third-party Identity Providers (IDPs) for OAuth2-based authentication. - name: Coupons description: Generate and manage single-use access coupons for guest networks. - name: Coupon Schedules description: Automate the generation of access coupons on a recurring schedule. - name: Walled Garden description: Control which destinations users can access before authentication. - name: Site Users description: >- View and manage users who have authenticated through the captive portal at a specific site. - name: Public Coupon URLs description: Signed public URLs for coupon schedule exports. paths: /captive/auth-integrations/{authIntegrationId}: get: tags: - Auth Integrations summary: Retrieve an auth integration description: >- Retrieves the details of a specific authentication integration by its unique ID. operationId: getAuthIntegration parameters: - $ref: '#/components/parameters/authIntegrationId' responses: '200': description: The requested authentication integration. content: application/json: schema: $ref: '#/components/schemas/AuthIntegration' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' components: parameters: authIntegrationId: name: authIntegrationId in: path required: true description: The unique identifier for the authentication integration. schema: type: string format: uuid example: c4d5e6f7-8a9b-0c1d-2e3f-4a5b6c7d8e9f schemas: AuthIntegration: type: object properties: id: type: string format: uuid description: The unique identifier for the authentication integration. example: c4d5e6f7-8a9b-0c1d-2e3f-4a5b6c7d8e9f name: type: string description: A human-readable name for the integration. example: Azure AD - Corporate type: type: string description: The type of identity provider. enum: - azure - github - google example: azure config: type: object description: >- The configuration credentials for the provider. The `client_secret` is write-only and will not be returned in API responses. properties: client_id: type: string description: The client ID provided by the identity provider. example: a1b2c3d4-e5f6-a7b8-c9d0-e1f2a3b4c5d6 tenant: type: string description: The tenant ID for Azure AD integrations. example: organizations test_url: type: string format: uri description: >- A signed URL that can be used to test the authentication flow for this integration. example: https://captive.altostr.at/auth-test/c4d5e6f7...?signature=... created_at: type: string format: date-time description: The timestamp when the integration was created. example: '2025-10-28T10:00:00Z' ErrorResponse: type: object properties: type: type: string description: A broad category for the error (e.g., 'invalid_request_error'). example: invalid_request_error code: type: string description: A short, unique string identifying the specific error. example: parameter_missing message: type: string description: A human-readable description of what went wrong. example: The 'name' parameter is required for this request. doc_url: type: string description: >- A direct link to the documentation page for this specific error code. example: https://docs.altostrat.io/errors/parameter_missing responses: Unauthorized: description: >- Unauthorized - The request requires authentication, but no valid credentials were provided. Ensure your API key is correct and included in the 'Authorization' header. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' Forbidden: description: >- Forbidden - You do not have permission to perform this action on the requested resource. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' NotFound: description: >- Not Found - The requested resource could not be found. Check that the provided ID is correct. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT description: >- API Key authentication. Provide your token in the 'Authorization' header. Example: `Authorization: Bearer ` ````