seiffert / crowd-rest-bundle
此包提供了一个简单的API,用于访问Atlassian Crowd的REST API。
dev-master
2014-07-28 21:43 UTC
Requires
- php: >=5.3.3
- guzzle/guzzle: *
- symfony/symfony: >=2.2.0,<2.3
Requires (Dev)
- pdepend/pdepend: 1.1.0
- phpmd/phpmd: 1.4.0
- phpunit/php-code-coverage: 1.2.*
- phpunit/php-timer: 1.0.4
- phpunit/phpunit: 3.7.*
- squizlabs/php_codesniffer: *
This package is not auto-updated.
Last update: 2024-09-14 13:50:09 UTC
README
此包提供了一个简单的API,用于访问Atlassian Crowd的REST API。
安装
通过Composer安装包
composer.json
:
"require": {
...
"seiffert/crowd-rest-bundle": "dev-master",
...
}
在AppKernel中激活包
app/AppKernel.php
:
public function registerBundles()
{
$bundles = array(
...
new Seiffert\CrowdRestBundle\SeiffertCrowdRestBundle(),
...
);
...
}
配置
要连接到您组织的Crowd实例,您需要在项目配置中添加一些条目(例如,在app/config/config.yml
中)
seiffert_crowd_rest:
url: https://<crowd-url>/crowd/rest/usermanagement/1
application:
name: <application-name>
password: <application-password>
- crowd-url: 您Crowd实例的URL/主机名。
- application-name: 在Crowd中注册的应用程序名称。
- application-password: 在Crowd中注册的应用程序密码。
用法
安装并配置包后,您可以通过将服务seiffert.crowd
注入到每个客户端对象中来使用Crowd API。注入的对象类型为Seiffert\CrowdRestBundle\Crowd
,目前提供以下方法
getUser($username)
:如果用户名与Crowd中的用户记录匹配,则返回Seiffert\CrowdRestBundle\Crowd\UserInterface
实例。如果不匹配,则抛出UserNotFoundException
异常。isAuthenticationValid($username, $password)
:如果用户名和密码与Crowd中的用户记录匹配,则返回true,否则返回false。