Skip to content

Commit

Permalink
update OAuthPermissions.md file.
Browse files Browse the repository at this point in the history
  • Loading branch information
Xiao Hu committed May 20, 2020
1 parent df2b364 commit 0a841ac
Showing 1 changed file with 2 additions and 92 deletions.
94 changes: 2 additions & 92 deletions connect-examples/oauth/OAuthPermissions.md
Original file line number Diff line number Diff line change
@@ -1,95 +1,5 @@
# Square Connect v2 API OAuth Scopes

The Square Connect v2 API requires OAuth scopes with every call to a Connect
endpoint. The following tables provided the needed permissions (scopes) for each
endpoint in a Connect v2 service.

A Connect v2 endpoint URL is formed by appending a service name and endpoint to
`https://connect.squareup.com/v2/`. For example, the **CreateCheckout** endpoint
URL is `https://connect.squareup.com/v2/checkout/createcheckout`

## Checkout Service
|Endpoint|Permissions|
|:-------------|:-------------------------------------------------------------|
|CreateCheckout|ORDERS_WRITE, PAYMENTS_WRITE|

## Customers Service
|Endpoint|Permissions|
|:-------------|:-------------------------------------------------------------|
|CreateCustomer|CUSTOMERS_WRITE|
|UpdateCustomer|CUSTOMERS_WRITE|
|ListCustomers|CUSTOMERS_READ|
|SearchCustomers|CUSTOMERS_READ|
|RetrieveCustomer|CUSTOMERS_READ|
|DeleteCustomer|CUSTOMERS_WRITE|
|CreateCustomerCard|CUSTOMERS_WRITE|
|DeleteCustomerCard|CUSTOMERS_WRITE|

## Employees Service
|Endpoint|Permissions|
|:-------------|:-------------------------------------------------------------|
|RetrieveEmployee|EMPLOYEES_READ|
|ListEmployees|EMPLOYEES_READ|

## Labor Service
|Endpoint|Permissions|
|:-------------|:-------------------------------------------------------------|
|CreateBreakType|TIMECARDS_SETTINGS_WRITE|
|GetBreakType|TIMECARDS_SETTINGS_READ|
|ListBreakTypes|TIMECARDS_SETTINGS_READ|
|UpdateBreakType|TIMECARDS_SETTINGS_READ, TIMECARDS_SETTINGS_WRITE|
|DeleteBreakType|TIMECARDS_SETTINGS_WRITE|
|GetEmployeeWage|EMPLOYEES_READ|
|ListEmployeeWages|EMPLOYEES_READ|
|SearchShifts|TIMECARDS_READ|
|GetShift|TIMECARDS_READ|
|CreateShift|TIMECARDS_WRITE|
|UpdateShift|TIMECARDS_WRITE, TIMECARDS_READ|
|DeleteShift|TIMECARDS_SETTINGS_WRITE|
|UpdateWorkweekConfig|TIMECARDS_SETTINGS_READ, TIMECARDS_SETTINGS_WRITE|
|ListWorkweekConfigs|TIMECARDS_SETTINGS_READ|

## Locations Service
|Endpoint|Permissions|
|:-------------|:-------------------------------------------------------------|
|ListLocations|MERCHANT_PROFILE_READ|
|RetrieveLocation|MERCHANT_PROFILE_READ|
|UpdateLocation|MERCHANT_PROFILE_WRITE|
|CreateLocation|MERCHANT_PROFILE_WRITE|

## Merchants Service
|Endpoint|Permissions|
|:-------------|:-------------------------------------------------------------|
|ListMerchants|MERCHANT_PROFILE_READ|
|RetrieveMerchant|MERCHANT_PROFILE_READ|

## MobileAuthorization Service
|Endpoint|Permissions|
|:-------------|:-------------------------------------------------------------|
|CreateMobileAuthorizationCode|PAYMENTS_WRITE_IN_PERSON|

## Order Service
|Endpoint|Permissions|
|:-------------|:-------------------------------------------------------------|
|SearchOrders|ORDERS_READ|
|CreateOrder|ORDERS_WRITE|
|UpdateOrder|ORDERS_WRITE|
|BatchRetrieveOrders|ORDERS_READ|
|PayOrder|ORDERS_WRITE, PAYMENTS_WRITE|

## Payments Service
|Endpoint|Permissions|
|:-------------|:-------------------------------------------------------------|
|CreatePayment|PAYMENTS_WRITE|
|GetPayment|PAYMENTS_READ|
|CancelPayment|PAYMENTS_WRITE|
|CancelPaymentByIdempotencyKey|PAYMENTS_WRITE|
|CompletePayment|PAYMENTS_WRITE|
|ListPayments|PAYMENTS_READ|

## Refunds Service
|Endpoint|Permissions|
|:-------------|:-------------------------------------------------------------|
|RefundPayment|PAYMENTS_WRITE|
|GetPaymentRefund|PAYMENTS_READ|
|ListPaymentRefunds|PAYMENTS_READ|
endpoint. [OAuth: Permissions Reference](https://developer.squareup.com/docs/oauth-api/square-permissions)
provided all needed permissions (scopes) for each endpoint in a Connect v2 service.

0 comments on commit 0a841ac

Please sign in to comment.