adesso-mobile/php-crowd-client

这是群众用户管理REST资源端点文档

0.1.3 2019-09-09 12:43 UTC

This package is auto-updated.

Last update: 2024-09-09 23:14:03 UTC


README

这是群众用户管理REST资源端点文档

此PHP包由OpenAPI Generator项目自动生成

  • API版本:3.5.0
  • 构建包:org.openapitools.codegen.languages.PhpClientCodegen

要求

PHP 5.5 及以上版本

安装与使用

Composer

要通过Composer安装绑定,请将以下内容添加到composer.json

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

然后运行 composer install

手动安装

下载文件并包含autoload.php

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

测试

要运行单元测试

composer install
./vendor/bin/phpunit

入门指南

请遵循安装过程,然后运行以下命令

<?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;
}

?>

API端点文档

所有URI均相对于 https:///crowd/rest/usermanagement/1

模型文档

授权文档

crowdAuth

  • 类型: HTTP基本认证

作者