Skip to content

Latest commit

 

History

History
602 lines (433 loc) · 17.3 KB

OAuthClientsApi.md

File metadata and controls

602 lines (433 loc) · 17.3 KB

OAuthClientsApi

All URIs are relative to https://api.flipdish.co

Method HTTP request Description
addRedirectUri POST /api/v1.0/{appId}/oauthclients/{oauthAppId}/redirecturis
createOAuthApp POST /api/v1.0/{appId}/oauthclients
deleteOAuthApp DELETE /api/v1.0/{appId}/oauthclients/{oauthAppId}
getOAuthApps GET /api/v1.0/{appId}/oauthclients
getOAuthClientByClientId GET /api/v1.0/{appId}/oauthclients/{oauthAppId}
getOAuthClientSecret GET /api/v1.0/{appId}/oauthclients/{oauthAppId}/secret
getOauthAccessToken GET /api/v1.0/{appId}/oauthclients/{oauthAppId}/accesstoken
getRedirectUris GET /api/v1.0/{appId}/oauthclients/{oauthAppId}/redirecturis
oAuthClientsGetApplications GET /api/v1.0/{appId}/oauthclients/appnames
removeRedirectUri DELETE /api/v1.0/{appId}/oauthclients/{oauthAppId}/redirecturis/{uriId}
updateOAuthApp POST /api/v1.0/{appId}/oauthclients/{oauthAppId}

addRedirectUri

RestApiResultOauthClientRedirectUri addRedirectUri(oauthAppId, uri, appId)

Example

// Import classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.OAuthClientsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

