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

String

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

deployment_preview

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": {
    "connected_by": "[email protected]",
    "purpose": "ci-pipeline"
  },
  "deployment_preview": {
    "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",
    "is_default": true,
    "name": "GitHub OAuth",
    "description": "OAuth credentials for GitHub API",
    "metadata": {
      "app_name": "My GitHub App",
      "created_by": "[email protected]"
    },
    "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"
      }
    ],
    "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

Maximum number of items to return (1-100)

after

StringOptional

Return items after this ID

before

StringOptional

Return items before this ID

cursor

StringOptional

Pagination cursor from a previous response

order

EnumOptional

Sort order for results

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)

provider_auth_credentials_id

UnionOptional

Filter by auth credentials ID(s)

provider_auth_method_id

UnionOptional

Filter by auth method ID(s)

search

StringOptional

Search by name or description

GEThttp://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

GEThttp://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

String

description

StringOptional

metadata

ObjectOptional

Custom key-value pairs for storing additional information

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

POSThttp://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": "example_name",
  "description": "example_description",
  "metadata": {},
  "provider_auth_method_id": "example_provider_auth_method_id",
  "provider_deployment_id": "example_provider_deployment_id",
  "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

PATCHhttp://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": "example_name",
  "description": "example_description",
  "metadata": {}
}'

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

DELETEhttp://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_..."