MEmetorial
Provider Auth Configs

Create provider auth config

Creates a new provider auth config.

post/provider-auth-configs

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

namestring
descriptionstring
metadataobject

Custom key-value pairs for storing additional information

provider_auth_method_idstring required

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

provider_deployment_idstring

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

valueobject required

Authentication config payload

Example request

{
  "name": "GitHub OAuth Token",
  "description": "OAuth token for GitHub API access",
  "provider_auth_method_id": "pam_2mNpQrStUvWxYzAb",
  "provider_deployment_id": "pd_2mNpQrStUvWxYzAb"
}

Response

Successful response

object'provider.auth_config' required

String representing the object's type

idstring required

Unique auth config identifier

type'manual' | 'oauth_automated' | 'oauth_manual' required

Authentication type

source'manual' | 'setup_session' | 'system' | 'explorer' required

Auth config source

status'active' | 'archived' | 'deleted' required

Auth config status

is_defaultboolean required

Whether this is the default auth config

provider_idstring required

Provider ID

namestring nullable required

Display name

descriptionstring nullable required

Description

metadataobject nullable required

Custom key-value pairs for storing additional information

created_atstring date-time required

Timestamp when created

updated_atstring date-time required

Timestamp when last updated

Example response

{
  "id": "pac_8pQrStUvWxYzAbCd",
  "provider_id": "pro_5gHjKlMnPqRsTuVw",
  "name": "GitHub OAuth Token",
  "description": "OAuth token for GitHub API access",
  "deployment": {
    "id": "pde_1aBcDeFgHjKlMnPq",
    "name": "Production",
    "description": "Production deployment",
    "provider_id": "pro_5gHjKlMnPqRsTuVw",
    "created_at": "2025-09-15T10:30:00.000Z",
    "updated_at": "2026-01-10T14:45:00.000Z"
  },
  "credentials": {
    "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"
  },
  "auth_method": {
    "id": "pam_2mNpQrStUvWxYzAb",
    "key": "oauth2",
    "name": "OAuth 2.0",
    "description": "Authenticate using OAuth 2.0",
    "scopes": [
      {
        "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"
}

Changes

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