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

# List Providers

> Returns the message and login providers configured for your organization, one page at a time.

A provider is an outbound channel: an SMTP or e-mail service that carries verification and password-reset mail, an SMS service that carries MFA codes, or an OAuth identity provider people sign in through. Filter with `category` — `Email`, `SMS` or `OAuth`.

Read-only: nothing changes. A provider listed here is configured but not necessarily in USE — what makes it live is being linked to an application (`GET /v1/applications/{id}/providers`).

Failures:
- `400 IDE-0018` — `limit` is above the deployment's maximum (100 by default).
- `400 IDE-0019` — `page` is below 1.
- `503 IDE-0066` — the identity provider is unavailable (unreachable, too slow to answer, or failing). Nothing about the request was wrong; retry it later.



## OpenAPI

````yaml /pt/openapi/v3-current/AM-identity.yaml get /v1/providers
openapi: 3.1.0
info:
  contact:
    name: Lerian Studio
    url: https://lerian.studio
  description: OpenAPI 3.1 surface for the Access Manager identity component.
  license:
    name: Lerian Studio General License
  title: Access Manager Identity API
  version: v1
servers:
  - url: https://identity.sandbox.lerian.net
security: []
tags:
  - description: >-
      M2M-only: each plugin declares its own permissions, roles and M2M
      contract, and the server reconciles them.
    name: Declarations
  - description: >-
      A tenant administrator's customers. Each partner holds what its
      credentials may DO (permissions, per product) and WHERE they may do it
      (scope, per product and dimension); an M2M application attached to one is
      confined to that intersection. Administrator-only: authorized on the
      "partners" resource, and every route resolves the owning organization from
      the caller's token.
    name: Partners
paths:
  /v1/providers:
    get:
      tags:
        - Providers
      summary: List Providers
      description: >-
        Returns the message and login providers configured for your
        organization, one page at a time.


        A provider is an outbound channel: an SMTP or e-mail service that
        carries verification and password-reset mail, an SMS service that
        carries MFA codes, or an OAuth identity provider people sign in through.
        Filter with `category` — `Email`, `SMS` or `OAuth`.


        Read-only: nothing changes. A provider listed here is configured but not
        necessarily in USE — what makes it live is being linked to an
        application (`GET /v1/applications/{id}/providers`).


        Failures:

        - `400 IDE-0018` — `limit` is above the deployment's maximum (100 by
        default).

        - `400 IDE-0019` — `page` is below 1.

        - `503 IDE-0066` — the identity provider is unavailable (unreachable,
        too slow to answer, or failing). Nothing about the request was wrong;
        retry it later.
      operationId: listProviders
      parameters:
        - description: 'Filter by provider category: Email, SMS or OAuth.'
          explode: false
          in: query
          name: category
          schema:
            description: 'Filter by provider category: Email, SMS or OAuth.'
            examples:
              - Email
            type: string
        - description: Page number.
          explode: false
          in: query
          name: page
          schema:
            default: 1
            description: Page number.
            examples:
              - 1
            format: int64
            type: integer
        - description: Items per page.
          explode: false
          in: query
          name: limit
          schema:
            default: 10
            description: Items per page.
            examples:
              - 10
            format: int64
            type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProviderPagination'
          description: OK
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPError'
          description: Bad Request
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPError'
          description: Not Found
        '422':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Unprocessable Entity
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPError'
          description: Internal Server Error
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPError'
          description: Service Unavailable
      security:
        - BearerAuth: []
components:
  schemas:
    ProviderPagination:
      additionalProperties: false
      properties:
        items:
          description: The page of providers.
          items:
            $ref: '#/components/schemas/ProviderResponse'
          type: array
        limit:
          description: The page size that was applied.
          examples:
            - 10
          format: int64
          type: integer
        page:
          description: The 1-based page this response corresponds to.
          examples:
            - 1
          format: int64
          type: integer
        total:
          description: Total number of providers, across all pages.
          examples:
            - 10
          format: int64
          type: integer
      type: object
    HTTPError:
      additionalProperties: false
      properties:
        code:
          type: string
        entityType:
          type: string
        err: {}
        message:
          type: string
        title:
          type: string
      type: object
    Detail:
      additionalProperties: true
      properties:
        code:
          description: >-
            Stable, machine-readable domain error code scoped to the emitting
            service (format: <SERVICE>-NNNN).
          type: string
        detail:
          description: >-
            A human-readable explanation specific to this occurrence of the
            problem.
          examples:
            - Property foo is required but is missing.
          type: string
        errors:
          description: Optional list of individual error details
          items:
            $ref: '#/components/schemas/ErrorDetail'
          type:
            - array
            - 'null'
        instance:
          description: >-
            A URI reference that identifies the specific occurrence of the
            problem.
          examples:
            - https://example.com/error-log/abc123
          format: uri
          type: string
        status:
          description: HTTP status code
          examples:
            - 400
          format: int64
          type: integer
        title:
          description: >-
            A short, human-readable summary of the problem type. This value
            should not change between occurrences of the error.
          examples:
            - Bad Request
          type: string
        type:
          default: about:blank
          description: A URI reference to human-readable documentation for the error.
          examples:
            - https://example.com/errors/example
          format: uri
          type: string
        upstream:
          $ref: '#/components/schemas/Upstream'
          description: >-
            RFC 9457 extension member: the error a proxied third-party provider
            reported. Absent unless the emitting service explicitly surfaced
            one.
      type: object
    ProviderResponse:
      additionalProperties: false
      properties:
        appId:
          type: string
        category:
          enum:
            - Email
            - SMS
            - OAuth
          examples:
            - Email
          type: string
        clientId:
          type: string
        clientId2:
          type: string
        content:
          type: string
        createdAt:
          examples:
            - '2021-09-01T00:00:00Z'
          type: string
        customAuthUrl:
          type: string
        customTokenUrl:
          type: string
        customUserInfoUrl:
          type: string
        disableSsl:
          type: boolean
        domain:
          type: string
        endpoint:
          type: string
        host:
          type: string
        id:
          examples:
            - 00000000-0000-0000-0000-000000000000
          type: string
        intranetEndpoint:
          type: string
        issuerUrl:
          type: string
        method:
          type: string
        name:
          examples:
            - SMTP Corp
          type: string
        port:
          format: int64
          type: integer
        providerUrl:
          type: string
        receiver:
          type: string
        regionId:
          type: string
        scopes:
          type: string
        signName:
          type: string
        subType:
          type: string
        templateCode:
          type: string
        title:
          type: string
        type:
          enum:
            - SendGrid
            - Twilio SMS
            - Twilio
            - Google
            - Microsoft
            - Okta
            - Custom
          examples:
            - SendGrid
          type: string
      type: object
    ErrorDetail:
      additionalProperties: false
      properties:
        location:
          description: >-
            Where the error occurred, e.g. 'body.items[3].tags' or
            'path.thing-id'
          type: string
        message:
          description: Error message text
          type: string
        value:
          description: The value at the given location
      type: object
    Upstream:
      additionalProperties: false
      properties:
        code:
          description: The upstream provider's own error code, verbatim.
          examples:
            - E4001
          type: string
        message:
          description: >-
            The upstream provider's own error message, verbatim (bounded, never
            its raw response body).
          examples:
            - account not found at provider
          type: string
      type: object
  securitySchemes:
    BearerAuth:
      bearerFormat: JWT
      description: JWT bearer token issued by the identity provider.
      scheme: bearer
      type: http

````

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