登录 注册
开源 企业版 高校版 私有云 模力方舟 模力方舟
开源项目 > 程序开发 > 网络开发包 &&
扫描微信二维码支付
取消
支付完成
Watch
不关注 关注所有动态 仅关注版本发行动态 关注但不提醒动态
1 Star 6 Fork 3

SDK For Gitee/gitee5j

代码 Issues 1 Pull Requests 0 Wiki 统计 流水线
服务
加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目，私有仓库也完全免费 ：）
免费加入
文件
克隆/下载
OrganizationsApi.md 24.29 KB
一键复制 编辑 原始数据 按行查看 历史
likui 提交于 1年前 . 新增、修改若干接口，调整部分类型

OrganizationsApi

All URIs are relative to https://gitee.com/api/v5

Method HTTP request Description
deleteOrgsOrgMembershipsUsername DELETE /orgs/{org}/memberships/{username} 移除授权用户所管理组织中的成员
deleteUserMembershipsOrgsOrg DELETE /user/memberships/orgs/{org} 退出一个组织
getOrgsOrg GET /orgs/{org} 获取一个组织
getOrgsOrgFollowers GET /orgs/{org}/followers 列出指定组织的所有关注者
getOrgsOrgMembers GET /orgs/{org}/members 列出一个组织的所有成员
getOrgsOrgMembershipsUsername GET /orgs/{org}/memberships/{username} 获取授权用户所属组织的一个成员
getUserMembershipsOrgs GET /user/memberships/orgs 列出授权用户在所属组织的成员资料
getUserMembershipsOrgsOrg GET /user/memberships/orgs/{org} 获取授权用户在一个组织的成员资料
getUserOrgs GET /user/orgs 列出授权用户所属的组织
getUsersUsernameOrgs GET /users/{username}/orgs 列出用户所属的组织
patchOrgsOrg PATCH /orgs/{org} 更新授权用户所管理的组织资料
patchUserMembershipsOrgsOrg PATCH /user/memberships/orgs/{org} 更新授权用户在一个组织的成员资料
postUsersOrganization POST /users/organization 创建组织
putOrgsOrgMembershipsUsername PUT /orgs/{org}/memberships/{username} 增加或更新授权用户所管理组织的成员

deleteOrgsOrgMembershipsUsername

deleteOrgsOrgMembershipsUsername(org, username)

移除授权用户所管理组织中的成员

移除授权用户所管理组织中的成员

Example

// Import classes:
//import com.gitee.sdk.gitee5j.ApiClient;
//import com.gitee.sdk.gitee5j.ApiException;
//import com.gitee.sdk.gitee5j.Configuration;
//import com.gitee.sdk.gitee5j.auth.*;
//import com.gitee.sdk.gitee5j.api.OrganizationsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: OAuth2
OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
OAuth2.setAccessToken("YOUR ACCESS TOKEN");

