MEmetorial
Provider Auth Credentials

Create provider auth credentials

Creates new provider auth credentials.

post/provider-auth-credentials

Request

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

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.

Request body

provider_idstring required

Provider ID

namestring
descriptionstring
metadataobject

Custom key-value pairs for storing additional information

Example request

{
  "provider_id": "pro_5gHjKlMnPqRsTuVw",
  "name": "GitHub OAuth",
  "description": "OAuth credentials for GitHub API",
  "config": {
    "client_id": "Iv1.abc123def456",
    "client_secret": "gho_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "scopes": [
      "repo"
    ]
  }
}

Response

Successful response

object'provider.auth_credentials' required

String representing the object's type

idstring required

Unique credentials identifier

type'oauth' required
status'active' | 'archived' | 'deleted' required

Credentials status

is_defaultboolean required

Whether this is the default credentials for the provider

is_managedboolean required

Whether these credentials are managed by Metorial

namestring nullable required

Display name

descriptionstring nullable required

Description

metadataobject nullable required

Custom key-value pairs for storing additional information

scopesstring[] nullable required

OAuth scopes requested by this credential

provider_idstring required

Provider ID

created_atstring date-time required

Timestamp when created

updated_atstring date-time required

Timestamp when last updated

Example response

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

Changes

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