Skip to content

Latest commit

 

History

History
415 lines (279 loc) · 11.6 KB

EntitlementsApi.md

File metadata and controls

415 lines (279 loc) · 11.6 KB

PersonaClient\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

object[] entitlementsAllowDelete($body, $auth_user, $authorization)

Remove an entitlement

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$apiInstance = new PersonaClient\Api\EntitlementsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$body = 56; // int | 
$auth_user = 'auth_user_example'; // string | 
$authorization = 'authorization_example'; // string | 

try {
    $result = $apiInstance->entitlementsAllowDelete($body, $auth_user, $authorization);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EntitlementsApi->entitlementsAllowDelete: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
body int
auth_user string [optional]
authorization string [optional]

Return type

object[]

Authorization

No authorization required

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

entitlementsAllowGet

\PersonaClient\Model\PersistedEntitlementAccess[] entitlementsAllowGet($auth_user, $authorization, $ip, $paper)

Check if global entitlements are enabled

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$apiInstance = new PersonaClient\Api\EntitlementsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$auth_user = 'auth_user_example'; // string | 
$authorization = 'authorization_example'; // string | 
$ip = 'ip_example'; // string | 
$paper = 'paper_example'; // string | 

try {
    $result = $apiInstance->entitlementsAllowGet($auth_user, $authorization, $ip, $paper);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EntitlementsApi->entitlementsAllowGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
auth_user string [optional]
authorization string [optional]
ip string [optional]
paper string [optional]

Return type

\PersonaClient\Model\PersistedEntitlementAccess[]

Authorization

No authorization required

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

entitlementsAllowPost

object[] entitlementsAllowPost($body, $auth_user, $authorization)

Add an entitlement for all users

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$apiInstance = new PersonaClient\Api\EntitlementsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$body = new \PersonaClient\Model\EntitlementAccess(); // \PersonaClient\Model\EntitlementAccess | 
$auth_user = 'auth_user_example'; // string | 
$authorization = 'authorization_example'; // string | 

try {
    $result = $apiInstance->entitlementsAllowPost($body, $auth_user, $authorization);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EntitlementsApi->entitlementsAllowPost: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
body \PersonaClient\Model\EntitlementAccess
auth_user string [optional]
authorization string [optional]

Return type

object[]

Authorization

No authorization required

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

entitlementsAllowUuidPost

object[] entitlementsAllowUuidPost($uuid, $body, $auth_user, $authorization)

Grant product access to a customer

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$apiInstance = new PersonaClient\Api\EntitlementsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$uuid = 'uuid_example'; // string | 
$body = new \PersonaClient\Model\EntitlementAccess(); // \PersonaClient\Model\EntitlementAccess | 
$auth_user = 'auth_user_example'; // string | 
$authorization = 'authorization_example'; // string | 

try {
    $result = $apiInstance->entitlementsAllowUuidPost($uuid, $body, $auth_user, $authorization);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EntitlementsApi->entitlementsAllowUuidPost: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
uuid string
body \PersonaClient\Model\EntitlementAccess
auth_user string [optional]
authorization string [optional]

Return type

object[]

Authorization

No authorization required

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

entitlementsFreePassGet

bool entitlementsFreePassGet($auth_user, $authorization, $free_pass_hash)

Verify given free pass hash

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$apiInstance = new PersonaClient\Api\EntitlementsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$auth_user = 'auth_user_example'; // string | 
$authorization = 'authorization_example'; // string | 
$free_pass_hash = 'free_pass_hash_example'; // string | 

try {
    $result = $apiInstance->entitlementsFreePassGet($auth_user, $authorization, $free_pass_hash);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EntitlementsApi->entitlementsFreePassGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
auth_user string [optional]
authorization string [optional]
free_pass_hash string [optional]

Return type

bool

Authorization

No authorization required

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

entitlementsGet

map[string,string[]] entitlementsGet()

List all entitlements

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$apiInstance = new PersonaClient\Api\EntitlementsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);

try {
    $result = $apiInstance->entitlementsGet();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EntitlementsApi->entitlementsGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

This endpoint does not need any parameter.

Return type

map[string,string[]]

Authorization

No authorization required

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

entitlementsGlobalGet

\PersonaClient\Model\PersistedEntitlementAccess[] entitlementsGlobalGet($auth_user, $authorization)

Lists all past and future global entitlements

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$apiInstance = new PersonaClient\Api\EntitlementsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$auth_user = 'auth_user_example'; // string | 
$authorization = 'authorization_example'; // string | 

try {
    $result = $apiInstance->entitlementsGlobalGet($auth_user, $authorization);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EntitlementsApi->entitlementsGlobalGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
auth_user string [optional]
authorization string [optional]

Return type

\PersonaClient\Model\PersistedEntitlementAccess[]

Authorization

No authorization required

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]