MEmetorial
Provider Auth Exports

Create provider auth export

Exports authentication credentials from a provider.

post/provider-auth-config-exports

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_auth_config_idstring required

Provider auth config ID

notestring required
metadataobject

Custom key-value pairs for storing additional information

Example request

{
  "provider_auth_config_id": "pacf_4sTuVwXyZaBcDeFg"
}

Response

Successful response

object'provider.auth_export' required

String representing the object's type

idstring required

Unique auth export identifier

notestring required

Note explaining the export reason

ipstring nullable required

IP address of the export request

user_agentstring nullable required

User agent of the export request

metadataobject nullable required

Custom key-value pairs for storing additional information

provider_idstring required

Provider ID

provider_deployment_idstring nullable required

Deployment ID

auth_method_idstring required

Auth method ID

credentials_idstring nullable required

Auth credentials ID

valueobject nullable required

The exported credential data

created_atstring date-time required

Timestamp when created

expires_atstring date-time nullable required

Timestamp when the export expires

Example response

{
  "id": "pace_7yZaBcDeFgHjKlMn",
  "note": "Exported for backup purposes",
  "ip": "192.168.1.1",
  "auth_config": {
    "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"
  },
  "provider_id": "pro_5gHjKlMnPqRsTuVw",
  "provider_deployment_id": "pde_1aBcDeFgHjKlMnPq",
  "auth_method_id": "pam_2mNpQrStUvWxYzAb",
  "credentials_id": "par_4sTuVwXyZaBcDeFg",
  "created_at": "2025-09-15T10:30:00.000Z",
  "expires_at": "2026-03-15T10:30:00.000Z"
}

Changes

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