Oauth

Authenticate

post

Authenticate for authenticate.

Authorizations

ApiKeyAuth

Responses

200

Successful response

application/json

objectOptional

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

post

/api/v1/oauth/authenticate

HTTPcURLJavaScriptPython

POST /api/v1/oauth/authenticate HTTP/1.1
Host: core.wearepatchworks.com
Accept: */*

{}

Authorise

post

Validation Rules

These are the basic validation rules for the request. More detailed validation may apply depending on the data being sent. Please see the response for any extra requirements

Field	Type	Required
name	string	☑
authentication_implementation_id		☑
timezone	string	☑
date_format	string	☑
rate_limit_unit	string	☑
rate_limit_duration	integer	☑
connection_pool_id	integer
variables
variables.*.key	string	☑
variables.*.value	string
variables.*.label	string	☑
variables.*.secret
variables.*.locked
variables.*.pivot.alias	string
variables.*.pivot.configurable
variables.*.pivot.required
variables.*.pivot.advanced
session_id	string
platform_app_key	string
certificate_id	string

Authorizations

ApiKeyAuth

Body

application/json

authentication_implementation_idstringRequired

timezonestringRequired

date_formatstringRequired

rate_limit_unitstring · enumRequiredPossible values:

rate_limit_durationintegerRequired

connection_pool_idintegerOptional

variablesstringOptional

session_idstringOptional

platform_app_keystringOptional

certificate_idstringOptional

Responses

200

Successful response

application/json

objectOptional

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

post

/api/v1/oauth/authorise

HTTPcURLJavaScriptPython

POST /api/v1/oauth/authorise HTTP/1.1
Host: core.wearepatchworks.com
Content-Type: application/json
Accept: */*
Content-Length: 290

{
  "authentication_implementation_id": 1,
  "timezone": "example_timezone",
  "date_format": "example_date_format",
  "rate_limit_unit": "second",
  "rate_limit_duration": 1,
  "connection_pool_id": 1,
  "variables": "example_variables",
  "session_id": 1,
  "platform_app_key": "example_platform_app_key",
  "certificate_id": 1
}

{}

Store

post

Create a new woo app auth.

Authorizations

ApiKeyAuth

Responses

200

Successful response

No content

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

post

/api/v1/oauth/woo-app-auth

HTTPcURLJavaScriptPython

POST /api/v1/oauth/woo-app-auth HTTP/1.1
Host: core.wearepatchworks.com
Accept: */*

No content

Reauthorise

patch

Validation Rules

These are the basic validation rules for the request. More detailed validation may apply depending on the data being sent. Please see the response for any extra requirements

Field	Type	Required
authentication_implementation_id
name	string
type	string
timezone	string
date_format	string
rate_limit_unit	string
rate_limit_duration	integer
connection_pool_id	integer
variables
variables.*.id	string	☑
variables.*.key	string
variables.*.value	string
variables.*.label	string
variables.*.secret
variables.*.locked
variables.*.pivot.alias	string
variables.*.pivot.configurable
variables.*.pivot.required
variables.*.pivot.advanced

Authorizations

ApiKeyAuth

Path parameters

connectorstringRequired

The connector identifier.

Body

application/json

authentication_implementation_idstringOptional

typestringOptional

timezonestringOptional

date_formatstringOptional

rate_limit_unitstring · enumOptionalPossible values:

rate_limit_durationintegerOptional

connection_pool_idintegerOptional

variablesstringOptional

Responses

200

Successful response

application/json

objectOptional

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

patch

/api/v1/oauth/{connector}/reauthorise

HTTPcURLJavaScriptPython

PATCH /api/v1/oauth/{connector}/reauthorise HTTP/1.1
Host: core.wearepatchworks.com
Content-Type: application/json
Accept: */*
Content-Length: 232

{
  "authentication_implementation_id": 1,
  "type": "example_type",
  "timezone": "example_timezone",
  "date_format": "example_date_format",
  "rate_limit_unit": "second",
  "rate_limit_duration": 1,
  "connection_pool_id": 1,
  "variables": "example_variables"
}

{}