Provider Auth Credentials

Auth credentials store your OAuth app registration (client ID, client secret, and scopes). These are the app-level credentials you get from a service like GitHub or Slack.

Provider Auth Credentials object

Attributes

object

String

String representing the object's type

id

String

Unique credentials identifier

type

String

is_default

Boolean

Whether this is the default credentials for the provider

name

StringNullable

Display name

description

StringNullable

Description

metadata

ObjectNullable

Custom key-value pairs for storing additional information

provider_id

String

Provider ID

created_at

Date

Timestamp when created

updated_at

Date

Timestamp when last updated

{
  "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"
}

List provider auth credentials

Returns a paginated list of provider auth credentials.

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 credential ID(s)

provider_id

UnionOptional

Filter by provider ID(s)

search

StringOptional

Search by name or description

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

Get provider auth credentials

Retrieves specific provider auth credentials by ID.

URL Parameters

provider_auth_credentials_id

String

The unique identifier for the provider_auth_credentials

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

Create provider auth credentials

Creates new provider auth credentials.

Request Body

provider_id

String

Provider ID

name

String

description

StringOptional

metadata

ObjectOptional

Custom key-value pairs for storing additional information

config

Object
POSThttp://api.metorial.com/provider-auth-credentials
curl -X POST "https://api.metorial.com/provider-auth-credentials" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer metorial_sk_..." \
  -d '{
  "provider_id": "example_provider_id",
  "name": "example_name",
  "description": "example_description",
  "metadata": {},
  "config": {
    "type": "example_type",
    "client_id": "example_client_id",
    "client_secret": "example_client_secret",
    "scopes": [
      "example_item"
    ]
  }
}'

Update provider auth credentials

Updates specific provider auth credentials.

URL Parameters

provider_auth_credentials_id

String

The unique identifier for the provider_auth_credentials

Request Body

name

StringOptional

description

StringOptional

metadata

ObjectOptional

Custom key-value pairs for storing additional information

PATCHhttp://api.metorial.com/provider-auth-credentials/:provider_auth_credentials_id
curl -X PATCH "https://api.metorial.com/provider-auth-credentials/pro_Rm4Mnheq2bfEPhBhP7SY" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer metorial_sk_..." \
  -d '{
  "name": "example_name",
  "description": "example_description",
  "metadata": {}
}'

Delete provider auth credentials

Permanently deletes provider auth credentials.

URL Parameters

provider_auth_credentials_id

String

The unique identifier for the provider_auth_credentials

DELETEhttp://api.metorial.com/provider-auth-credentials/:provider_auth_credentials_id
curl -X DELETE "https://api.metorial.com/provider-auth-credentials/pro_Rm4Mnheq2bfEPhBhP7SY" \
  -H "Authorization: Bearer metorial_sk_..."