pdjshog/php-crowd-client

This is the crowd usermanagement rest resources endpoint documentation

dev-master 2022-12-26 11:29 UTC

Requires

• php: >=7.1
• ext-curl: *
• ext-json: *
• ext-mbstring: *
• guzzlehttp/guzzle: ^7.0

Requires (Dev)

• friendsofphp/php-cs-fixer: ~2.12
• phpunit/phpunit: ^7.4
• squizlabs/php_codesniffer: ~2.6

unlicense

• OpenAPI-Generator contributors

• php
• rest
• api
• sdk
• openapi
• openapitools
• openapi-generator

README

php-crowd-client

This is the crowd usermanagement rest resources endpoint documentation

This PHP package is automatically generated by the OpenAPI Generator project:

• API version: 3.5.0
• Build package: org.openapitools.codegen.languages.PhpClientCodegen

Requirements

PHP 5.5 and later

Installation & Usage

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/adesso-mobile/php-crowd-client.git"
    }
  ],
  "require": {
    "adesso-mobile/php-crowd-client": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

    require_once('/path/to/php-crowd-client/vendor/autoload.php');

Tests

To run the unit tests:

composer install
./vendor/bin/phpunit

Getting Started

Please follow the installation procedure and then run the following:

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



// Configure HTTP basic authorization: crowdAuth
$config = CrowdClient\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new CrowdClient\Api\CrowdApi(
    // 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
);
$groupname = 'groupname_example'; // string | The groupname of the group you want to add the user to
$user = new \CrowdClient\Model\CwdUser(); // \CrowdClient\Model\CwdUser | A User object of the user you want to add. Only 'name' must be set.

try {
    $apiInstance->addUserAsDirectGroupMember($groupname, $user);
} catch (Exception $e) {
    echo 'Exception when calling CrowdApi->addUserAsDirectGroupMember: ', $e->getMessage(), PHP_EOL;
}

?>

Documentation for API Endpoints

All URIs are relative to http://localhost/crowd/rest/usermanagement/1

Class	Method	HTTP request	Description
CrowdApi	addUserAsDirectGroupMember	POST /group/user/direct	Adds user as direct member of group
CrowdApi	authentication	POST /authentication	Authenticates a user. Does not generate an SSO token. For SSO please take a look at the SSO token resource.
CrowdApi	createGroup	POST /group	Adds a new group.
CrowdApi	createUser	POST /user	Creates a new user
CrowdApi	deleteGroup	DELETE /group	Deletes a group
CrowdApi	deleteUser	DELETE /user	Removes a user.
CrowdApi	getGroup	GET /group	Retrieves a group
CrowdApi	getNestedGroupsOfUser	GET /user/group/nested	Retrieves the groups that the user is a nested member of
CrowdApi	getNestedUsersOfGroup	GET /group/user/nested	Retrieves the users that are nested members of the specified group
CrowdApi	getUser	GET /user	Retrieves the user details. Either username or key query parameter must be present.
CrowdApi	removeDirectGroupMembership	DELETE /group/user/direct	Removes the user membership.
CrowdApi	renameUser	POST /user/rename	Renames a user
CrowdApi	search	GET /search	searches for a specific entity-type
CrowdApi	setUsersAttributes	POST /user/attribute	Stores the user attributes. Attribute values will not be overwritten if not specified in attributes.
CrowdApi	updateGroup	PUT /group	Updates an existing group
CrowdApi	updateUser	PUT /user	Updates a user

Documentation For Models

• CwdAttributes
• CwdAttributesAttributes
• CwdGroup
• CwdGroupList
• CwdLink
• CwdPassword
• CwdSearchResponse
• CwdUser
• CwdUserList
• CwdUserRename

Documentation For Authorization

crowdAuth

• Type: HTTP basic authentication

Author