OrganizationsApi apiInstance = new OrganizationsApi();
String org = "org_example"; // String | 组织的路径(path/login)
String username = "username_example"; // String | 用户名(username/login)
try {
    apiInstance.deleteOrgsOrgMembershipsUsername(org, username);
} catch (ApiException e) {
    System.err.println("Exception when calling OrganizationsApi#deleteOrgsOrgMembershipsUsername");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
org String 组织的路径(path/login)
username String 用户名(username/login)

Return type

null (empty response body)

Authorization

OAuth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

deleteUserMembershipsOrgsOrg

deleteUserMembershipsOrgsOrg(org)

退出一个组织

退出一个组织

Example

// Import classes:
//import com.gitee.sdk.gitee5j.ApiClient;
//import com.gitee.sdk.gitee5j.ApiException;
//import com.gitee.sdk.gitee5j.Configuration;
//import com.gitee.sdk.gitee5j.auth.*;
//import com.gitee.sdk.gitee5j.api.OrganizationsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: OAuth2
OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
OAuth2.setAccessToken("YOUR ACCESS TOKEN");

OrganizationsApi apiInstance = new OrganizationsApi();
String org = "org_example"; // String | 组织的路径(path/login)
try {
    apiInstance.deleteUserMembershipsOrgsOrg(org);
} catch (ApiException e) {
    System.err.println("Exception when calling OrganizationsApi#deleteUserMembershipsOrgsOrg");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
org String 组织的路径(path/login)

Return type

null (empty response body)

Authorization

OAuth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

getOrgsOrg

GroupDetail getOrgsOrg(org)

获取一个组织

获取一个组织

Example

// Import classes:
//import com.gitee.sdk.gitee5j.ApiClient;
//import com.gitee.sdk.gitee5j.ApiException;
//import com.gitee.sdk.gitee5j.Configuration;
//import com.gitee.sdk.gitee5j.auth.*;
//import com.gitee.sdk.gitee5j.api.OrganizationsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: OAuth2
OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
OAuth2.setAccessToken("YOUR ACCESS TOKEN");

OrganizationsApi apiInstance = new OrganizationsApi();
String org = "org_example"; // String | 组织的路径(path/login)
try {
    GroupDetail result = apiInstance.getOrgsOrg(org);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling OrganizationsApi#getOrgsOrg");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
org String 组织的路径(path/login)

Return type

GroupDetail

Authorization

OAuth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

getOrgsOrgFollowers

List<GroupFollowers> getOrgsOrgFollowers(org, page, perPage)

列出指定组织的所有关注者

列出指定组织的所有关注者

Example

// Import classes:
//import com.gitee.sdk.gitee5j.ApiClient;
//import com.gitee.sdk.gitee5j.ApiException;
//import com.gitee.sdk.gitee5j.Configuration;
//import com.gitee.sdk.gitee5j.auth.*;
//import com.gitee.sdk.gitee5j.api.OrganizationsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: OAuth2
OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
OAuth2.setAccessToken("YOUR ACCESS TOKEN");

OrganizationsApi apiInstance = new OrganizationsApi();
String org = "org_example"; // String | 组织的路径(path/login)
Integer page = 1; // Integer | 当前的页码
Integer perPage = 20; // Integer | 每页的数量，最大为 100
try {
    List<GroupFollowers> result = apiInstance.getOrgsOrgFollowers(org, page, perPage);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling OrganizationsApi#getOrgsOrgFollowers");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
org String 组织的路径(path/login)
page Integer 当前的页码 [optional] [default to 1]
perPage Integer 每页的数量，最大为 100 [optional] [default to 20] [enum: 1, 100]

Return type

List<GroupFollowers>

Authorization

OAuth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

getOrgsOrgMembers

List<UserBasic> getOrgsOrgMembers(org, page, perPage, role)

列出一个组织的所有成员

列出一个组织的所有成员

Example

// Import classes:
//import com.gitee.sdk.gitee5j.ApiClient;
//import com.gitee.sdk.gitee5j.ApiException;
//import com.gitee.sdk.gitee5j.Configuration;
//import com.gitee.sdk.gitee5j.auth.*;
//import com.gitee.sdk.gitee5j.api.OrganizationsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: OAuth2
OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
OAuth2.setAccessToken("YOUR ACCESS TOKEN");

OrganizationsApi apiInstance = new OrganizationsApi();
String org = "org_example"; // String | 组织的路径(path/login)
Integer page = 1; // Integer | 当前的页码
Integer perPage = 20; // Integer | 每页的数量，最大为 100
String role = "all"; // String | 根据角色筛选成员
try {
    List<UserBasic> result = apiInstance.getOrgsOrgMembers(org, page, perPage, role);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling OrganizationsApi#getOrgsOrgMembers");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
org String 组织的路径(path/login)
page Integer 当前的页码 [optional] [default to 1]
perPage Integer 每页的数量，最大为 100 [optional] [default to 20] [enum: 1, 100]
role String 根据角色筛选成员 [optional] [default to all] [enum: all, admin, member]

Return type

List<UserBasic>

Authorization

OAuth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

getOrgsOrgMembershipsUsername

GroupMember getOrgsOrgMembershipsUsername(org, username)

获取授权用户所属组织的一个成员

获取授权用户所属组织的一个成员

Example

// Import classes:
//import com.gitee.sdk.gitee5j.ApiClient;
//import com.gitee.sdk.gitee5j.ApiException;
//import com.gitee.sdk.gitee5j.Configuration;
//import com.gitee.sdk.gitee5j.auth.*;
//import com.gitee.sdk.gitee5j.api.OrganizationsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: OAuth2
OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
OAuth2.setAccessToken("YOUR ACCESS TOKEN");

OrganizationsApi apiInstance = new OrganizationsApi();
String org = "org_example"; // String | 组织的路径(path/login)
String username = "username_example"; // String | 用户名(username/login)
try {
    GroupMember result = apiInstance.getOrgsOrgMembershipsUsername(org, username);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling OrganizationsApi#getOrgsOrgMembershipsUsername");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
org String 组织的路径(path/login)
username String 用户名(username/login)

Return type

GroupMember

Authorization

OAuth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

getUserMembershipsOrgs

List<GroupMember> getUserMembershipsOrgs(active, page, perPage)

列出授权用户在所属组织的成员资料

列出授权用户在所属组织的成员资料

Example

// Import classes:
//import com.gitee.sdk.gitee5j.ApiClient;
//import com.gitee.sdk.gitee5j.ApiException;
//import com.gitee.sdk.gitee5j.Configuration;
//import com.gitee.sdk.gitee5j.auth.*;
//import com.gitee.sdk.gitee5j.api.OrganizationsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: OAuth2
OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
OAuth2.setAccessToken("YOUR ACCESS TOKEN");

OrganizationsApi apiInstance = new OrganizationsApi();
Boolean active = true; // Boolean | 根据成员是否已激活进行筛选资料，缺省返回所有资料
Integer page = 1; // Integer | 当前的页码
Integer perPage = 20; // Integer | 每页的数量，最大为 100
try {
    List<GroupMember> result = apiInstance.getUserMembershipsOrgs(active, page, perPage);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling OrganizationsApi#getUserMembershipsOrgs");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
active Boolean 根据成员是否已激活进行筛选资料，缺省返回所有资料 [optional]
page Integer 当前的页码 [optional] [default to 1]
perPage Integer 每页的数量，最大为 100 [optional] [default to 20] [enum: 1, 100]

Return type

List<GroupMember>

Authorization

OAuth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

getUserMembershipsOrgsOrg

GroupMember getUserMembershipsOrgsOrg(org)

获取授权用户在一个组织的成员资料

获取授权用户在一个组织的成员资料

Example

// Import classes:
//import com.gitee.sdk.gitee5j.ApiClient;
//import com.gitee.sdk.gitee5j.ApiException;
//import com.gitee.sdk.gitee5j.Configuration;
//import com.gitee.sdk.gitee5j.auth.*;
//import com.gitee.sdk.gitee5j.api.OrganizationsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: OAuth2
OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
OAuth2.setAccessToken("YOUR ACCESS TOKEN");

OrganizationsApi apiInstance = new OrganizationsApi();
String org = "org_example"; // String | 组织的路径(path/login)
try {
    GroupMember result = apiInstance.getUserMembershipsOrgsOrg(org);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling OrganizationsApi#getUserMembershipsOrgsOrg");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
org String 组织的路径(path/login)

Return type

GroupMember

Authorization

OAuth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

getUserOrgs

List<Group> getUserOrgs(page, perPage, admin)

列出授权用户所属的组织

列出授权用户所属的组织

Example

// Import classes:
//import com.gitee.sdk.gitee5j.ApiClient;
//import com.gitee.sdk.gitee5j.ApiException;
//import com.gitee.sdk.gitee5j.Configuration;
//import com.gitee.sdk.gitee5j.auth.*;
//import com.gitee.sdk.gitee5j.api.OrganizationsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: OAuth2
OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
OAuth2.setAccessToken("YOUR ACCESS TOKEN");

OrganizationsApi apiInstance = new OrganizationsApi();
Integer page = 1; // Integer | 当前的页码
Integer perPage = 20; // Integer | 每页的数量，最大为 100
Boolean admin = true; // Boolean | 只列出授权用户管理的组织
try {
    List<Group> result = apiInstance.getUserOrgs(page, perPage, admin);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling OrganizationsApi#getUserOrgs");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
page Integer 当前的页码 [optional] [default to 1]
perPage Integer 每页的数量，最大为 100 [optional] [default to 20] [enum: 1, 100]
admin Boolean 只列出授权用户管理的组织 [optional]

Return type

List<Group>

Authorization

OAuth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

getUsersUsernameOrgs

List<Group> getUsersUsernameOrgs(username, page, perPage)

列出用户所属的组织

列出用户所属的组织

Example

// Import classes:
//import com.gitee.sdk.gitee5j.ApiClient;
//import com.gitee.sdk.gitee5j.ApiException;
//import com.gitee.sdk.gitee5j.Configuration;
//import com.gitee.sdk.gitee5j.auth.*;
//import com.gitee.sdk.gitee5j.api.OrganizationsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: OAuth2
OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
OAuth2.setAccessToken("YOUR ACCESS TOKEN");

OrganizationsApi apiInstance = new OrganizationsApi();
String username = "username_example"; // String | 用户名(username/login)
Integer page = 1; // Integer | 当前的页码
Integer perPage = 20; // Integer | 每页的数量，最大为 100
try {
    List<Group> result = apiInstance.getUsersUsernameOrgs(username, page, perPage);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling OrganizationsApi#getUsersUsernameOrgs");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
username String 用户名(username/login)
page Integer 当前的页码 [optional] [default to 1]
perPage Integer 每页的数量，最大为 100 [optional] [default to 20] [enum: 1, 100]

Return type

List<Group>

Authorization

OAuth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

patchOrgsOrg

GroupDetail patchOrgsOrg(org, body)

更新授权用户所管理的组织资料

更新授权用户所管理的组织资料

Example

// Import classes:
//import com.gitee.sdk.gitee5j.ApiClient;
//import com.gitee.sdk.gitee5j.ApiException;
//import com.gitee.sdk.gitee5j.Configuration;
//import com.gitee.sdk.gitee5j.auth.*;
//import com.gitee.sdk.gitee5j.api.OrganizationsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: OAuth2
OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
OAuth2.setAccessToken("YOUR ACCESS TOKEN");

OrganizationsApi apiInstance = new OrganizationsApi();
String org = "org_example"; // String | 组织的路径(path/login)
OrgsOrgBody body = new OrgsOrgBody(); // OrgsOrgBody | 
try {
    GroupDetail result = apiInstance.patchOrgsOrg(org, body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling OrganizationsApi#patchOrgsOrg");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
org String 组织的路径(path/login)
body OrgsOrgBody [optional]

Return type

GroupDetail

Authorization

OAuth2

HTTP request headers

  • Content-Type: /
  • Accept: application/json

patchUserMembershipsOrgsOrg

GroupMember patchUserMembershipsOrgsOrg(org, body)

更新授权用户在一个组织的成员资料

更新授权用户在一个组织的成员资料

Example

// Import classes:
//import com.gitee.sdk.gitee5j.ApiClient;
//import com.gitee.sdk.gitee5j.ApiException;
//import com.gitee.sdk.gitee5j.Configuration;
//import com.gitee.sdk.gitee5j.auth.*;
//import com.gitee.sdk.gitee5j.api.OrganizationsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: OAuth2
OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
OAuth2.setAccessToken("YOUR ACCESS TOKEN");

OrganizationsApi apiInstance = new OrganizationsApi();
String org = "org_example"; // String | 组织的路径(path/login)
OrgsOrgBody1 body = new OrgsOrgBody1(); // OrgsOrgBody1 | 
try {
    GroupMember result = apiInstance.patchUserMembershipsOrgsOrg(org, body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling OrganizationsApi#patchUserMembershipsOrgsOrg");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
org String 组织的路径(path/login)
body OrgsOrgBody1 [optional]

Return type

GroupMember

Authorization

OAuth2

HTTP request headers

  • Content-Type: /
  • Accept: application/json

postUsersOrganization

Group postUsersOrganization(body)

创建组织

创建组织

Example

// Import classes:
//import com.gitee.sdk.gitee5j.ApiClient;
//import com.gitee.sdk.gitee5j.ApiException;
//import com.gitee.sdk.gitee5j.Configuration;
//import com.gitee.sdk.gitee5j.auth.*;
//import com.gitee.sdk.gitee5j.api.OrganizationsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: OAuth2
OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
OAuth2.setAccessToken("YOUR ACCESS TOKEN");

OrganizationsApi apiInstance = new OrganizationsApi();
UsersOrganizationBody body = new UsersOrganizationBody(); // UsersOrganizationBody | 
try {
    Group result = apiInstance.postUsersOrganization(body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling OrganizationsApi#postUsersOrganization");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
body UsersOrganizationBody [optional]

Return type

Group

Authorization

OAuth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

putOrgsOrgMembershipsUsername

GroupMember putOrgsOrgMembershipsUsername(org, username, body)

增加或更新授权用户所管理组织的成员

增加或更新授权用户所管理组织的成员

Example

// Import classes:
//import com.gitee.sdk.gitee5j.ApiClient;
//import com.gitee.sdk.gitee5j.ApiException;
//import com.gitee.sdk.gitee5j.Configuration;
//import com.gitee.sdk.gitee5j.auth.*;
//import com.gitee.sdk.gitee5j.api.OrganizationsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: OAuth2
OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
OAuth2.setAccessToken("YOUR ACCESS TOKEN");

OrganizationsApi apiInstance = new OrganizationsApi();
String org = "org_example"; // String | 组织的路径(path/login)
String username = "username_example"; // String | 用户名(username/login)
MembershipsUsernameBody body = new MembershipsUsernameBody(); // MembershipsUsernameBody | 
try {
    GroupMember result = apiInstance.putOrgsOrgMembershipsUsername(org, username, body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling OrganizationsApi#putOrgsOrgMembershipsUsername");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
org String 组织的路径(path/login)
username String 用户名(username/login)
body MembershipsUsernameBody [optional]

Return type

GroupMember

Authorization

OAuth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json
Loading...
马建仓 AI 助手
尝试更多
代码解读
代码找茬
代码优化
Java
1
https://gitee.com/sdk/gitee5j.git
git@gitee.com:sdk/gitee5j.git
sdk
gitee5j
gitee5j
main
点此查找更多帮助

搜索帮助

Git 命令在线学习 如何在 Gitee 导入 GitHub 仓库
Git 仓库基础操作
企业版和社区版功能对比
SSH 公钥设置
如何处理代码冲突
仓库体积过大，如何减小？
如何找回被删除的仓库数据
Gitee 产品配额说明
GitHub仓库快速导入Gitee及同步更新
什么是 Release（发行版）
将 PHP 项目自动发布到 packagist.org
评论
仓库举报
回到顶部