Provider Auth Methods

Get provider auth method

Retrieves a specific provider auth method by ID.

get/provider-auth-methods/{provider_auth_method_id}

Request

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

Path parameters

provider_auth_method_idstring required

Unique identifier of the provider auth method.

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.

Response

Successful response

object'provider.capabilities.auth_method' required

String representing the object's type

idstring required

Unique auth method identifier

type'oauth' | 'token' | 'custom' required

Authentication type

keystring required

Auth method key

namestring required

Display name

descriptionstring nullable required

Auth method description

capabilitiesobject required

Auth method capabilities

adaptersstring[] nullable required

Adapter IDs this auth method can be used with

provider_idstring required

Provider ID

provider_specification_idstring required

Specification ID

created_atstring date-time required

Timestamp when created

updated_atstring date-time required

Timestamp when last updated

Example response

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

Changes

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