OAuthClientsApi apiInstance = new OAuthClientsApi();
String oauthAppId = "oauthAppId_example"; // String | 
String uri = "uri_example"; // String | 
String appId = "appId_example"; // String | 
try {
    RestApiResultOauthClientRedirectUri result = apiInstance.addRedirectUri(oauthAppId, uri, appId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling OAuthClientsApi#addRedirectUri");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
oauthAppId String
uri String
appId String

Return type

RestApiResultOauthClientRedirectUri

Authorization

oauth2

HTTP request headers

  • Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
  • Accept: application/json, text/json, application/xml, text/xml

createOAuthApp

createOAuthApp(oAuthApp, appId)

Example

// Import classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.OAuthClientsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

OAuthClientsApi apiInstance = new OAuthClientsApi();
OAuthApp oAuthApp = new OAuthApp(); // OAuthApp | 
String appId = "appId_example"; // String | 
try {
    apiInstance.createOAuthApp(oAuthApp, appId);
} catch (ApiException e) {
    System.err.println("Exception when calling OAuthClientsApi#createOAuthApp");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
oAuthApp OAuthApp
appId String

Return type

null (empty response body)

Authorization

oauth2

HTTP request headers

  • Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
  • Accept: application/json, text/json, application/xml, text/xml

deleteOAuthApp

deleteOAuthApp(oauthAppId, appId)

Example

// Import classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.OAuthClientsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

OAuthClientsApi apiInstance = new OAuthClientsApi();
String oauthAppId = "oauthAppId_example"; // String | 
String appId = "appId_example"; // String | 
try {
    apiInstance.deleteOAuthApp(oauthAppId, appId);
} catch (ApiException e) {
    System.err.println("Exception when calling OAuthClientsApi#deleteOAuthApp");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
oauthAppId String
appId String

Return type

null (empty response body)

Authorization

oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/json, application/xml, text/xml

getOAuthApps

RestApiArrayResultOAuthApp getOAuthApps(appId, oauthAppName)

Example

// Import classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.OAuthClientsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

OAuthClientsApi apiInstance = new OAuthClientsApi();
String appId = "appId_example"; // String | 
String oauthAppName = "oauthAppName_example"; // String | 
try {
    RestApiArrayResultOAuthApp result = apiInstance.getOAuthApps(appId, oauthAppName);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling OAuthClientsApi#getOAuthApps");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
appId String
oauthAppName String [optional]

Return type

RestApiArrayResultOAuthApp

Authorization

oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/json, application/xml, text/xml

getOAuthClientByClientId

RestApiResultOAuthApp getOAuthClientByClientId(oauthAppId, appId)

Example

// Import classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.OAuthClientsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

OAuthClientsApi apiInstance = new OAuthClientsApi();
String oauthAppId = "oauthAppId_example"; // String | 
String appId = "appId_example"; // String | 
try {
    RestApiResultOAuthApp result = apiInstance.getOAuthClientByClientId(oauthAppId, appId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling OAuthClientsApi#getOAuthClientByClientId");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
oauthAppId String
appId String

Return type

RestApiResultOAuthApp

Authorization

oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/json, application/xml, text/xml

getOAuthClientSecret

RestApiStringResult getOAuthClientSecret(oauthAppId, appId)

Example

// Import classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.OAuthClientsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

OAuthClientsApi apiInstance = new OAuthClientsApi();
String oauthAppId = "oauthAppId_example"; // String | 
String appId = "appId_example"; // String | 
try {
    RestApiStringResult result = apiInstance.getOAuthClientSecret(oauthAppId, appId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling OAuthClientsApi#getOAuthClientSecret");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
oauthAppId String
appId String

Return type

RestApiStringResult

Authorization

oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/json, application/xml, text/xml

getOauthAccessToken

RestApiStringResult getOauthAccessToken(oauthAppId, appId)

Example

// Import classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.OAuthClientsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

OAuthClientsApi apiInstance = new OAuthClientsApi();
String oauthAppId = "oauthAppId_example"; // String | 
String appId = "appId_example"; // String | 
try {
    RestApiStringResult result = apiInstance.getOauthAccessToken(oauthAppId, appId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling OAuthClientsApi#getOauthAccessToken");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
oauthAppId String
appId String

Return type

RestApiStringResult

Authorization

oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/json, application/xml, text/xml

getRedirectUris

RestApiArrayResultOauthClientRedirectUri getRedirectUris(oauthAppId, appId)

Example

// Import classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.OAuthClientsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

OAuthClientsApi apiInstance = new OAuthClientsApi();
String oauthAppId = "oauthAppId_example"; // String | 
String appId = "appId_example"; // String | 
try {
    RestApiArrayResultOauthClientRedirectUri result = apiInstance.getRedirectUris(oauthAppId, appId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling OAuthClientsApi#getRedirectUris");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
oauthAppId String
appId String

Return type

RestApiArrayResultOauthClientRedirectUri

Authorization

oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/json, application/xml, text/xml

oAuthClientsGetApplications

Object oAuthClientsGetApplications(appId)

Example

// Import classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.OAuthClientsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

OAuthClientsApi apiInstance = new OAuthClientsApi();
String appId = "appId_example"; // String | 
try {
    Object result = apiInstance.oAuthClientsGetApplications(appId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling OAuthClientsApi#oAuthClientsGetApplications");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
appId String

Return type

Object

Authorization

oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/json, application/xml, text/xml

removeRedirectUri

removeRedirectUri(oauthAppId, uriId, appId)

Example

// Import classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.OAuthClientsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

OAuthClientsApi apiInstance = new OAuthClientsApi();
String oauthAppId = "oauthAppId_example"; // String | 
Integer uriId = 56; // Integer | 
String appId = "appId_example"; // String | 
try {
    apiInstance.removeRedirectUri(oauthAppId, uriId, appId);
} catch (ApiException e) {
    System.err.println("Exception when calling OAuthClientsApi#removeRedirectUri");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
oauthAppId String
uriId Integer
appId String

Return type

null (empty response body)

Authorization

oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/json, application/xml, text/xml

updateOAuthApp

updateOAuthApp(oauthAppId, oAuthApp, appId)

Example

// Import classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.OAuthClientsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

OAuthClientsApi apiInstance = new OAuthClientsApi();
String oauthAppId = "oauthAppId_example"; // String | 
OAuthApp oAuthApp = new OAuthApp(); // OAuthApp | 
String appId = "appId_example"; // String | 
try {
    apiInstance.updateOAuthApp(oauthAppId, oAuthApp, appId);
} catch (ApiException e) {
    System.err.println("Exception when calling OAuthClientsApi#updateOAuthApp");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
oauthAppId String
oAuthApp OAuthApp
appId String

Return type

null (empty response body)

Authorization

oauth2

HTTP request headers

  • Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
  • Accept: application/json, text/json, application/xml, text/xml