Provider Auth Imports

An auth import lets you bring in existing OAuth tokens or credentials from another system, so users don't need to re-authenticate to use Metorial.

Provider Auth Imports object

Attributes

object

String

String representing the object's type

id

String

Unique auth import identifier

note

String

Note explaining the import

metadata

ObjectNullable

Custom key-value pairs for storing additional information

provider_id

StringNullable

Provider ID

provider_deployment_id

StringNullable

Deployment ID

provider_auth_config_id

StringNullable

Auth config ID

provider_auth_method_id

StringNullable

Auth method ID

created_at

Date

Timestamp when created

{
  "object": "provider.auth_import",
  "id": "paci_1vWxYzAbCdEfGhJk",
  "note": "Imported from previous environment",
  "metadata": {
    "imported_from": "legacy-system",
    "migration_date": "2025-09-01"
  },
  "provider_id": "pro_5gHjKlMnPqRsTuVw",
  "provider_deployment_id": "pde_1aBcDeFgHjKlMnPq",
  "provider_auth_config_id": "pac_8pQrStUvWxYzAbCd",
  "provider_auth_method_id": "pam_2mNpQrStUvWxYzAb",
  "created_at": "2025-09-15T10:30:00.000Z"
}

List provider auth imports

Returns a paginated list of provider auth imports.

URL Parameters

provider_deployment_id

String

The unique identifier for the provider_deployment

provider_auth_config_id

String

The unique identifier for the provider_auth_config

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

GEThttp://api.metorial.com/provider-deployments/:provider_deployment_id/auth-configs/:provider_auth_config_id/imports
curl -X GET "https://api.metorial.com/provider-deployments/pro_Rm4Mnheq2bfEPhBhP7SY/auth-configs/pro_Rm4Mnheq2bfEPhBhP7SY/imports" \
  -H "Authorization: Bearer metorial_sk_..."

Get provider auth import

Retrieves a specific provider auth import by ID.

URL Parameters

provider_deployment_id

String

The unique identifier for the provider_deployment

provider_auth_config_id

String

The unique identifier for the provider_auth_config

provider_auth_import_id

String

The unique identifier for the provider_auth_import

GEThttp://api.metorial.com/provider-deployments/:provider_deployment_id/auth-configs/:provider_auth_config_id/imports/:provider_auth_import_id
curl -X GET "https://api.metorial.com/provider-deployments/pro_Rm4Mnheq2bfEPhBhP7SY/auth-configs/pro_Rm4Mnheq2bfEPhBhP7SY/imports/pro_Rm4Mnheq2bfEPhBhP7SY" \
  -H "Authorization: Bearer metorial_sk_..."

Create provider auth import

Imports authentication credentials for a provider.

URL Parameters

provider_deployment_id

String

The unique identifier for the provider_deployment

provider_auth_config_id

String

The unique identifier for the provider_auth_config

Request Body

note

String

A note describing the import source or reason

metadata

ObjectOptional

Custom key-value pairs for storing additional information

providerAuthMethodId

StringOptional

The authentication method used by these credentials

value

Object

The credential data to import

POSThttp://api.metorial.com/provider-deployments/:provider_deployment_id/auth-configs/:provider_auth_config_id/imports
curl -X POST "https://api.metorial.com/provider-deployments/pro_Rm4Mnheq2bfEPhBhP7SY/auth-configs/pro_Rm4Mnheq2bfEPhBhP7SY/imports" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer metorial_sk_..." \
  -d '{
  "note": "example_note",
  "metadata": {},
  "providerAuthMethodId": "example_providerAuthMethodId",
  "value": {}
}'

Get auth import schema

Retrieves the JSON Schema for importing authentication credentials.

URL Parameters

provider_deployment_id

String

The unique identifier for the provider_deployment

provider_auth_config_id

String

The unique identifier for the provider_auth_config

GEThttp://api.metorial.com/provider-deployments/:provider_deployment_id/auth-configs/:provider_auth_config_id/imports/schema
curl -X GET "https://api.metorial.com/provider-deployments/pro_Rm4Mnheq2bfEPhBhP7SY/auth-configs/pro_Rm4Mnheq2bfEPhBhP7SY/imports/schema" \
  -H "Authorization: Bearer metorial_sk_..."