Skip to content

Latest commit

 

History

History
86 lines (63 loc) · 4.07 KB

RolesAuditsApi.md

File metadata and controls

86 lines (63 loc) · 4.07 KB
Raw

OpenAPI\Client\RolesAuditsApi

All URIs are relative to https://api.contabo.com, except if the operation defines another base path.

Method HTTP request Description
retrieveRoleAuditsList() GET /v1/roles/audits List history about your roles (audit)

retrieveRoleAuditsList()

retrieveRoleAuditsList($x_request_id, $x_trace_id, $page, $size, $order_by, $role_id, $request_id, $changed_by, $start_date, $end_date): \OpenAPI\Client\Model\ListRoleAuditResponse

List history about your roles (audit)

List and filter the history about your roles.

Example

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


// Configure Bearer (JWT) authorization: bearer
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\RolesAuditsApi(
    // 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
);
$x_request_id = 04e0f898-37b4-48bc-a794-1a57abe6aa31; // string | [Uuid4](https://en.wikipedia.org/wiki/Universally_unique_identifier#Version_4_(random)) to identify individual requests for support cases. You can use [uuidgenerator](https://www.uuidgenerator.net/version4) to generate them manually.
$x_trace_id = 'x_trace_id_example'; // string | Identifier to trace group of requests.
$page = 1; // int | Number of page to be fetched.
$size = 10; // int | Number of elements per page.
$order_by = name:asc; // string[] | Specify fields and ordering (ASC for ascending, DESC for descending) in following format `field:ASC|DESC`.
$role_id = 12345; // int | The identifier of the role.
$request_id = D5FD9FAF-58C0-4406-8F46-F449B8E4FEC3; // string | The requestId of the API call which led to the change.
$changed_by = 23cbb6d6-cb11-4330-bdff-7bb791df2e23; // string | changedBy of the user which led to the change.
$start_date = 2021-01-01; // \DateTime | Start of search time range.
$end_date = 2021-01-01; // \DateTime | End of search time range.

try {
    $result = $apiInstance->retrieveRoleAuditsList($x_request_id, $x_trace_id, $page, $size, $order_by, $role_id, $request_id, $changed_by, $start_date, $end_date);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RolesAuditsApi->retrieveRoleAuditsList: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
x_request_id string Uuid4 to identify individual requests for support cases. You can use uuidgenerator to generate them manually.
x_trace_id string Identifier to trace group of requests. [optional]
page int Number of page to be fetched. [optional]
size int Number of elements per page. [optional]
order_by string[] Specify fields and ordering (ASC for ascending, DESC for descending) in following format `field:ASC DESC`.
role_id int The identifier of the role. [optional]
request_id string The requestId of the API call which led to the change. [optional]
changed_by string changedBy of the user which led to the change. [optional]
start_date \DateTime Start of search time range. [optional]
end_date \DateTime End of search time range. [optional]

Return type

\OpenAPI\Client\Model\ListRoleAuditResponse

Authorization

bearer

HTTP request headers

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

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