Skip to content

Latest commit

 

History

History
345 lines (230 loc) · 9.1 KB

EntitlementsApi.md

File metadata and controls

345 lines (230 loc) · 9.1 KB
Raw

EntitlementsApi

All URIs are relative to http://http:/v1

Method HTTP request Description
entitlementsAllowDelete DELETE /entitlements/allow Remove an entitlement
entitlementsAllowGet GET /entitlements/allow Check if global entitlements are enabled
entitlementsAllowPost POST /entitlements/allow Add an entitlement for all users
entitlementsAllowUuidPost POST /entitlements/allow/{uuid} Grant product access to a customer
entitlementsFreePassGet GET /entitlements/free-pass Verify given free pass hash
entitlementsGet GET /entitlements List all entitlements
entitlementsGlobalGet GET /entitlements/global Lists all past and future global entitlements

entitlementsAllowDelete

List<Object> entitlementsAllowDelete(body, authUser, authorization)

Remove an entitlement

Example

// Import classes:
//import org.openapitools.client.api.EntitlementsApi;

EntitlementsApi apiInstance = new EntitlementsApi();
Long body = 56L; // Long | 
UUID authUser = null; // UUID | 
String authorization = null; // String | 
try {
    List<Object> result = apiInstance.entitlementsAllowDelete(body, authUser, authorization);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling EntitlementsApi#entitlementsAllowDelete");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
body Long
authUser UUID [optional] [default to null]
authorization String [optional] [default to null]

Return type

List<Object>

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json;charset=utf-8
  • Accept: application/json;charset=utf-8

entitlementsAllowGet

List<PersistedEntitlementAccess> entitlementsAllowGet(authUser, authorization, ip, paper)

Check if global entitlements are enabled

Example

// Import classes:
//import org.openapitools.client.api.EntitlementsApi;

EntitlementsApi apiInstance = new EntitlementsApi();
UUID authUser = null; // UUID | 
String authorization = null; // String | 
String ip = null; // String | 
String paper = null; // String | 
try {
    List<PersistedEntitlementAccess> result = apiInstance.entitlementsAllowGet(authUser, authorization, ip, paper);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling EntitlementsApi#entitlementsAllowGet");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
authUser UUID [optional] [default to null]
authorization String [optional] [default to null]
ip String [optional] [default to null]
paper String [optional] [default to null] [enum: HBL, ON, VN, HT, JUNIOR, FORUM, LS]

Return type

List<PersistedEntitlementAccess>

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json;charset=utf-8

entitlementsAllowPost

List<Object> entitlementsAllowPost(body, authUser, authorization)

Add an entitlement for all users

Example

// Import classes:
//import org.openapitools.client.api.EntitlementsApi;

EntitlementsApi apiInstance = new EntitlementsApi();
EntitlementAccess body = new EntitlementAccess(); // EntitlementAccess | 
UUID authUser = null; // UUID | 
String authorization = null; // String | 
try {
    List<Object> result = apiInstance.entitlementsAllowPost(body, authUser, authorization);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling EntitlementsApi#entitlementsAllowPost");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
body EntitlementAccess
authUser UUID [optional] [default to null]
authorization String [optional] [default to null]

Return type

List<Object>

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json;charset=utf-8
  • Accept: application/json;charset=utf-8

entitlementsAllowUuidPost

List<Object> entitlementsAllowUuidPost(uuid, body, authUser, authorization)

Grant product access to a customer

Example

// Import classes:
//import org.openapitools.client.api.EntitlementsApi;

EntitlementsApi apiInstance = new EntitlementsApi();
UUID uuid = null; // UUID | 
EntitlementAccess body = new EntitlementAccess(); // EntitlementAccess | 
UUID authUser = null; // UUID | 
String authorization = null; // String | 
try {
    List<Object> result = apiInstance.entitlementsAllowUuidPost(uuid, body, authUser, authorization);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling EntitlementsApi#entitlementsAllowUuidPost");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
uuid UUID [default to null]
body EntitlementAccess
authUser UUID [optional] [default to null]
authorization String [optional] [default to null]

Return type

List<Object>

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json;charset=utf-8
  • Accept: application/json;charset=utf-8

entitlementsFreePassGet

Boolean entitlementsFreePassGet(authUser, authorization, freePassHash)

Verify given free pass hash

Example

// Import classes:
//import org.openapitools.client.api.EntitlementsApi;

EntitlementsApi apiInstance = new EntitlementsApi();
UUID authUser = null; // UUID | 
String authorization = null; // String | 
String freePassHash = null; // String | 
try {
    Boolean result = apiInstance.entitlementsFreePassGet(authUser, authorization, freePassHash);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling EntitlementsApi#entitlementsFreePassGet");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
authUser UUID [optional] [default to null]
authorization String [optional] [default to null]
freePassHash String [optional] [default to null]

Return type

Boolean

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json;charset=utf-8

entitlementsGet

Map<String, List<String>> entitlementsGet()

List all entitlements

Example

// Import classes:
//import org.openapitools.client.api.EntitlementsApi;

EntitlementsApi apiInstance = new EntitlementsApi();
try {
    Map<String, List<String>> result = apiInstance.entitlementsGet();
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling EntitlementsApi#entitlementsGet");
    e.printStackTrace();
}

Parameters

This endpoint does not need any parameter.

Return type

Map<String, List<String>>

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json;charset=utf-8

entitlementsGlobalGet

List<PersistedEntitlementAccess> entitlementsGlobalGet(authUser, authorization)

Lists all past and future global entitlements

Example

// Import classes:
//import org.openapitools.client.api.EntitlementsApi;

EntitlementsApi apiInstance = new EntitlementsApi();
UUID authUser = null; // UUID | 
String authorization = null; // String | 
try {
    List<PersistedEntitlementAccess> result = apiInstance.entitlementsGlobalGet(authUser, authorization);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling EntitlementsApi#entitlementsGlobalGet");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
authUser UUID [optional] [default to null]
authorization String [optional] [default to null]

Return type

List<PersistedEntitlementAccess>

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json;charset=utf-8