API Documentation
Toggle TOC panel

URL structure

1 https://access-service.xy-company.com/api/v1/users/me/expire

Supported methods and overview

Note: This method takes no parameters.

Detailed description

This API endpoint invalidates all valid refresh tokens associated with the Cocoon Data user whose access token is submitted in the request to this endpoint.

If this request succeeds, all valid refresh tokens associated with this Cocoon Data user are invalidated. Every other active session this Cocoon Data user has with the Cocoon Data Platform will terminate once these sessions' access tokens expire.

Passing any invalidated access token in the header of requests to any Cocoon Data API endpoint will cause these requests to fail.

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):

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...


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