Authentication APIs

Contents

My Cloud Home uses OAuth 2.0 for authentication. All APIs should carry an authorization token, which is a credential that identifies the user and application to the My Cloud Home system. Apps must provide access token through an HTTP header. Refer to the Authentication page for details on getting access token. To access My Cloud Home from a desktop/web/mobile/service, you need to send an Authorization Header in all your requests. The Bearer token included in the Authorization header identifies the user and his/her permissions to access the content. Application must use the {service.auth0.url} url (endpoint url) retrieved in EndpointFetching for making these API calls. The following steps briefly explain different operations in authentication and user management.

  1. Obtain credentials (Client ID/Secret) for your application
    Before you start using My Cloud Home API, you need to register and create a free developer account and request for an app. You will receive your app developer credentials (Unique Client ID/Secret code) for your application.

  2. Obtain an access token from My Cloud authentication server
    On receiving the credentials, apps can request token on behalf of the user. Refer to the Authentication page for details about the token API request/response.

  3. Add access token in all API
    All My Cloud APIs require access token in the header. The token must be in 'Authorization: Bearer xxx' format.


    For example:

    
    GET /cloud/sdk/v2/files/8341 HTTP/1.1
    Host: home.mycloud.com
    Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImt
    
    

  4. Refresh token (optional)
    My Cloud Home access tokens have limited lifetime and app developer needs to get a new token when the existing one expires. Refresh Tokens can be used to obtain new Access Tokens. You can request for refresh token by adding offline_access to the scope. Refer to the Authentication page for detailed information about the token refresh API.

  5. Get user details
    Application may want to get user details such as name, email, profile picture etc. Refer to the Authentication page for detailed information about the user information API.

APIs

Have question about this section?