Killbill\Client\Swagger\SecurityApi

All URIs are relative to /

Method	HTTP request	Description
addRoleDefinition	POST /1.0/kb/security/roles	Add a new role definition)
addUserRoles	POST /1.0/kb/security/users	Add a new user with roles (to make api requests)
getCurrentUserPermissions	GET /1.0/kb/security/permissions	List user permissions
getCurrentUserSubject	GET /1.0/kb/security/subject	Get user information
getRoleDefinition	GET /1.0/kb/security/roles/{role}	Get role definition
getUserRoles	GET /1.0/kb/security/users/{username}/roles	Get roles associated to a user
invalidateUser	DELETE /1.0/kb/security/users/{username}	Invalidate an existing user
updateRoleDefinition	PUT /1.0/kb/security/roles	Update a new role definition)
updateUserPassword	PUT /1.0/kb/security/users/{username}/password	Update a user password
updateUserRoles	PUT /1.0/kb/security/users/{username}/roles	Update roles associated to a user

addRoleDefinition

\Killbill\Client\Swagger\Model\RoleDefinition addRoleDefinition($body, $xKillbillCreatedBy, $xKillbillReason, $xKillbillComment)

Add a new role definition)

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
$config = Killbill\Client\Swagger\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new Killbill\Client\Swagger\Api\SecurityApi(
    // 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(),
    $config
);
$body = new \Killbill\Client\Swagger\Model\RoleDefinition(); // \Killbill\Client\Swagger\Model\RoleDefinition | 
$xKillbillCreatedBy = "xKillbillCreatedBy_example"; // string | 
$xKillbillReason = "xKillbillReason_example"; // string | 
$xKillbillComment = "xKillbillComment_example"; // string | 

