Provider Auth Configs

List provider auth configs

Returns a paginated list of provider auth configs.

get/provider-auth-configs

Request

  • Base URL
    https://api.metorial.com
  • Auth
    HTTP bearer

Query parameters

limitnumber
afterstring
beforestring
cursorstring
order'asc' | 'desc'
ownership'shared' | 'usable' | 'all'

Which resources to return under the resource ownership rules: shared (resources without an owner), usable (shared resources plus owned resources the caller may use), or all (everything the caller can see). Defaults to shared when ownership is enforced for the project, and all otherwise.

'active' | 'archived'
OR
string[]

Filter by status (active, archived)

string
OR
string[]

Filter by auth config ID(s)

string
OR
string[]

Filter by provider ID(s)

string
OR
string[]

Filter by provider deployment ID(s)

available_for_useboolean

Only return auth configs that are not owned by another integration instance provider.

available_for_provider_deployment_idstring

Only return auth configs that are not locked to a different provider deployment.

string
OR
string[]

Filter by auth credentials ID(s)

string
OR
string[]

Filter by auth method ID(s)

string
OR
string[]

Filter by actor ID(s)

string
OR
string[]

Filter by consumer ID(s)

string
OR
string[]

Filter by identity ID(s)

string
OR
string[]

Filter by identity credential ID(s)

adapterstring

Only return auth configs whose auth method supports this adapter

searchstring

Search by name or description

gtstring date-time

Only include records after this timestamp for provider auth config creation time

ltstring date-time

Only include records before this timestamp for provider auth config creation time

Filter provider auth config creation time by date range

gtstring date-time

Only include records after this timestamp for provider auth config last update time

ltstring date-time

Only include records before this timestamp for provider auth config last update time

Filter provider auth config last update time by date range

Headers

Metorial-Versionstring
Example:2025-01-01

Pin the dated API version for this request, e.g. 2025-01-01. Defaults to the version configured for the environment.

Response

Successful response

Example response

{
  "items": [
    {
      "id": "pac_8pQrStUvWxYzAbCd",
      "provider_id": "pro_5gHjKlMnPqRsTuVw",
      "name": "GitHub OAuth Token",
      "description": "OAuth token for GitHub API access",
      "deployment": {
        "id": "pde_1aBcDeFgHjKlMnPq",
        "name": "Production",
        "description": "Production deployment",
        "provider_id": "pro_5gHjKlMnPqRsTuVw",
        "created_at": "2025-09-15T10:30:00.000Z",
        "updated_at": "2026-01-10T14:45:00.000Z"
      },
      "credentials": {
        "id": "par_4sTuVwXyZaBcDeFg",
        "is_default": true,
        "is_managed": true,
        "name": "GitHub OAuth",
        "description": "OAuth credentials for GitHub API",
        "provider_id": "pro_5gHjKlMnPqRsTuVw",
        "created_at": "2025-09-15T10:30:00.000Z",
        "updated_at": "2026-01-10T14:45:00.000Z"
      },
      "auth_method": {
        "id": "pam_2mNpQrStUvWxYzAb",
        "key": "oauth2",
        "name": "OAuth 2.0",
        "description": "Authenticate using OAuth 2.0",
        "scopes": [
          {
            "id": "pams_8tUvWxYzAbCdEfGh",
            "scope": "repo",
            "name": "Repository Access",
            "description": "Full control of private repositories"
          }
        ],
        "provider_id": "pro_5gHjKlMnPqRsTuVw",
        "provider_specification_id": "psp_9gHjKlMnPqRsTuVw",
        "created_at": "2025-09-15T10:30:00.000Z",
        "updated_at": "2026-01-10T14:45:00.000Z"
      },
      "created_at": "2025-09-15T10:30:00.000Z",
      "updated_at": "2026-01-10T14:45:00.000Z"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.