New:Introducing Socket Scanning for VS Code Marketplace Extensions.Learn more →
Get Started

adesso-mobile/php-crowd-client

Package Overview
Dependencies
Maintainers
1
Versions
5
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

adesso-mobile/php-crowd-client

This is the crowd usermanagement rest resources endpoint documentation

Source
Packagist
Version
0.1.3
Version published
Total downloads
2K
Maintainers
1
Created
Source

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

ClassMethodHTTP requestDescription
CrowdApiaddUserAsDirectGroupMemberPOST /group/user/directAdds user as direct member of group
CrowdApiauthenticationPOST /authenticationAuthenticates a user. Does not generate an SSO token. For SSO please take a look at the SSO token resource.
CrowdApicreateGroupPOST /groupAdds a new group.
CrowdApicreateUserPOST /userCreates a new user
CrowdApideleteGroupDELETE /groupDeletes a group
CrowdApideleteUserDELETE /userRemoves a user.
CrowdApigetGroupGET /groupRetrieves a group
CrowdApigetNestedGroupsOfUserGET /user/group/nestedRetrieves the groups that the user is a nested member of
CrowdApigetNestedUsersOfGroupGET /group/user/nestedRetrieves the users that are nested members of the specified group
CrowdApigetUserGET /userRetrieves the user details. Either username or key query parameter must be present.
CrowdApiremoveDirectGroupMembershipDELETE /group/user/directRemoves the user membership.
CrowdApirenameUserPOST /user/renameRenames a user
CrowdApisearchGET /searchsearches for a specific entity-type
CrowdApisetUsersAttributesPOST /user/attributeStores the user attributes. Attribute values will not be overwritten if not specified in attributes.
CrowdApiupdateGroupPUT /groupUpdates an existing group
CrowdApiupdateUserPUT /userUpdates a user

Documentation For Models

Documentation For Authorization

crowdAuth

  • Type: HTTP basic authentication

Author

Keywords

php

FAQs

Package last updated on 09 Sep 2019

Related posts