Back to top

Eclipse Authorization Server

This describes the resources that make up the official Eclipse Authorization server.

If you have any problems or requests please contact Christopher Guindon .

Rate Limit

This API currently limits users to 1000 authenticated requests and 1000 anonymous requests an hour.

Authentication

Eclipse Api RESTful API uses OAuth2 Authorization for protected resources.

Error States

The common HTTP Response Status Codes are used.

FORMAT: 1A

Authorization

Eclipse Api RESTful API uses OAuth2 Authorization for protected resources.

OAuth2 Authorization

OAuth2 Authorization
GET/oauth2/authorize{?response_type,client_id,redirect_uri,scope}

The client must redirect to authorization server to gain an authorization_code which can be exchanged for an access_token.

Example URI

GET https://accounts.eclipse.org/oauth2/authorize?response_type=&client_id=&redirect_uri=&scope=
URI Parameters
HideShow
response_type
string (required) 

Indicates that your server expects to receive an authorization code.

client_id
string (required) 

The client ID you received when you first created the application.

redirect_uri
string (required) 

Indicates the URI to return the user to after authorization is complete.

scope
string (required) 

One or more scope values.

state
string (required) 

A random string generated by your application for client validation.

Response  302
HideShow
Body
{
  "code": "authorization_code",
  "state": "123456abcdef"
}
Schema
{
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "state": {
      "type": "string"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}

OAuth2 Token

OAuth2 Token
POST/oauth2/token

Exchange authorization_code for access_token.

Example URI

POST https://accounts.eclipse.org/oauth2/token
Request
HideShow
Body
{
  "grant_type": "authorization_code",
  "code": "1da42105f3e19a3046ccc1de38d00c49e280e1aa",
  "redirect_uri": "https%3A//localhost/"
}
Schema
{
  "type": "object",
  "properties": {
    "grant_type": {
      "type": "string"
    },
    "code": {
      "type": "string"
    },
    "redirect_uri": {
      "type": "string"
    }
  },
  "required": [
    "grant_type",
    "code"
  ],
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "access_token": "fabd8667bc46717fb19f1e35855639c332f34d38",
  "scope": "all",
  "expires_in": 900,
  "token_type": "Bearer",
  "refresh_token": "5d50a0d1392a327a254b749dce3ccf72426b402a"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "access_token": {
      "type": "string"
    },
    "scope": {
      "type": "string",
      "description": "scopes of current token"
    },
    "expires_in": {
      "type": "number"
    },
    "token_type": {
      "type": "string"
    },
    "refresh_token": {
      "type": "string"
    }
  },
  "required": [
    "access_token",
    "scope",
    "expires_in",
    "token_type"
  ]
}

Copyright © 2019 The Eclipse Foundation. All Rights Reserved.

Generated by aglio on 23 Jan 2019