Authentication

Enhanced Authentication Service

URLs

Services are available in two regions, Europe and the United States.

https://partner-integrations.egnyte.com/services/ 

https://us-partner-integrations.egnyte.com/services/

OAuth Flow Proxy

This OAuth flow enhances the Authorization Code Flow. The OAuth Flow Proxy does not require knowing the user's Egnyte domain before initiating the flow. The user will be prompted to provide a domain name in the first step of the flow.

Start the Code Auth Flow Proxy using a request in this format:

<baseUrl>/services/oauth/code?redirect_uri=<clientUri>&client_id=<apiKey>

The end of this flow redirects to the clientUri with an authorization code that should be exchanged for the access token by the client. The domain chosen is available in the Referrer header.

Skipping Domain Choice

If you already know the domain but need to go through the OAuth flow for the user again, you can skip asking for the domain name again.

To skip the first step, add the domain query parameter to the initial Url. The Url can be either the full Url with

<baseUrl>/services/oauth/code?redirect_uri=<clientUri>&client_id=<apiKey>&domain=apidemo.egnyte.com

Example Initialization of Enhanced OAuth Flow

Initial Call:

https://partner-integrations.egnyte.com/services/oauth/code?redirect_uri=https://example.com/&client_id=<apiKey>&state=STATE

The above call will redirect to:

https://example.com/?state=STATE&code=st6b9tzzz5ck48x5yyauswv3

The Egnyte domain name can be retrieved from the Referer header in the final redirect.

Implicit Grant Flow

The implicit grant flow is most commonly used by browser applications. If you want to store access tokens in your back-end, we recommend Authorization Code flow.

This is a two stage flow:

1. Initiate the Authentication Flow
2. Handle the Response from Egnyte

Initiate the Authentication Flow

For example:

https://apidemo.egnyte.com/puboauth/token?client_id=x2g35g8gynb5cedas649m4h4&redirect_uri=https://yourapp.com/oauth&scope=Egnyte.filesystem%20Egnyte.link&state=apidemo123&response_type=token

The user will be taken to an authorization page that asks them to explicitly permit your app to access their Egnyte account. This page displays information about your application taken from your profile. The user must provide their login credentials on this page to authorize your application.

2. Handle the Response from Egnyte

If the user allows your app to access their account, we redirect to:

https://yourapp.com/oauth#access_token=OAUTH_CODE&token_type=bearer&state=apidemo123

If the user denies your app, we redirect to:

https://yourapp.com/oauth#error=access_denied&state=apidemo123

Sample Response Body

Please save this access token and use it when making API requests for this user. Store it encrypted and don't leave it in browser's localStorage.

Internal Applications

Resource Owner Password Credentials Flow

If you are an Egnyte customer developing an application for internal use, you should use the following steps to generate an OAuth token that you will use for all subsequent API calls. These steps correspond to the OAuth 2.0 Resource Owner flow.

Sending the Authentication Request

With the following form-encoded parameters ("application/x-www-form-urlencoded" format) in the request body:

Request Examples

POST /puboauth/token HTTP/1.1
Host: acme.egnyte.com
Content-Type: application/x-www-form-urlencoded
Content-Length: 91
Connection: close

client_id=cba97f3apst9eqzdr5hskggx&client_secret=8WkD6YhXJDZrV7kWABQtr2bXBUY5GRTmuqBpRs4JDWHkNNhSK9&username=test&password=password&grant_type=password

curl -v --request POST -H "Content-Type: application/x-www-form-urlencoded" \
-d grant_type=password -d username=test -d password='password' \
-d client_id=cba97f3apst9eqzdr5hskggx \
-d client_secret=8WkD6YhXJDZrV7kWABQtr2bXBUY5GRTmuqBpRs4JDWHkNNhSK9 \
https://apidemo.egnyte.com/puboauth/token

{
  "access_token": "68zc95e3xv954u6k3hbnma3q",
  "token_type": "bearer",
  "expires_in": -1
}

GET /pubapi/v1/userinfo HTTP/1.1
Host: apidemo.egnyte.com
Authorization: Bearer 68zc95e3xv954u6k3hbnma3q
				

curl -H "Authorization: Bearer 68zc95e3xv954u6k3hbnma3q" \
https://apidemo.egnyte.com/pubapi/v1/userinfo

{
  "id": 123,
  "first_name": "Test",
  "last_name": "User",
  "username": "test"
}
	

POST /pubapi/v1/tokens/revoke HTTP/1.1
Host: apidemo.egnyte.com
Authorization: Bearer 68zc95e3xv954u6k3hbnma3q
Content-Type: application/x-www-form-urlencoded
Content-Length: 30
Connection: close

token=68zc95e3xv954u6k3hbnma3q

curl -v --request POST -H "Content-Type: application/x-www-form-urlencoded" \
- H "authorization: Bearer 68zc95e3xv954u6k3hbnma3q" \
-d token=68zc95e3xv954u6k3hbnma3q https://apidemo.egnyte.com/puboauth/token