Skip to content
This repository has been archived by the owner on Feb 19, 2024. It is now read-only.

Latest commit

 

History

History
95 lines (60 loc) · 2.33 KB

OauthApi.md

File metadata and controls

95 lines (60 loc) · 2.33 KB

ScrumBoardIt.OauthApi

All URIs are relative to https://api.scrumboard-it.org

Method HTTP request Description
getAuthorizationConfig GET /oauth/{provider}/config Authentication public config
getAuthorizationToken GET /oauth/{provider}/token Authentication token bridge

getAuthorizationConfig

InlineResponse2003 getAuthorizationConfig(provider)

Authentication public config

Example

var ScrumBoardIt = require('scrumboard-it-client');

var apiInstance = new ScrumBoardIt.OauthApi();

var provider = "provider_example"; // String | Name of the provider

apiInstance.getAuthorizationConfig(provider).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name Type Description Notes
provider String Name of the provider

Return type

InlineResponse2003

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

getAuthorizationToken

InlineResponse2004 getAuthorizationToken(provider, code)

Authentication token bridge

Example

var ScrumBoardIt = require('scrumboard-it-client');

var apiInstance = new ScrumBoardIt.OauthApi();

var provider = "provider_example"; // String | Name of the provider

var code = "code_example"; // String | Temporary code returned by the provider

apiInstance.getAuthorizationToken(provider, code).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name Type Description Notes
provider String Name of the provider
code String Temporary code returned by the provider

Return type

InlineResponse2004

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json