Provider Auth Configs

An auth config is a user's authenticated connection to a provider. Created when a user completes OAuth or manually enters an API token.

Provider Auth Configs object

Attributes

object

Enumprovider.auth_config

String representing the object's type

id

String

Unique auth config identifier

type

Enum

Authentication type

source

Enum

Auth config source

status

Enum

Auth config status

is_default

Boolean

Whether this is the default auth config

provider_id

String

Provider ID

name

StringNullable

Display name

description

StringNullable

Description

metadata

ObjectNullable

Custom key-value pairs for storing additional information

tool_filter

Union

Tool filter configuration

deployment

ObjectNullable

credentials

ObjectNullable

auth_method

Object

created_at

Date

Timestamp when created

updated_at

Date

Timestamp when last updated

{
  "object": "provider.auth_config",
  "id": "pac_8pQrStUvWxYzAbCd",
  "type": "manual",
  "source": "manual",
  "status": "active",
  "provider_id": "pro_5gHjKlMnPqRsTuVw",
  "name": "GitHub OAuth Token",
  "description": "OAuth token for GitHub API access",
  "metadata": {},
  "tool_filter": {
    "type": "allow_all"
  },
  "deployment": {
    "object": "provider.deployment#preview",
    "id": "pde_1aBcDeFgHjKlMnPq",
    "name": "Production",
    "description": "Production deployment",
    "metadata": {},
    "provider_id": "pro_5gHjKlMnPqRsTuVw",
    "created_at": "2025-09-15T10:30:00.000Z",
    "updated_at": "2026-01-10T14:45:00.000Z"
  },
  "credentials": {
    "object": "provider.auth_credentials",
    "id": "par_4sTuVwXyZaBcDeFg",
    "type": "oauth",
    "status": "active",
    "is_default": true,
    "is_managed": true,
    "name": "GitHub OAuth",
    "description": "OAuth credentials for GitHub API",
    "metadata": {},
    "provider_id": "pro_5gHjKlMnPqRsTuVw",
    "created_at": "2025-09-15T10:30:00.000Z",
    "updated_at": "2026-01-10T14:45:00.000Z"
  },
  "auth_method": {
    "object": "provider.capabilities.auth_method",
    "id": "pam_2mNpQrStUvWxYzAb",
    "type": "oauth",
    "key": "oauth2",
    "name": "OAuth 2.0",
    "description": "Authenticate using OAuth 2.0",
    "capabilities": {},
    "input_schema": {
      "type": "json_schema",
      "schema": {}
    },
    "output_schema": {
      "type": "json_schema",
      "schema": {}
    },
    "scopes": [
      {
        "object": "provider.capabilities.auth_method.scope",
        "id": "pams_8tUvWxYzAbCdEfGh",
        "scope": "repo",
        "name": "Repository Access",
        "description": "Full control of private repositories"
      },
      {
        "object": "provider.capabilities.auth_method.scope",
        "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"
}

List provider auth configs

Returns a paginated list of provider auth configs.

Query Parameters

limit

NumberOptional

after

StringOptional

before

StringOptional

cursor

StringOptional

order

EnumOptional

status

UnionOptional

Filter by status (active, archived)

id

UnionOptional

Filter by auth config ID(s)

provider_id

UnionOptional

Filter by provider ID(s)

provider_deployment_id

UnionOptional

Filter by provider deployment ID(s)

available_for_use

BooleanOptional

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

available_for_provider_deployment_id

StringOptional

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

provider_auth_credentials_id

UnionOptional

Filter by auth credentials ID(s)

provider_auth_method_id

UnionOptional

Filter by auth method ID(s)

actor_id

UnionOptional

Filter by actor ID(s)

consumer_id

UnionOptional

Filter by consumer ID(s)

identity_id

UnionOptional

Filter by identity ID(s)

identity_credential_id

UnionOptional

Filter by identity credential ID(s)

search

StringOptional

Search by name or description

created_at

ObjectOptional

Filter provider auth config creation time by date range

updated_at

ObjectOptional

Filter provider auth config last update time by date range

GEThttps://api.metorial.com/provider-auth-configs
curl -X GET "https://api.metorial.com/provider-auth-configs" \
  -H "Authorization: Bearer metorial_sk_..."

Get provider auth config

Retrieves a specific provider auth config by ID.

URL Parameters

provider_auth_config_id

String

The unique identifier for the provider_auth_config

GEThttps://api.metorial.com/provider-auth-configs/:provider_auth_config_id
curl -X GET "https://api.metorial.com/provider-auth-configs/pro_Rm4Mnheq2bfEPhBhP7SY" \
  -H "Authorization: Bearer metorial_sk_..."

Create provider auth config

Creates a new provider auth config.

Request Body

name

StringOptional

description

StringOptional

metadata

ObjectOptional

Custom key-value pairs for storing additional information

tool_filters

UnionOptionalNullable

provider_auth_method_id

String

The authentication method this config uses (e.g., OAuth, API key)

provider_deployment_id

StringOptional

The provider deployment this auth config is associated with (if applicable)

value

Object

Authentication config payload

POSThttps://api.metorial.com/provider-auth-configs
curl -X POST "https://api.metorial.com/provider-auth-configs" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer metorial_sk_..." \
  -d '{
  "name": "GitHub OAuth Token",
  "description": "OAuth token for GitHub API access",
  "metadata": {},
  "tool_filters": {
    "type": "tool_keys",
    "keys": [
      "example_keys"
    ]
  },
  "provider_auth_method_id": "pam_2mNpQrStUvWxYzAb",
  "provider_deployment_id": "pd_2mNpQrStUvWxYzAb",
  "value": {}
}'

Update provider auth config

Updates a specific provider auth config.

URL Parameters

provider_auth_config_id

String

The unique identifier for the provider_auth_config

Request Body

name

StringOptional

description

StringOptional

metadata

ObjectOptional

Custom key-value pairs for storing additional information

tool_filters

UnionOptionalNullable
PATCHhttps://api.metorial.com/provider-auth-configs/:provider_auth_config_id
curl -X PATCH "https://api.metorial.com/provider-auth-configs/pro_Rm4Mnheq2bfEPhBhP7SY" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer metorial_sk_..." \
  -d '{
  "name": "Updated Auth Config Name",
  "description": "Updated description for auth configuration",
  "metadata": {},
  "tool_filters": {
    "type": "tool_keys",
    "keys": [
      "example_keys"
    ]
  }
}'

Delete provider auth config

Permanently deletes a provider auth config.

URL Parameters

provider_auth_config_id

String

The unique identifier for the provider_auth_config

DELETEhttps://api.metorial.com/provider-auth-configs/:provider_auth_config_id
curl -X DELETE "https://api.metorial.com/provider-auth-configs/pro_Rm4Mnheq2bfEPhBhP7SY" \
  -H "Authorization: Bearer metorial_sk_..."