openeuropa/syncope-php-client

此包已被 废弃 且不再维护。未建议替代包。

维护者

详细信息

github.com/openeuropa/syncope-php-client

源代码

问题

安装次数: 1,169

依赖项: 1

建议者: 0

安全: 0

星标: 1

关注者: 11

分支: 2

开放问题: 1

dev-master 2021-04-20 08:01 UTC

Requires

Requires (Dev)

EUPL-1.2 38b36e1c1c3ec987853f0ca6aec48345651e4469

This package is auto-updated.

Last update: 2021-05-20 08:14:42 UTC

README

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

  • API版本：2.1.2-SNAPSHOT
  • 构建包：org.openapitools.codegen.languages.PhpClientCodegen

要重新生成库，请查找 此处 的说明

要求

PHP 5.5 及以上

安装与使用

Composer

要使用Composer安装绑定，请将以下内容添加到 composer.json

{
  "repositories": [
    {
      "type": "git",
      "url": "https://github.com/openeuropa/syncope-php-client.git"
    }
  ],
  "require": {
    "openeuropa/syncope-php-client": "*@dev"
  }
}

然后运行 composer install

手动安装

下载文件并包含 autoload.php

    require_once('/path/to/Syncope PHP Client/vendor/autoload.php');

测试

要运行单元测试

composer install
./vendor/bin/phpunit

逐步调试

要启用从命令行进行逐步调试，请将任何值的 XDEBUG_SESSION 环境变量传递给容器

docker-compose exec -e XDEBUG_SESSION=1 web <your command>

请注意，从XDebug 3开始，如果设置了变量但您的客户端没有监听调试连接，将在控制台输出连接错误消息。错误消息将导致PHPUnit测试出现假阴性。

要从浏览器中启动逐步调试，请使用浏览器扩展或像在 https://www.jetbrains.com/phpstorm/marklets/ 生成的那样设置正确的cookie。

入门

请按照 安装过程 进行操作，然后运行以下命令

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

// Configure HTTP basic authorization: BasicAuthentication
$config = OpenEuropa\SyncopePhpClient\Configuration::getDefaultConfiguration()
    ->setUsername('YOUR_USERNAME')
    ->setPassword('YOUR_PASSWORD');
// Configure HTTP basic authorization: Bearer
$config = OpenEuropa\SyncopePhpClient\Configuration::getDefaultConfiguration()
    ->setUsername('YOUR_USERNAME')
    ->setPassword('YOUR_PASSWORD');

$apiInstance = new OpenEuropa\SyncopePhpClient\Api\AccessTokensApi(
    // 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
);
$xSyncopeDomain = 'Master'; // string | 
$page = 1; // int | query conditions
$size = 25; // int | 
$orderby = 'orderby_example'; // string | 

try {
    $apiInstance->callList($xSyncopeDomain, $page, $size, $orderby);
} catch (Exception $e) {
    echo 'Exception when calling AccessTokensApi->callList: ', $e->getMessage(), PHP_EOL;
}

?>

API端点的文档

所有URI相对于 http://syncope-vm.apache.org:9080/syncope/rest

