¶ 管理应用
更新时间: 2024-10-10 07:28:40
managementClient.Applications.Create(string name, string identifier, string redirectUris, string logo = null)
复制成功
在用户池中创建一个应用
¶ 参数
name
<string> 应用名称identifier
<string> 应用认证地址redirectUris
<List<string>> 应用回调链接logo
<string> 应用 logo,可选参数。
¶ 示例
managementClient.Applications.Create("APP_NAME", "Identifier","www.xxxxx.com");
复制成功
¶ 删除应用
managementClient.Applications.Delete(string appId)
复制成功
在用户池中删除一个应用
¶ 参数
appId
<string> 应用 ID
¶ 示例
managementClient.Applications.Delete("APP_ID");
复制成功
¶ 获取应用列表
managementClient.Applications.List(int page = 1, int limit = 10)
复制成功
获取应用列表相关信息
¶ 参数
page
<int> 分页序号,默认为 1。limit
<int> 每页返回的个数,默认为 10。
¶ 示例
managementClient.Applications.list(1, 10);
复制成功
¶ 获取应用详情
获取应用详情信息
managementClient.Applications.FindById(string id)
复制成功
¶ 参数
id
<string> 应用 id
¶ 示例
managementClient.Applications.findById("APP_ID");
复制成功
¶ 获取资源列表
managementClient.Applications.ListResource(string appId, ListResourceOption listResourceOption = nul)
复制成功
获取所有资源。
¶ 参数
params
<ListResourceOption>params.AppId
<string> 应用 IDparams.Type
<string> 资源类型,可选值为DATA
、API
、MENU
、UI
、BUTTON
。params.Page
<string> 分页,获取第几页,默认从 1 开始。params.Limit
<string> 每页条目数量,默认为 10 个。
¶ 示例
managementClient.Applications.listResources("APP_ID");
复制成功
¶ 创建资源
managementClient.Applications.CreateResource(string appId, CreateResourceParam createResourceParam)
复制成功
创建一个资源。
¶ 参数
appId
<string> 应用 IDparam
<CreateResourceParam> 资源信息对象param.Code
<string> 资源标识符param.Type
<ResourceType> 枚举 资源类型,可选值为DATA
、API
、MENU
、UI
、BUTTON
。param.Actions
<List<IAction>> 资源操作对象数组。其中 name 为操作名称,填写一个动词,description 为操作描述,填写描述信息。IAction
:name
<string> 操作名称,description
<string> 描述信息。
param.Description
<string> 资源描述信息
¶ 示例
managementClient.Applications.CreateResource("APP_ID");
复制成功
¶ 更新资源
managementClient.Applications.UpdateResource(string appId, string code, UpdateResourceParam updateResourceParam)
复制成功
更新一个资源。
¶ 参数
appId
<string> 应用 IDparam
<ResourceOptionsParams> 资源信息对象code
<string> 资源标识符param.NameSpace
<string> 资源所在的权限分组标识param.Type
<string> 资源类型,可选值为DATA
、API
、MENU
、UI
、BUTTON
。param.Actions
<List<IAction>> 资源操作对象数组。其中 name 为操作名称,填写一个动词,description 为操作描述,填写描述信息。IAction
:name
<string> 操作名称description
<string> 描述信息
param.description
<string> 资源描述信息
¶ 删除资源
managementClient.Applications.DeleteResource(string appId, string code)
复制成功
删除一个资源。
¶ 参数
appId
<string> 应用 IDcode
<string> 资源标识符
¶ 示例
managementClient .Applications.DeleteResource("APP_ID", "CODE");
复制成功
¶ 获取应用访问控制策略
managementClient.UpdateDefaultAccessPolicy(string appId, UpdateDefaultApplicationAccessPolicyParam updateDefaultApplicationAccessPolicyParam)
复制成功
¶ 参数
appId
<string> 应用 IDoption
<updateDefaultApplicationAccessPolicyParam>option.DefaultStrategy
<DefaultStrategyEnum>
¶ 示例
managementClient .Applications.UpdateDefaultAccessPolicy("APP_ID");
复制成功
¶ 创建角色
managementClient.CreateRole( string appId, string code, string description = nul)
复制成功
¶ 参数
appId
<string> 应用 IDcode
<string> stringdescription
<string> 描述
¶ 示例
managementClient.CreateRole("appId","code", "description");
复制成功
¶ 删除角色
managementClient.DeleteRole(string appId, string code)
复制成功
¶ 参数
appId
<string> 应用 IDcode
<string> string
¶ 示例
managementClient.DeleteRole("appId");
复制成功
¶ 批量删除角色
managementClient.DeleteRoles( string appId, IEnumerable<string> codeList)
复制成功
¶ 参数
appId
<string> 应用 IDcodeList
<List<string>> 角色唯一标志符列表
¶ 示例
managementClient.DeleteRole("appId");
复制成功
¶ 修改角色
managementClient.UpdateRole( string appId, UpdateRoleOptions option)
复制成功
¶ 参数
appId
<string> 应用 IDoption
<UpdateRoleOptions> 参数option.Code
<string> 角色唯一标志符option.Description
<string> 描述option.NewCode
<string> 新的角色唯一标志符option.NameSpace
<string>
¶ 示例
managementClient.UpdateRole("appId");
复制成功
¶ 修改角色
managementClient.FindRole( string appId, string code)
复制成功
已过时不建议使用
¶ 参数
appId
<string> 应用 IDcode
<string> 角色唯一标志符
¶ 示例
managementClient.FindRole("appId","code");
复制成功
¶ 修改角色
managementClient.GetRoles(string appId, int page = 1, int limit = 10)
复制成功
¶ 参数
appId
<string> 应用 IDpage
<int> 分页序号,默认为 1。limit
<int> 每页返回的个数,默认为 10。
¶ 示例
managementClient.GetRoles("appId",1,10);
复制成功
¶ 添加用户
managementClient.AddUsersToRole( string appId, string code, IEnumerable<string> userIds)
复制成功
¶ 参数
appId
<string> 应用 IDcode
<string> 角色唯一标志符userIds
<List<string>> 用户 ID 列表
¶ 示例
var list = new userIds(){} managementClient.AddUsersToRole("appId","code",list);
复制成功
¶ 移除用户
managementClient.RemoveUsersFromRole( string appId, string code, IEnumerable<string> userIds)
复制成功
¶ 参数
appId
<string> 应用 IDcode
<string> 角色唯一标志符userIds
<List<string>> 用户 ID 列表
¶ 示例
var list = new userIds(){} managementClient.RemoveUsersFromRole("appId","code",list);
复制成功
¶ 获取角色被授权的所有资源
managementClient.ListAuthorizedResourcesByRole( string appId, string code, ResourceType resourceType = default)
复制成功
¶ 参数
appId
<string> 应用 IDcode
<string> 角色唯一标志符resourceType
<ResourceType>> 资源类型
¶ 示例
managementClient.ListAuthorizedResourcesByRole("appId","code","DATA");
复制成功
¶ 创建注册协议
managementClient.createAgreement(string appId, AgreementInput option)
复制成功
¶ 参数
appId
<string> 应用 IDoption
<AgreementInput>option.Title
<string>option.Required
<bool>option.Lang
<LangEnum>
¶ 示例
var option = new AgreementInput(){} managementClient.createAgreement("appId",option);
复制成功
¶ 删除注册协议
managementClient.deleteAgreement(string appId, int agreementId)
复制成功
¶ 参数
appId
<string> 应用 IDagreementId
<int> 协议 ID
¶ 示例
managementClient.deleteAgreement("appId",100);
复制成功
¶ 修改注册协议
managementClient.modifyAgreement(string appId, int agreementId, AgreementInput agreement)
复制成功
¶ 参数
appId
<string> 应用 IDagreementId
<int> 协议 IDoption
<AgreementInput>option.Title
<string>option.Required
<bool>option.Lang
<LangEnum>
¶ 示例
var option = new AgreementInput(){} managementClient.deleteAgreement("appId",100,option);
复制成功
¶ 获取应用注册协议列表
managementClient.listAgreement(string appId, int agreementId, AgreementInput agreement)
复制成功
¶ 参数
appId
<string> 应用 IDagreementId
<int> 协议 IDoption
<AgreementInput>option.Title
<string>option.Required
<bool>option.Lang
<LangEnum>
¶ 示例
var option = new AgreementInput(){} managementClient.listAgreement("appId",100,option);
复制成功
¶ 对应用的注册协议排序
managementClient.sortAgreement(string appId, IEnumerable<int> order)
复制成功
¶ 参数
appId
<string> 应用 IDorder
<List<string>>应用下所有协议的 ID 列表,按需要的顺序排列
¶ 示例
var option = new list<int>(){} managementClient.listAgreement("appId",option);
复制成功
¶ 查看应用下已登录用户
managementClient.ActiveUsers(string appId, int page = 1, int limit = 10)
复制成功
¶ 参数
appId
<string> 应用 IDpage
<int> 分页序号,默认为 1。limit
<int> 每页返回的个数,默认为 10。
¶ 示例
managementClient.ActiveUsers( "appId", 1, 10 );
复制成功
¶ 刷新应用密钥
managementClient.RefreshApplicationSecret(string appId)
复制成功
¶ 参数
appId
<string> 应用 ID
¶ 示例
managementClient.RefreshApplicationSecret("appId")
复制成功
¶ 更改应用类型
managementClient.ChangeApplicationType(string appId, ApplicationType type)
复制成功
¶ 参数
appId
<string> 应用 IDtype
<ApplicationType> 应用 ID
¶ 示例
managementClient.ChangeApplicationType("appId","INDIVIDUAL")
复制成功
评价此篇文档
有帮助
无帮助
若你已对系统有基本了解,并且感兴趣的话,点击跳转 Authing
控制台,来开启你的 Authing 之旅!
进入 Authing