try {
    $result = $apiInstance->addRoleDefinition($body, $xKillbillCreatedBy, $xKillbillReason, $xKillbillComment);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SecurityApi->addRoleDefinition: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Notes
body	\Killbill\Client\Swagger\Model\RoleDefinition
xKillbillCreatedBy	string
xKillbillReason	string	[optional]
xKillbillComment	string	[optional]

Return type

\Killbill\Client\Swagger\Model\RoleDefinition

Authorization

basicAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

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

addUserRoles

\Killbill\Client\Swagger\Model\UserRoles addUserRoles($body, $xKillbillCreatedBy, $xKillbillReason, $xKillbillComment)

Add a new user with roles (to make api requests)

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
$config = Killbill\Client\Swagger\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new Killbill\Client\Swagger\Api\SecurityApi(
    // 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(),
    $config
);
$body = new \Killbill\Client\Swagger\Model\UserRoles(); // \Killbill\Client\Swagger\Model\UserRoles | 
$xKillbillCreatedBy = "xKillbillCreatedBy_example"; // string | 
$xKillbillReason = "xKillbillReason_example"; // string | 
$xKillbillComment = "xKillbillComment_example"; // string | 

try {
    $result = $apiInstance->addUserRoles($body, $xKillbillCreatedBy, $xKillbillReason, $xKillbillComment);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SecurityApi->addUserRoles: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Notes
body	\Killbill\Client\Swagger\Model\UserRoles
xKillbillCreatedBy	string
xKillbillReason	string	[optional]
xKillbillComment	string	[optional]

Return type

\Killbill\Client\Swagger\Model\UserRoles

Authorization

basicAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

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

getCurrentUserPermissions

string[] getCurrentUserPermissions()

List user permissions

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
$config = Killbill\Client\Swagger\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new Killbill\Client\Swagger\Api\SecurityApi(
    // 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(),
    $config
);

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

Parameters

This endpoint does not need any parameter.

Return type

string[]

Authorization

basicAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

getCurrentUserSubject

\Killbill\Client\Swagger\Model\Subject getCurrentUserSubject()

Get user information

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
$config = Killbill\Client\Swagger\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new Killbill\Client\Swagger\Api\SecurityApi(
    // 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(),
    $config
);

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

Parameters

This endpoint does not need any parameter.

Return type

\Killbill\Client\Swagger\Model\Subject

Authorization

basicAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

getRoleDefinition

\Killbill\Client\Swagger\Model\RoleDefinition getRoleDefinition($role)

Get role definition

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
$config = Killbill\Client\Swagger\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new Killbill\Client\Swagger\Api\SecurityApi(
    // 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(),
    $config
);
$role = "role_example"; // string | 

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

Parameters

Name	Type	Description	Notes
role	string

Return type

\Killbill\Client\Swagger\Model\RoleDefinition

Authorization

basicAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

getUserRoles

\Killbill\Client\Swagger\Model\UserRoles getUserRoles($username)

Get roles associated to a user

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
$config = Killbill\Client\Swagger\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new Killbill\Client\Swagger\Api\SecurityApi(
    // 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(),
    $config
);
$username = "username_example"; // string | 

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

Parameters

Name	Type	Description	Notes
username	string

Return type

\Killbill\Client\Swagger\Model\UserRoles

Authorization

basicAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

invalidateUser

invalidateUser($username, $xKillbillCreatedBy, $xKillbillReason, $xKillbillComment)

Invalidate an existing user

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
$config = Killbill\Client\Swagger\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new Killbill\Client\Swagger\Api\SecurityApi(
    // 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(),
    $config
);
$username = "username_example"; // string | 
$xKillbillCreatedBy = "xKillbillCreatedBy_example"; // string | 
$xKillbillReason = "xKillbillReason_example"; // string | 
$xKillbillComment = "xKillbillComment_example"; // string | 

try {
    $apiInstance->invalidateUser($username, $xKillbillCreatedBy, $xKillbillReason, $xKillbillComment);
} catch (Exception $e) {
    echo 'Exception when calling SecurityApi->invalidateUser: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Notes
username	string
xKillbillCreatedBy	string
xKillbillReason	string	[optional]
xKillbillComment	string	[optional]

Return type

void (empty response body)

Authorization

basicAuth

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

updateRoleDefinition

updateRoleDefinition($body, $xKillbillCreatedBy, $xKillbillReason, $xKillbillComment)

Update a new role definition)

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
$config = Killbill\Client\Swagger\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new Killbill\Client\Swagger\Api\SecurityApi(
    // 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(),
    $config
);
$body = new \Killbill\Client\Swagger\Model\RoleDefinition(); // \Killbill\Client\Swagger\Model\RoleDefinition | 
$xKillbillCreatedBy = "xKillbillCreatedBy_example"; // string | 
$xKillbillReason = "xKillbillReason_example"; // string | 
$xKillbillComment = "xKillbillComment_example"; // string | 

try {
    $apiInstance->updateRoleDefinition($body, $xKillbillCreatedBy, $xKillbillReason, $xKillbillComment);
} catch (Exception $e) {
    echo 'Exception when calling SecurityApi->updateRoleDefinition: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Notes
body	\Killbill\Client\Swagger\Model\RoleDefinition
xKillbillCreatedBy	string
xKillbillReason	string	[optional]
xKillbillComment	string	[optional]

Return type

void (empty response body)

Authorization

basicAuth

HTTP request headers

Content-Type: application/json
Accept: Not defined

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

updateUserPassword

updateUserPassword($body, $xKillbillCreatedBy, $username, $xKillbillReason, $xKillbillComment)

Update a user password

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
$config = Killbill\Client\Swagger\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new Killbill\Client\Swagger\Api\SecurityApi(
    // 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(),
    $config
);
$body = new \Killbill\Client\Swagger\Model\UserRoles(); // \Killbill\Client\Swagger\Model\UserRoles | 
$xKillbillCreatedBy = "xKillbillCreatedBy_example"; // string | 
$username = "username_example"; // string | 
$xKillbillReason = "xKillbillReason_example"; // string | 
$xKillbillComment = "xKillbillComment_example"; // string | 

try {
    $apiInstance->updateUserPassword($body, $xKillbillCreatedBy, $username, $xKillbillReason, $xKillbillComment);
} catch (Exception $e) {
    echo 'Exception when calling SecurityApi->updateUserPassword: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Notes
body	\Killbill\Client\Swagger\Model\UserRoles
xKillbillCreatedBy	string
username	string
xKillbillReason	string	[optional]
xKillbillComment	string	[optional]

Return type

void (empty response body)

Authorization

basicAuth

HTTP request headers

Content-Type: application/json
Accept: Not defined

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

updateUserRoles

updateUserRoles($body, $xKillbillCreatedBy, $username, $xKillbillReason, $xKillbillComment)

Update roles associated to a user

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
$config = Killbill\Client\Swagger\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new Killbill\Client\Swagger\Api\SecurityApi(
    // 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(),
    $config
);
$body = new \Killbill\Client\Swagger\Model\UserRoles(); // \Killbill\Client\Swagger\Model\UserRoles | 
$xKillbillCreatedBy = "xKillbillCreatedBy_example"; // string | 
$username = "username_example"; // string | 
$xKillbillReason = "xKillbillReason_example"; // string | 
$xKillbillComment = "xKillbillComment_example"; // string | 

try {
    $apiInstance->updateUserRoles($body, $xKillbillCreatedBy, $username, $xKillbillReason, $xKillbillComment);
} catch (Exception $e) {
    echo 'Exception when calling SecurityApi->updateUserRoles: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Notes
body	\Killbill\Client\Swagger\Model\UserRoles
xKillbillCreatedBy	string
username	string
xKillbillReason	string	[optional]
xKillbillComment	string	[optional]

Return type

void (empty response body)

Authorization

basicAuth

HTTP request headers

Content-Type: application/json
Accept: Not defined

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

Uh oh!

FilesExpand file tree

SecurityApi.md

Latest commit

History

SecurityApi.md

File metadata and controls

Killbill\Client\Swagger\SecurityApi

addRoleDefinition

Example

Parameters

Return type

Authorization

HTTP request headers

addUserRoles

Example

Parameters

Return type

Authorization

HTTP request headers

getCurrentUserPermissions

Example

Parameters

Return type

Authorization

HTTP request headers

getCurrentUserSubject

Example

Parameters

Return type

Authorization

HTTP request headers

getRoleDefinition

Example

Parameters

Return type

Authorization

HTTP request headers

getUserRoles

Example

Parameters

Return type

Authorization

HTTP request headers

invalidateUser

Example

Parameters

Return type

Authorization

HTTP request headers

updateRoleDefinition

Example

Parameters

Return type

Authorization

HTTP request headers

updateUserPassword

Example

Parameters

Return type

Authorization

HTTP request headers

updateUserRoles

Example

Parameters

Return type

Authorization

HTTP request headers