类 方法 HTTP请求 描述
AccessTokensApi callList GET /accessTokens 返回匹配给定查询的现有访问令牌的分页列表。
AccessTokensApi delete DELETE /accessTokens/{key} 使匹配提供的键的访问令牌无效。
AccessTokensApi login POST /accessTokens/login 如果身份验证成功，则返回一个空的响应，其中包含 X-Syncope-Token 标头值。提供的值是经过签名的JSON Web Token。
AccessTokensApi logout POST /accessTokens/logout 使请求用户的访问令牌无效。
AccessTokensApi refresh POST /accessTokens/refresh 返回一个空的响应，其中包含 X-Syncope-Token 标头值，具有扩展的有效期。提供的值是经过签名的JSON Web Token。
AnyObjectsApi associateAnyObject POST /anyObjects/{key}/associate/{action} 在指定的实体上执行资源相关操作。
AnyObjectsApi createAnyObject POST /anyObjects 创建一个新的任意对象。
AnyObjectsApi deassociateAnyObject POST /anyObjects/{key}/deassociate/{action} 在指定的实体上执行资源相关操作。
AnyObjectsApi deleteAnyObject DELETE /anyObjects/{key} 删除与提供的键匹配的任意对象。
AnyObjectsApi deleteAnyObjectAttribute DELETE /anyObjects/{key}/{schemaType}/{schema} 删除给定模式类型和模式下属于指定任意对象的属性。
AnyObjectsApi readAnyObject GET /anyObjects/{key} 读取与提供的键匹配的任意对象。
AnyObjectsApi readAnyObjectAttribute GET /anyObjects/{key}/{schemaType}/{schema} 读取给定模式类型和模式下属于指定任意对象的属性。注意，对于UserService、GroupService和AnyObjectService子类，如果key参数看起来像是一个UUID，则解释为键，否则解释为（用户）名称。
AnyObjectsApi readAnyObjectAttributeForSchema GET /anyObjects/{key}/{schemaType} 读取给定模式类型下属于指定任意对象的所有属性的列表。注意，对于UserService、GroupService和AnyObjectService子类，如果key参数看起来像是一个UUID，则解释为键，否则解释为（用户）名称。
AnyObjectsApi searchAnyObject GET /anyObjects 返回与给定查询匹配的任意对象的分页列表。
AnyObjectsApi updateAnyObject PUT /anyObjects/{key} 更新与提供的键匹配的任意对象。
AnyObjectsApi updateAnyObjectAttribute PUT /anyObjects/{key}/{schemaType}/{schema} 为给定的模式类型和模式添加或替换属于指定任意对象的属性。
AnyObjectsApi updateAnyObjectPartial PATCH /anyObjects/{key} 更新与提供的键匹配的任意对象。
AnyTypeClassesApi createAnyTypeClass POST /anyTypeClasses 创建一个新的anyTypeClass。
AnyTypeClassesApi deleteAnyTypeClass DELETE /anyTypeClasses/{key} 删除与提供的键匹配的anyTypeClass。
AnyTypeClassesApi listAnyTypeClass GET /anyTypeClasses 返回所有anyTypeClass的列表。
AnyTypeClassesApi readAnyTypeClass GET /anyTypeClasses/{key} 返回与匹配的键匹配的anyTypeClass。
AnyTypeClassesApi updateAnyTypeClass PUT /anyTypeClasses/{key} 更新与提供的键匹配的anyTypeClass。
AnyTypesApi createAnyType POST /anyTypes 创建一个新的anyType。
AnyTypesApi deleteAnyType DELETE /anyTypes/{key} 删除与提供的键匹配的anyType。
AnyTypesApi listAnyType GET /anyTypes 返回所有anyTypes的列表。
AnyTypesApi readAnyType GET /anyTypes/{key} 返回与匹配的键匹配的anyType。
AnyTypesApi updateAnyType PUT /anyTypes/{key} 更新与提供的键匹配的anyType。
ApplicationsApi create POST /applications 创建一个新的应用程序。
ApplicationsApi delete1 DELETE /applications/{key} 删除与提供的键匹配的应用程序。
ApplicationsApi list3 GET /applications 返回所有应用程序的列表。
ApplicationsApi read5 GET /applications/{key} 返回与匹配的键匹配的应用程序。
ApplicationsApi readPrivilege GET /applications/privileges/{key} 返回与匹配的键匹配的权限。
ApplicationsApi update PUT /applications/{key} 更新与提供的键匹配的应用程序。
CamelRoutesApi list4 GET /camelRoutes/{anyTypeKind} 列出给定任意类型类型的所有路由。
CamelRoutesApi metrics GET /camelRoutes/metrics 提供Camel指标。
CamelRoutesApi read6 GET /camelRoutes/{anyTypeKind}/{key} 读取具有给定键的路由。
CamelRoutesApi restartContext POST /camelRoutes/restartContext 重新启动底层的Apache Camel上下文。
CamelRoutesApi update PUT /camelRoutes/{anyTypeKind}/{key} 更新给定的路由。
ConfigurationApi delete1 删除 /configurations/{schema} 删除与指定模式匹配的配置参数。
ConfigurationApi 导出 获取 /configurations/stream 将内部存储内容导出为可下载的XML文件。
ConfigurationApi 获取 获取 /configurations/{schema} 返回与指定模式匹配的配置参数。
ConfigurationApi 列表5 获取 /configurations 返回所有配置参数。
ConfigurationApi 设置 更新 /configurations/{schema} 创建或更新具有给定模式的配置参数。
ConnectorHistoryApi delete1 删除 /connectorsHistory/{key} 删除与提供的键匹配的连接器配置历史实例。
ConnectorHistoryApi 列表6 获取 /connectorsHistory/{connectorKey} 返回给定连接器实例键的所有连接器配置历史实例列表。
ConnectorHistoryApi 恢复 POST /connectorsHistory/{key} 恢复与提供的键匹配的连接器配置历史实例。
ConnectorsApi buildObjectClassInfo POST /connectors/{key}/supportedObjectClasses 根据提供的配置，为与给定连接器实例键匹配的连接器包构建ConnId对象类信息列表。
ConnectorsApi 检查 POST /connectors/check 检查是否能够建立到资源的连接。
ConnectorsApi create POST /connectors 创建新的连接器实例。
ConnectorsApi delete1 删除 /connectors/{key} 删除与提供的键匹配的连接器实例。
ConnectorsApi getBundles 获取 /connectors/bundles 返回具有选定语言属性键的可用连接器包。
ConnectorsApi 列表7 获取 /connectors 返回匹配语言属性键的所有连接器实例列表。
ConnectorsApi read7 获取 /connectors/{key} 返回具有匹配键的连接器实例。
ConnectorsApi readByResource 获取 /connectors/byResource/{resourceName} 返回匹配资源的连接器实例。
ConnectorsApi reload POST /connectors/reload 重新加载所有连接器包和实例。
ConnectorsApi update 更新 /connectors/{key} 更新与提供的键匹配的连接器实例。
DomainsApi create POST /domains 创建新的域。
DomainsApi delete1 删除 /domains/{key} 删除与提供的键匹配的域。
DomainsApi 列表8 获取 /domains 返回所有域的列表。
DomainsApi read8 获取 /domains/{key} 返回具有匹配键的域。
DomainsApi update 更新 /domains/{key} 更新与提供的键匹配的域。
DynamicRealmsApi create POST /dynRealms 创建新的动态域。
DynamicRealmsApi delete1 删除 /dynRealms/{key} 删除与提供的键匹配的动态域。
DynamicRealmsApi 列表9 获取 /dynRealms 返回所有动态域的列表。
DynamicRealmsApi read9 获取 /dynRealms/{key} 返回具有匹配键的动态域。
DynamicRealmsApi update 更新 /dynRealms/{key} 更新与提供的键匹配的动态域。
GroupsApi associateGroup POST /groups/{key}/associate/{action} 在指定的实体上执行资源相关操作。
GroupsApi createGroup POST /groups 创建新的组。
GroupsApi deassociateGroup POST /groups/{key}/deassociate/{action} 在指定的实体上执行资源相关操作。
GroupsApi deleteGroup 删除 /groups/{key} 删除与提供的键匹配的任意对象。
GroupsApi deleteGroupAttribute 删除 /groups/{key}/{schemaType}/{schema} 删除给定模式类型和模式下属于指定任意对象的属性。
GroupsApi own 获取 /groups/own 此方法允许用户读取自己的组。
GroupsApi provisionMembers POST /groups/{key}/members/{action} 从/到所有关联的资源（为）分配（取消分配）给定组的所有成员。
GroupsApi readGroup 获取 /groups/{key} 读取与提供的键匹配的任意对象。
GroupsApi readGroupAttribute 获取 /groups/{key}/{schemaType}/{schema} 读取给定模式类型和模式下属于指定任意对象的属性。注意，对于UserService、GroupService和AnyObjectService子类，如果key参数看起来像是一个UUID，则解释为键，否则解释为（用户）名称。
GroupsApi readGroupAttributeForSchema 获取 /groups/{key}/{schemaType} 读取给定模式类型下属于指定任意对象的所有属性的列表。注意，对于UserService、GroupService和AnyObjectService子类，如果key参数看起来像是一个UUID，则解释为键，否则解释为（用户）名称。
GroupsApi searchGroup 获取 /groups 返回与给定查询匹配的任意对象的分页列表。
GroupsApi updateGroup 更新 /groups/{key} 更新与提供的键匹配的组。
GroupsApi updateGroupAttribute 更新 /groups/{key}/{schemaType}/{schema} 为给定的模式类型和模式添加或替换属于指定任意对象的属性。
GroupsApi 更新组_0 PATCH /groups/{key} 更新与提供的键匹配的组。
ImplementationsApi create POST /implementations/{type}/{key} 创建一个新的实现。
ImplementationsApi delete1 DELETE /implementations/{type}/{key} 删除与给定键和类型匹配的实现。
ImplementationsApi list10 GET /implementations/{type} 返回给定类型的所有实现列表。
ImplementationsApi read13 GET /implementations/{type}/{key} 返回匹配类型和键的实现。
ImplementationsApi update PUT /implementations/{type}/{key} 更新现有的实现。
LoggersApi delete1 DELETE /loggers/{type}/{name} 删除与匹配名称的记录器。
LoggersApi events GET /loggers/events 返回审计中所有管理的活动列表。
LoggersApi getLastLogStatements GET /loggers/memoryAppenders/{memoryAppender}/lastLogStatements 返回提供的内存追加器中可用的最后日志语句。
LoggersApi list11 GET /loggers/{type} 返回匹配类型的记录器列表。
LoggersApi memoryAppenders GET /loggers/memoryAppenders 返回当前日志配置中可用的内存追加器列表。
LoggersApi read14 GET /loggers/{type}/{name} 返回匹配类型和名称的记录器。
LoggersApi update PUT /loggers/{type}/{key} 创建或更新（如果存在）与匹配名称的记录器。
MailTemplatesApi create POST /mailTemplates 创建一个新的邮件模板。
MailTemplatesApi delete1 DELETE /mailTemplates/{key} 删除与给定键匹配的邮件模板。
MailTemplatesApi getFormat GET /mailTemplates/{key}/{format} 获取给定键和格式的模板，如果可用。
MailTemplatesApi list12 GET /mailTemplates 返回所有邮件模板的列表。
MailTemplatesApi read15 GET /mailTemplates/{key} 返回与给定键匹配的邮件模板。
MailTemplatesApi removeFormat DELETE /mailTemplates/{key}/{format} 删除给定键和格式的模板，如果可用。
MailTemplatesApi setFormat PUT /mailTemplates/{key}/{format} 设置给定键和格式的模板，如果可用。
NotificationsApi actionJob POST /notifications/job 在通知作业上执行操作。
NotificationsApi create POST /notifications 创建一个新的通知。
NotificationsApi delete1 DELETE /notifications/{key} 删除与给定键匹配的通知。
NotificationsApi getJob GET /notifications/job 返回通知作业的详细信息。
NotificationsApi list13 GET /notifications 返回所有通知的列表。
NotificationsApi read16 GET /notifications/{key} 返回与给定键匹配的通知。
NotificationsApi update1 PUT /notifications/{key} 更新与给定键匹配的通知。
OIDCClientsApi createLoginRequest POST /oidcclient/clients/loginRequest 生成与提供的op匹配的Provider的OpenID Connect身份验证请求。
OIDCClientsApi createLogoutRequest POST /oidcclient/clients/logout 返回提供的op的endSession端点。
OIDCClientsApi login1 POST /oidcclient/clients/login 使用提供的授权代码通过OpenID Connect令牌过程，并在找到匹配的用户时创建JWT。
OIDCProvidersApi create POST /oidcclient/providers 创建一个新的OIDC Provider。
OIDCProvidersApi createFromDiscovery POST /oidcclient/providers/fromDiscovery 使用其发现文档创建一个新的OIDC Provider。
OIDCProvidersApi delete1 DELETE /oidcclient/providers/{key} 删除与匹配键的OIDC Provider。
OIDCProvidersApi getActionsClasses GET /oidcclient/providers/actionsClasses 返回可用的OIDCProviderActions实现列表。
OIDCProvidersApi list14 GET /oidcclient/providers 返回所有定义的OIDC Providers列表。
OIDCProvidersApi read17 GET /oidcclient/providers/{key} 如果存在，则返回匹配密钥的 OIDC 提供者。
OIDCProvidersApi update1 PUT /oidcclient/providers/{key} 更新匹配密钥的 OIDC 提供者。
PoliciesApi create POST /policies/{type} 创建新的策略。
PoliciesApi delete1 DELETE /policies/{type}/{key} 删除匹配给定密钥的策略。
PoliciesApi list15 GET /policies/{type} 返回匹配类型的策略列表。
PoliciesApi read18 GET /policies/{type}/{key} 返回匹配给定密钥的策略。
PoliciesApi update1 PUT /policies/{type}/{key} 更新匹配给定密钥的策略。
RealmsApi createRootedRealm POST /realms/{parentPath} 在给定路径下创建新的域。
RealmsApi deleteRealm DELETE /realms/{fullPath} 删除给定路径下的域。
RealmsApi listRealm GET /realms/{fullPath} 返回给定路径根部的域。
RealmsApi listRealm_0 GET /realms 返回所有域的列表。
RealmsApi updateRealm PUT /realms/{fullPath} 更新给定路径下的域。
ReconciliationApi pull POST /reconciliation/pull 从外部资源拉取指定的用户、组或任何对象到 Syncope。
ReconciliationApi push POST /reconciliation/push 将 Syncope 中的指定用户、组或任何对象推送到外部资源。
ReconciliationApi status GET /reconciliation 获取 Syncope 和给定外部资源上与指定用户、组或任何对象相关的当前属性。
RelationshipTypesApi create1 POST /relationshipTypes 创建新的关系类型。
RelationshipTypesApi delete1 DELETE /relationshipTypes/{key} 删除匹配提供的密钥的关系类型。
RelationshipTypesApi list18 GET /relationshipTypes 返回所有关系类型的列表。
RelationshipTypesApi read19 GET /relationshipTypes/{key} 返回匹配密钥的关系类型。
RelationshipTypesApi update1 PUT /relationshipTypes/{key} 更新匹配提供的密钥的关系类型。
RemediationsApi delete1 DELETE /remediations/{key} 删除匹配给定密钥的补救措施。
RemediationsApi list19 GET /remediations 返回所有补救措施的列表。
RemediationsApi read20 GET /remediations/{key} 返回匹配密钥的补救措施。
RemediationsApi remedy PATCH /remediations/{remediationKey} 通过创建提供的用户、组或任何对象来执行补救。
RemediationsApi remedy1 DELETE /remediations/{remediationKey}/{anyKey} 通过创建提供的用户、组或任何对象来执行补救。
RemediationsApi remedy2 POST /remediations/{remediationKey} 通过创建提供的用户、组或任何对象来执行补救。
ReportTemplatesApi create1 POST /reportTemplates 创建新的报告模板。
ReportTemplatesApi delete1 DELETE /reportTemplates/{key} 删除匹配给定密钥的报告模板。
ReportTemplatesApi getFormat1 GET /reportTemplates/{key}/{format} 获取给定键和格式的模板，如果可用。
ReportTemplatesApi list21 GET /reportTemplates 返回所有报告模板的列表。
ReportTemplatesApi read22 GET /reportTemplates/{key} 返回匹配密钥的报告模板。
ReportTemplatesApi removeFormat DELETE /reportTemplates/{key}/{format} 删除给定键和格式的模板，如果可用。
ReportTemplatesApi setFormat PUT /reportTemplates/{key}/{format} 设置给定键和格式的模板，如果可用。
ReportsApi actionJob POST /reports/jobs/{key} 对现有可执行作业执行操作。
ReportsApi create1 POST /reports 创建新的报告。
ReportsApi delete1 DELETE /reports/{key} 删除匹配密钥的报告。
ReportsApi deleteExecution DELETE /reports/executions/{executionKey} 删除匹配提供的密钥的可执行执行。
ReportsApi deleteExecutions DELETE /reports/{key}/executions 删除匹配给定查询的执行。
ReportsApi execute POST /reports/{key}/execute 执行匹配给定查询的可执行操作。
ReportsApi exportExecutionResult GET /reports/executions/{executionKey}/stream 导出与请求格式匹配的具有匹配键的报告执行。
ReportsApi getJob1 GET /reports/jobs/{key} 返回与给定键匹配的可执行作业（运行或计划中的）。
ReportsApi list20 GET /reports 返回所有现有报告的列表。
ReportsApi listExecutions GET /reports/{key}/executions 返回与给定查询匹配的执行的分页列表。
ReportsApi listJobs GET /reports/jobs 列出作业（运行和/或计划中）。
ReportsApi listRecentExecutions GET /reports/executions/recent 返回最近完成的执行列表，按结束日期降序排列。
ReportsApi read21 GET /reports/{key} 返回具有匹配键的报告。
ReportsApi update1 PUT /reports/{key} 更新具有匹配键的报告。
ResourceHistoryApi delete1 DELETE /resourcesHistory/{key} 删除与提供的键匹配的资源配置历史。
ResourceHistoryApi list22 GET /resourcesHistory/{resourceKey} 返回给定资源键的所有资源配置历史列表。
ResourceHistoryApi restore1 POST /resourcesHistory/{key} 恢复与提供的键匹配的资源配置历史。
ResourcesApi check1 POST /resources/check 检查是否能够建立到资源的连接。
ResourcesApi create1 POST /resources 创建一个新资源。
ResourcesApi delete1 DELETE /resources/{key} 删除与给定名称匹配的资源。
ResourcesApi list23 GET /resources 返回所有资源的列表。
ResourcesApi listConnObjects GET /resources/{key}/{anyTypeKey} 返回给定类型、匹配页面/大小条件的从外部资源获取的连接器对象的分页列表。
ResourcesApi read23 GET /resources/{key} 返回具有匹配名称的资源。
ResourcesApi readConnObject GET /resources/{key}/{anyTypeKey}/{anyKey} 返回具有给定类型和键的外部资源中的连接器对象。
ResourcesApi removeSyncToken DELETE /resources/{key}/{anyTypeKey} 从给定的资源中删除与给定任何类型关联的同步令牌值。
ResourcesApi setLatestSyncToken POST /resources/{key}/{anyTypeKey} 查询给定资源的底层连接器，以获取与给定任何类型关联的最新同步令牌值，并将其存储在内部，以供以后使用。
ResourcesApi update1 PUT /resources/{key} 更新与给定名称匹配的资源。
RolesApi createRole POST /roles 创建一个新角色。
RolesApi deleteRole DELETE /roles/{key} 删除与提供的键匹配的角色。
RolesApi getConsoleLayoutInfo GET /roles/{key}/consoleLayout 获取具有给定键的角色的控制台布局信息，如果可用，则作为JSON字符串。
RolesApi listRoles GET /roles 返回所有角色的列表。
RolesApi readRole GET /roles/{key} 返回具有匹配键的角色。
RolesApi removeConsoleLayoutInfo DELETE /roles/{key}/consoleLayout 删除具有给定键的角色的控制台布局信息，如果可用。
RolesApi setConsoleLayoutInfo PUT /roles/{key}/consoleLayout 设置具有给定键的角色的控制台布局信息，如果可用，则作为JSON字符串。
RolesApi updateRole PUT /roles/{key} 更新与提供的键匹配的角色。
SAML2IdPApi delete1 DELETE /saml2sp/identityProviders/{key} 删除与匹配的entityID匹配的SAML 2.0身份提供者。
SAML2IdPApi getActionsClasses1 GET /saml2sp/identityProviders/actionsClasses 返回可用的SAML2IdPActions实现列表。
SAML2IdPApi importFromMetadata POST /saml2sp/identityProviders 导入提供的XML元数据中可用的SAML 2.0身份提供者定义。
SAML2IdPApi list25 GET /saml2sp/identityProviders 返回所有定义的SAML 2.0身份提供者列表。
SAML2IdPApi read25 GET /saml2sp/identityProviders/{key} 如果有匹配的entityID，则返回SAML 2.0身份提供者。
SAML2IdPApi update1 PUT /saml2sp/identityProviders/{key} 更新具有匹配entityID的SAML 2.0身份提供者。
SAML2SPApi createLoginRequest1 POST /saml2sp/serviceProvider/loginRequest 生成匹配提供的entityID的IdP的SAML 2.0身份验证请求。
SAML2SPApi createLogoutRequest1 POST /saml2sp/serviceProvider/logoutRequest 生成匹配请求访问令牌的IdP的SAML 2.0注销请求。
SAML2SPApi getMetadata GET /saml2sp/serviceProvider 返回提供的SAML 2.0服务提供者的XML元数据。
SAML2SPApi validateLoginResponse POST /saml2sp/serviceProvider/loginResponse 验证接收到的SAML 2.0身份验证响应，如果找到匹配的用户，则创建JWT。
SAML2SPApi validateLogoutResponse POST /saml2sp/serviceProvider/logoutResponse 验证接收到的SAML 2.0注销响应。
SCIMConfApi get1 GET /scimv2conf 读取SCIM配置，如果不存在，则生成空配置。
SCIMConfApi 设置 PUT /scimv2conf 设置SCIM配置。
SchemasApi createSchema POST /schemas/{type} 创建一个新的模式。
SchemasApi deleteSchema DELETE /schemas/{type}/{key} 删除匹配给定类型和键的模式。
SchemasApi readSchema GET /schemas/{type}/{key} 返回匹配给定类型和键的模式。
SchemasApi searchSchema GET /schemas/{type} 返回匹配给定查询的模式列表。
SchemasApi updateSchema PUT /schemas/{type}/{key} 更新匹配给定类型和键的模式。
SecurityQuestionsApi create1 POST /securityQuestions 创建一个新的安全问题。
SecurityQuestionsApi delete1 DELETE /securityQuestions/{key} 删除与提供的键匹配的安全问题。
SecurityQuestionsApi list26 GET /securityQuestions 返回所有安全问题的列表。
SecurityQuestionsApi read27 GET /securityQuestions/{key} 返回匹配键的安全问题。
SecurityQuestionsApi readByUser GET /securityQuestions/byUser/{username} 请求为匹配给定用户名的用户配置的安全问题（如果有的话）。
SecurityQuestionsApi update1 PUT /securityQuestions/{key} 更新与提供的键匹配的安全问题。
SyncopeApi batch GET /batch 获取批量结果，如果有异步请求。
SyncopeApi batch1 POST /batch 请求批量执行。
SyncopeApi numbers GET /numbers 提供有关管理实体（用户、组、任何对象等）的一些数字。
SyncopeApi platform GET /platform 提供有关平台配置的信息摘要（工作流适配器、配置管理器、验证器、操作、关联规则、报告等）。
SyncopeApi readUserTypeExtension GET /userTypeExtension/{groupName} 提取提供组的用户类型扩展信息。
SyncopeApi searchAssignableGroups POST /assignableGroups/{realm} 返回根据提供的分页指令，可分配给提供域的用户和任何对象的组列表。
SyncopeApi system GET /system 提供有关底层系统（操作系统、CPU /内存使用情况等）的信息。
TasksApi actionJob POST /tasks/jobs/{key} 对现有可执行作业执行操作。
TasksApi create1 POST /tasks/{type} 创建一个新的任务。
TasksApi delete1 DELETE /tasks/{type}/{key} 删除与提供的键匹配的任务。
TasksApi deleteExecution1 DELETE /tasks/executions/{executionKey} 删除匹配提供的密钥的可执行执行。
TasksApi deleteExecutions 删除 /tasks/{key}/executions 删除匹配给定查询的执行。
TasksApi execute1 POST /tasks/{key}/execute 执行匹配给定查询的可执行操作。
TasksApi getJob2 GET /tasks/jobs/{key} 返回与给定键匹配的可执行作业（运行或计划中的）。
TasksApi listExecutions1 GET /tasks/{key}/executions 返回与给定查询匹配的执行的分页列表。
TasksApi listJobs1 GET /tasks/jobs 列出作业（运行和/或计划中）。
TasksApi listRecentExecutions1 GET /tasks/executions/recent 返回最近完成的执行列表，按结束日期降序排列。
TasksApi read28 GET /tasks/{type}/{key} 返回与给定键匹配的任务。
TasksApi search3 GET /tasks/{type} 返回与给定查询匹配的现有任务分页列表。
TasksApi update1 PUT /tasks/{type}/{key} 更新与提供的键匹配的任务。
UserSelfApi confirmPasswordReset POST /users/self/confirmPasswordReset 如果提供的令牌可用且仍然有效，则重置与提供的令牌匹配的用户密码值。如果令牌实际上匹配用户之一，并且在提交时仍然有效，则将匹配用户的密码值设置为提供的内容。新密码值无论如何都需要遵守所有相关密码策略。
UserSelfApi create1 POST /users/self 新用户的自注册。
UserSelfApi delete1 DELETE /users/self 自行删除用户。
UserSelfApi mustChangePassword POST /users/self/mustChangePassword 在管理员强制更改的情况下更改自己的密码。
UserSelfApi read29 GET /users/self 返回执行服务调用的用户。
UserSelfApi requestPasswordReset POST /users/self/requestPasswordReset 如果提供了与用户匹配的安全问题的配置答案，则提供答案。如果提供的答案与存储在该用户的答案匹配，则内部生成密码重置令牌，否则返回错误。
UserSelfApi status1 POST /users/self/{key}/status 自行执行状态更新。
UserSelfApi update1 PUT /users/self/{key} 自行更新用户。
UserSelfApi update2 PATCH /users/self/{key} 自行更新用户。
UserWorkflowApi claimForm POST /userworkflow/forms/{taskId}/claim 为给定的任务ID认领表单。
UserWorkflowApi executeTask POST /userworkflow/tasks/{taskId}/execute 执行与匹配ID对应的流程任务。
UserWorkflowApi getAvailableTasks GET /userworkflow/tasks/{userKey} 返回给定用户键的可用任务列表。
UserWorkflowApi getFormForUser GET /userworkflow/forms/{userKey} 返回给定用户键的可用表单列表。
UserWorkflowApi getForms GET /userworkflow/forms 返回所有可用工作流程表单的列表。
UserWorkflowApi submitForm POST /userworkflow/forms 提交工作流程表单。
UsersApi associateUser POST /users/{key}/associate/{action} 在指定的实体上执行资源相关操作。
UsersApi createUser POST /users 创建新用户。
UsersApi deassociateUser POST /users/{key}/deassociate/{action} 在指定的实体上执行资源相关操作。
UsersApi deleteUser DELETE /users/{key} 删除与提供的键匹配的任意对象。
UsersApi deleteUserAttribute DELETE /users/{key}/{schemaType}/{schema} 删除给定模式类型和模式下属于指定任意对象的属性。
UsersApi readUser GET /users/{key} 读取与提供的键匹配的任意对象。
UsersApi readUserAttribute GET /users/{key}/{schemaType}/{schema} 读取给定模式类型和模式下属于指定任意对象的属性。注意，对于UserService、GroupService和AnyObjectService子类，如果key参数看起来像是一个UUID，则解释为键，否则解释为（用户）名称。
UsersApi readUserAttributes GET /users/{key}/{schemaType} 读取给定模式类型下属于指定任意对象的所有属性的列表。注意，对于UserService、GroupService和AnyObjectService子类，如果key参数看起来像是一个UUID，则解释为键，否则解释为（用户）名称。
UsersApi searchUser GET /users 返回与给定查询匹配的任意对象的分页列表。
UsersApi statusUpdate POST /users/{key}/status 对指定的用户执行状态更新。
UsersApi updateUser PUT /users/{key} 更新与提供的键匹配的用户。
UsersApi updateUserAttribute PUT /users/{key}/{schemaType}/{schema} 为给定的模式类型和模式添加或替换属于指定任意对象的属性。
UsersApi updateUser_0 PATCH /users/{key} 更新与提供的键匹配的用户。
WorkflowApi delete1 DELETE /workflows/{anyType}/{key} 根据提供的键删除与任何对象类型匹配的流程定义。
WorkflowApi exportDiagram GET /workflows/{anyType}/{key}/diagram.png 导出与任何对象类型和键匹配的流程图表示（如果可用）。
WorkflowApi get2 GET /workflows/{anyType}/{key} 导出与任何对象类型和键匹配的流程定义。
WorkflowApi list27 GET /workflows/{anyType} 列出给定任何对象类型的可用工作流定义。
WorkflowApi 设置 PUT /workflows/{anyType}/{key} 导入与提供的键匹配的任何对象类型的工作流定义。

模型文档

授权文档

基本认证

  • 类型：HTTP基本认证

Bearer

  • 类型：HTTP基本认证