Skip to content

Commit

Permalink
REST API Apps -> Legacy OAuth Apps
Browse files Browse the repository at this point in the history
  • Loading branch information
lavaturtle committed Mar 21, 2024
1 parent bb77701 commit 0a850a0
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
2 changes: 1 addition & 1 deletion source/includes/authenticated_api/_intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ We use [OAuth2](http://oauth.net/2/) to allow organizations to securely grant ac

An *API Application* must be configured within your ControlShift instance before using the API. Access is then granted to this application, and exchanged for a token which is used to authenticate your access to API endpoints.

1. **Set up a new API Application** Log in as an Organisation Owner and navigate to Settings > Integrations > REST API Apps. Add a New Application. Use `urn:ietf:wg:oauth:2.0:oob` as the callback URL unless you plan to allow self-service application authorization.
1. **Set up a new API Application** Log in as an Organisation Owner and navigate to Settings > Integrations > Legacy OAuth Apps. Add a New Application. Use `urn:ietf:wg:oauth:2.0:oob` as the callback URL unless you plan to allow self-service application authorization.

2. Clone the [oauth-api-example](https://github.com/controlshift/oauth-api-example) github repo.

Expand Down
4 changes: 2 additions & 2 deletions source/includes/authenticated_api/_members.md.erb
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ Deletes are synchronous and may take several seconds depending on how many resou

Ownership of Petitions and Events created by the deleted member will be re-assigned to the user account specified in the organisation's settings.

Note that if the member has a user account that is associated with one or more REST API Apps, the member cannot be deleted unless those apps are first deleted through the web UI.
Note that if the member has a user account that is associated with one or more Legacy OAuth Apps, the member cannot be deleted unless those apps are first deleted through the web UI.
If the member cannot be deleted for any reason, the JSON response will contain error messages explaining the problem.

<div></div>
Expand Down Expand Up @@ -122,7 +122,7 @@ Anonymization is synchronous and may take several seconds depending on how many

Ownership of Petitions and Events created by the deleted member will be re-assigned to the user account specified in the organisation's settings.

Note that if the member has a user account that is associated with one or more REST API Apps, the member cannot be anonymized unless those apps are first deleted through the web UI.
Note that if the member has a user account that is associated with one or more Legacy OAuth Apps, the member cannot be anonymized unless those apps are first deleted through the web UI.
If the member cannot be anonymized for any reason, the response will have a 422 Unprocessable Entity status and the JSON body will contain error messages explaining the problem.

<div></div>
Expand Down

0 comments on commit 0a850a0

Please sign in to comment.