<access-service>/api/v1/users/me/applications/approvals

URL structure

https://access-service.xy-company.com/api/v1/users/me/applications/approvals

Supported methods and overview

• GET - retrieves a list of information about third party (i.e. non-Cocoon Data) client applications which the Cocoon Data user (whose access token is submitted in the request to this endpoint) has approved access to their resources on the Cocoon Data Platform.

Note: This method takes no parameters.

Detailed description

This API endpoint retrieves a list of information about third party (i.e. non-Cocoon Data) client applications which the Cocoon Data user (whose access token is submitted in the request to this endpoint) has approved access to their resources on the Cocoon Data Platform.

This application approval process is a step that occurs after the user signs in from a third party client application which utilizes the authorization code or implicit OAuth 2.0 grant types - i.e. via the <access-service>/api/oauth/authorize API endpoint.

Such a client application could be one that you or your organisation is developing, where this application integrates with Cocoon Data technologies using the Cocoon Data API.

Note: Before any client application can be granted access to a Cocoon Data user's resources, a SafeShare administrator must first have registered the client application on their Cocoon Data Platform instance.

Supported roles

This API endpoint supports requests utilizing Cocoon Data user accounts with the following roles (as described in the SafeShare Administrator's and Organisation Administrator's Guides):

• Originator
• Collaborator
• Ad hoc
• SafeShare administrator
• Organisation administrator

The Cocoon Data Platform's resources available to one of these Cocoon Data users (above) is determined by the access token submitted in the header of requests to this endpoint.

Required headers

The appropriate access token as the Bearer token:

• Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJleHAiOjE0NjcwMTY2NjYsInVzZXJfbmFtZSI6ImFsZXgub...

Returns

If the request succeeded, then an HTTP response status 200 OK is returned.

For successful requests only, a JSON-formatted response containing the following members is also returned:

• applications - An array containing information about all third party client applications which the Cocoon Data user (whose access token is submitted in the request to this endpoint) has approved access to their resources on the Cocoon Data Platform. One of this array's elements contains the member id, whose value is the application's approval ID, which can be utilized to revoke the access that this application has to the user's resources.

  Example (response):

  {
      "applications": []
  }