Skip to content

Latest commit

 

History

History
303 lines (205 loc) · 7.91 KB

ScimUsersApi.md

File metadata and controls

303 lines (205 loc) · 7.91 KB
Raw

eZmaxAPI\ScimUsersApi

All URIs are relative to https://prod.api.appcluster01.ca-central-1.ezmax.com/rest, except if the operation defines another base path.

Method HTTP request Description
usersCreateObjectScimV2() POST /2/scim/Users Create a new User
usersDeleteObjectScimV2() DELETE /2/scim/Users/{userId} Delete an existing User
usersEditObjectScimV2() PUT /2/scim/Users/{userId} Edit an existing User
usersGetListScimV2() GET /2/scim/Users Retrieve User list
usersGetObjectScimV2() GET /2/scim/Users/{userId} Retrieve an existing User

usersCreateObjectScimV2()

usersCreateObjectScimV2($scimUser): \eZmaxAPI\Model\ScimUser

Create a new User

Example

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


// Configure Bearer authorization: Bearer
$config = eZmaxAPI\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new eZmaxAPI\Api\ScimUsersApi(
    // 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
);
$scimUser = new \eZmaxAPI\Model\ScimUser(); // \eZmaxAPI\Model\ScimUser

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

Parameters

Name Type Description Notes
scimUser \eZmaxAPI\Model\ScimUser

Return type

\eZmaxAPI\Model\ScimUser

Authorization

Bearer

HTTP request headers

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

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

usersDeleteObjectScimV2()

usersDeleteObjectScimV2($userId)

Delete an existing User

Example

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


// Configure Bearer authorization: Bearer
$config = eZmaxAPI\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new eZmaxAPI\Api\ScimUsersApi(
    // 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
);
$userId = 'userId_example'; // string

try {
    $apiInstance->usersDeleteObjectScimV2($userId);
} catch (Exception $e) {
    echo 'Exception when calling ScimUsersApi->usersDeleteObjectScimV2: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
userId string

Return type

void (empty response body)

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

usersEditObjectScimV2()

usersEditObjectScimV2($userId, $scimUser): \eZmaxAPI\Model\ScimUser

Edit an existing User

Example

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


// Configure Bearer authorization: Bearer
$config = eZmaxAPI\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new eZmaxAPI\Api\ScimUsersApi(
    // 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
);
$userId = 'userId_example'; // string
$scimUser = new \eZmaxAPI\Model\ScimUser(); // \eZmaxAPI\Model\ScimUser

try {
    $result = $apiInstance->usersEditObjectScimV2($userId, $scimUser);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ScimUsersApi->usersEditObjectScimV2: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
userId string
scimUser \eZmaxAPI\Model\ScimUser

Return type

\eZmaxAPI\Model\ScimUser

Authorization

Bearer

HTTP request headers

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

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

usersGetListScimV2()

usersGetListScimV2($filter): \eZmaxAPI\Model\ScimUserList

Retrieve User list

Example

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


// Configure Bearer authorization: Bearer
$config = eZmaxAPI\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new eZmaxAPI\Api\ScimUsersApi(
    // 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
);
$filter = 'filter_example'; // string | Filter expression for searching users

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

Parameters

Name Type Description Notes
filter string Filter expression for searching users [optional]

Return type

\eZmaxAPI\Model\ScimUserList

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]

usersGetObjectScimV2()

usersGetObjectScimV2($userId): \eZmaxAPI\Model\ScimUser

Retrieve an existing User

Example

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


// Configure Bearer authorization: Bearer
$config = eZmaxAPI\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new eZmaxAPI\Api\ScimUsersApi(
    // 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
);
$userId = 'userId_example'; // string

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

Parameters

Name Type Description Notes
userId string

Return type

\eZmaxAPI\Model\ScimUser

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]