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

name

StringNullable

Display name

description

StringNullable

Description

metadata

ObjectNullable

Custom key-value pairs for storing additional information

provider_id

String

Provider ID

provider_deployment_id

StringNullable

Deployment ID

provider_auth_method_id

String

Auth method ID

created_at

Date

Timestamp when created

updated_at

Date

Timestamp when last updated

{
  "object": "provider.auth_config",
  "id": "pac_8pQrStUvWxYzAbCd",
  "type": "manual",
  "name": "GitHub OAuth Token",
  "description": "OAuth token for GitHub API access",
  "metadata": {
    "connected_by": "alex@company.com",
    "purpose": "ci-pipeline"
  },
  "provider_id": "pro_5gHjKlMnPqRsTuVw",
  "provider_deployment_id": "pde_1aBcDeFgHjKlMnPq",
  "provider_auth_method_id": "pam_2mNpQrStUvWxYzAb",
  "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.

URL Parameters

provider_deployment_id

String

The unique identifier for the provider_deployment

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

provider_auth_method_id

UnionOptional

Filter by auth method ID(s)

provider_auth_credentials_id

UnionOptional

Filter by auth credentials ID(s)

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

Get provider auth config

Retrieves a specific provider auth config by ID.

URL Parameters

provider_deployment_id

String

The unique identifier for the provider_deployment

provider_auth_config_id

String

The unique identifier for the provider_auth_config

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

Create provider auth config

Creates a new provider auth config.

URL Parameters

provider_deployment_id

String

The unique identifier for the provider_deployment

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)

credentials

Object

Authentication credentials source

POSThttp://api.metorial.com/provider-deployments/:provider_deployment_id/auth-configs
curl -X POST "https://api.metorial.com/provider-deployments/pro_Rm4Mnheq2bfEPhBhP7SY/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",
  "credentials": {
    "type": "example_type",
    "provider_auth_credentials_id": "example_provider_auth_credentials_id"
  }
}'

Update provider auth config

Updates a specific provider auth config.

URL Parameters

provider_deployment_id

String

The unique identifier for the provider_deployment

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-deployments/:provider_deployment_id/auth-configs/:provider_auth_config_id
curl -X PATCH "https://api.metorial.com/provider-deployments/pro_Rm4Mnheq2bfEPhBhP7SY/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_deployment_id

String

The unique identifier for the provider_deployment

provider_auth_config_id

String

The unique identifier for the provider_auth_config

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