Provider Auth Exports

An auth export lets you extract OAuth tokens or credentials from Metorial to use in other systems, avoiding duplicate authentication flows.

Provider Auth Exports object

Attributes

object

String

String representing the object's type

id

String

Unique auth export identifier

note

String

Note explaining the export reason

ip

StringNullable

IP address of the export request

user_agent

StringNullable

User agent of the export request

metadata

ObjectNullable

Custom key-value pairs for storing additional information

auth_config

Object

provider_id

String

Provider ID

provider_deployment_id

StringNullable

Deployment ID

auth_method_id

String

Auth method ID

credentials_id

StringNullable

Auth credentials ID

value

ObjectNullable

The exported credential data

created_at

Date

Timestamp when created

expires_at

DateNullable

Timestamp when the export expires

{
  "object": "provider.auth_export",
  "id": "pace_7yZaBcDeFgHjKlMn",
  "note": "Exported for backup purposes",
  "ip": "192.168.1.1",
  "metadata": {
    "exported_by": "[email protected]",
    "reason": "backup"
  },
  "auth_config": {
    "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"
  },
  "provider_id": "pro_5gHjKlMnPqRsTuVw",
  "provider_deployment_id": "pde_1aBcDeFgHjKlMnPq",
  "auth_method_id": "pam_2mNpQrStUvWxYzAb",
  "credentials_id": "par_4sTuVwXyZaBcDeFg",
  "value": {
    "access_token": "gho_xxxxxxxxxxxxxxxxxxxx",
    "refresh_token": "ghr_xxxxxxxxxxxxxxxxxxxx",
    "token_type": "bearer",
    "scope": "repo,read:user,read:org"
  },
  "created_at": "2025-09-15T10:30:00.000Z",
  "expires_at": "2026-03-15T10:30:00.000Z"
}

List provider auth exports

Returns a paginated list of provider auth exports.

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

id

UnionOptional

Filter by export ID(s)

provider_id

UnionOptional

Filter by provider ID(s)

provider_auth_credentials_id

UnionOptional

Filter by auth credentials ID(s)

provider_auth_config_id

UnionOptional

Filter by auth config ID(s)

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

Get provider auth export

Retrieves a specific provider auth export by ID.

URL Parameters

provider_auth_export_id

String

The unique identifier for the provider_auth_export

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

Create provider auth export

Exports authentication credentials from a provider.

Request Body

provider_auth_config_id

String

Provider auth config ID

note

String

metadata

ObjectOptional

Custom key-value pairs for storing additional information

POSThttp://api.metorial.com/provider-auth-config-exports
curl -X POST "https://api.metorial.com/provider-auth-config-exports" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer metorial_sk_..." \
  -d '{
  "provider_auth_config_id": "example_provider_auth_config_id",
  "note": "example_note",
  "metadata": {}
}'