gitee.com/openeuler/go-gitee@v0.0.0-20220530104019-3af895bc380c/docs/OrganizationsApi.md (about)

     1  # \OrganizationsApi
     2  
     3  All URIs are relative to *https://gitee.com/api*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**DeleteV5OrgsOrgMembershipsUsername**](OrganizationsApi.md#DeleteV5OrgsOrgMembershipsUsername) | **Delete** /v5/orgs/{org}/memberships/{username} | 移除授权用户所管理组织中的成员
     8  [**DeleteV5UserMembershipsOrgsOrg**](OrganizationsApi.md#DeleteV5UserMembershipsOrgsOrg) | **Delete** /v5/user/memberships/orgs/{org} | 退出一个组织
     9  [**GetV5OrgsOrg**](OrganizationsApi.md#GetV5OrgsOrg) | **Get** /v5/orgs/{org} | 获取一个组织
    10  [**GetV5OrgsOrgMembers**](OrganizationsApi.md#GetV5OrgsOrgMembers) | **Get** /v5/orgs/{org}/members | 列出一个组织的所有成员
    11  [**GetV5OrgsOrgMembershipsUsername**](OrganizationsApi.md#GetV5OrgsOrgMembershipsUsername) | **Get** /v5/orgs/{org}/memberships/{username} | 获取授权用户所属组织的一个成员
    12  [**GetV5UserMembershipsOrgs**](OrganizationsApi.md#GetV5UserMembershipsOrgs) | **Get** /v5/user/memberships/orgs | 列出授权用户在所属组织的成员资料
    13  [**GetV5UserMembershipsOrgsOrg**](OrganizationsApi.md#GetV5UserMembershipsOrgsOrg) | **Get** /v5/user/memberships/orgs/{org} | 获取授权用户在一个组织的成员资料
    14  [**GetV5UserOrgs**](OrganizationsApi.md#GetV5UserOrgs) | **Get** /v5/user/orgs | 列出授权用户所属的组织
    15  [**GetV5UsersUsernameOrgs**](OrganizationsApi.md#GetV5UsersUsernameOrgs) | **Get** /v5/users/{username}/orgs | 列出用户所属的组织
    16  [**PatchV5OrgsOrg**](OrganizationsApi.md#PatchV5OrgsOrg) | **Patch** /v5/orgs/{org} | 更新授权用户所管理的组织资料
    17  [**PatchV5UserMembershipsOrgsOrg**](OrganizationsApi.md#PatchV5UserMembershipsOrgsOrg) | **Patch** /v5/user/memberships/orgs/{org} | 更新授权用户在一个组织的成员资料
    18  [**PostV5UsersOrganization**](OrganizationsApi.md#PostV5UsersOrganization) | **Post** /v5/users/organization | 创建组织
    19  [**PutV5OrgsOrgMembershipsUsername**](OrganizationsApi.md#PutV5OrgsOrgMembershipsUsername) | **Put** /v5/orgs/{org}/memberships/{username} | 增加或更新授权用户所管理组织的成员
    20  
    21  
    22  # **DeleteV5OrgsOrgMembershipsUsername**
    23  > DeleteV5OrgsOrgMembershipsUsername(ctx, org, username, optional)
    24  移除授权用户所管理组织中的成员
    25  
    26  移除授权用户所管理组织中的成员
    27  
    28  ### Required Parameters
    29  
    30  Name | Type | Description  | Notes
    31  ------------- | ------------- | ------------- | -------------
    32   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    33    **org** | **string**| 组织的路径(path/login) | 
    34    **username** | **string**| 用户名(username/login) | 
    35   **optional** | ***DeleteV5OrgsOrgMembershipsUsernameOpts** | optional parameters | nil if no parameters
    36  
    37  ### Optional Parameters
    38  Optional parameters are passed through a pointer to a DeleteV5OrgsOrgMembershipsUsernameOpts struct
    39  
    40  Name | Type | Description  | Notes
    41  ------------- | ------------- | ------------- | -------------
    42  
    43  
    44   **accessToken** | **optional.String**| 用户授权码 | 
    45  
    46  ### Return type
    47  
    48   (empty response body)
    49  
    50  ### Authorization
    51  
    52  No authorization required
    53  
    54  ### HTTP request headers
    55  
    56   - **Content-Type**: application/json, multipart/form-data
    57   - **Accept**: application/json
    58  
    59  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
    60  
    61  # **DeleteV5UserMembershipsOrgsOrg**
    62  > DeleteV5UserMembershipsOrgsOrg(ctx, org, optional)
    63  退出一个组织
    64  
    65  退出一个组织
    66  
    67  ### Required Parameters
    68  
    69  Name | Type | Description  | Notes
    70  ------------- | ------------- | ------------- | -------------
    71   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    72    **org** | **string**| 组织的路径(path/login) | 
    73   **optional** | ***DeleteV5UserMembershipsOrgsOrgOpts** | optional parameters | nil if no parameters
    74  
    75  ### Optional Parameters
    76  Optional parameters are passed through a pointer to a DeleteV5UserMembershipsOrgsOrgOpts struct
    77  
    78  Name | Type | Description  | Notes
    79  ------------- | ------------- | ------------- | -------------
    80  
    81   **accessToken** | **optional.String**| 用户授权码 | 
    82  
    83  ### Return type
    84  
    85   (empty response body)
    86  
    87  ### Authorization
    88  
    89  No authorization required
    90  
    91  ### HTTP request headers
    92  
    93   - **Content-Type**: application/json, multipart/form-data
    94   - **Accept**: application/json
    95  
    96  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
    97  
    98  # **GetV5OrgsOrg**
    99  > Group GetV5OrgsOrg(ctx, org, optional)
   100  获取一个组织
   101  
   102  获取一个组织
   103  
   104  ### Required Parameters
   105  
   106  Name | Type | Description  | Notes
   107  ------------- | ------------- | ------------- | -------------
   108   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   109    **org** | **string**| 组织的路径(path/login) | 
   110   **optional** | ***GetV5OrgsOrgOpts** | optional parameters | nil if no parameters
   111  
   112  ### Optional Parameters
   113  Optional parameters are passed through a pointer to a GetV5OrgsOrgOpts struct
   114  
   115  Name | Type | Description  | Notes
   116  ------------- | ------------- | ------------- | -------------
   117  
   118   **accessToken** | **optional.String**| 用户授权码 | 
   119  
   120  ### Return type
   121  
   122  [**Group**](Group.md)
   123  
   124  ### Authorization
   125  
   126  No authorization required
   127  
   128  ### HTTP request headers
   129  
   130   - **Content-Type**: application/json, multipart/form-data
   131   - **Accept**: application/json
   132  
   133  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
   134  
   135  # **GetV5OrgsOrgMembers**
   136  > []UserBasic GetV5OrgsOrgMembers(ctx, org, optional)
   137  列出一个组织的所有成员
   138  
   139  列出一个组织的所有成员
   140  
   141  ### Required Parameters
   142  
   143  Name | Type | Description  | Notes
   144  ------------- | ------------- | ------------- | -------------
   145   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   146    **org** | **string**| 组织的路径(path/login) | 
   147   **optional** | ***GetV5OrgsOrgMembersOpts** | optional parameters | nil if no parameters
   148  
   149  ### Optional Parameters
   150  Optional parameters are passed through a pointer to a GetV5OrgsOrgMembersOpts struct
   151  
   152  Name | Type | Description  | Notes
   153  ------------- | ------------- | ------------- | -------------
   154  
   155   **accessToken** | **optional.String**| 用户授权码 | 
   156   **page** | **optional.Int32**| 当前的页码 | [default to 1]
   157   **perPage** | **optional.Int32**| 每页的数量,最大为 100 | [default to 20]
   158   **role** | **optional.String**| 根据角色筛选成员 | [default to all]
   159  
   160  ### Return type
   161  
   162  [**[]UserBasic**](UserBasic.md)
   163  
   164  ### Authorization
   165  
   166  No authorization required
   167  
   168  ### HTTP request headers
   169  
   170   - **Content-Type**: application/json, multipart/form-data
   171   - **Accept**: application/json
   172  
   173  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
   174  
   175  # **GetV5OrgsOrgMembershipsUsername**
   176  > GroupMember GetV5OrgsOrgMembershipsUsername(ctx, org, username, optional)
   177  获取授权用户所属组织的一个成员
   178  
   179  获取授权用户所属组织的一个成员
   180  
   181  ### Required Parameters
   182  
   183  Name | Type | Description  | Notes
   184  ------------- | ------------- | ------------- | -------------
   185   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   186    **org** | **string**| 组织的路径(path/login) | 
   187    **username** | **string**| 用户名(username/login) | 
   188   **optional** | ***GetV5OrgsOrgMembershipsUsernameOpts** | optional parameters | nil if no parameters
   189  
   190  ### Optional Parameters
   191  Optional parameters are passed through a pointer to a GetV5OrgsOrgMembershipsUsernameOpts struct
   192  
   193  Name | Type | Description  | Notes
   194  ------------- | ------------- | ------------- | -------------
   195  
   196  
   197   **accessToken** | **optional.String**| 用户授权码 | 
   198  
   199  ### Return type
   200  
   201  [**GroupMember**](GroupMember.md)
   202  
   203  ### Authorization
   204  
   205  No authorization required
   206  
   207  ### HTTP request headers
   208  
   209   - **Content-Type**: application/json, multipart/form-data
   210   - **Accept**: application/json
   211  
   212  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
   213  
   214  # **GetV5UserMembershipsOrgs**
   215  > []GroupMember GetV5UserMembershipsOrgs(ctx, optional)
   216  列出授权用户在所属组织的成员资料
   217  
   218  列出授权用户在所属组织的成员资料
   219  
   220  ### Required Parameters
   221  
   222  Name | Type | Description  | Notes
   223  ------------- | ------------- | ------------- | -------------
   224   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   225   **optional** | ***GetV5UserMembershipsOrgsOpts** | optional parameters | nil if no parameters
   226  
   227  ### Optional Parameters
   228  Optional parameters are passed through a pointer to a GetV5UserMembershipsOrgsOpts struct
   229  
   230  Name | Type | Description  | Notes
   231  ------------- | ------------- | ------------- | -------------
   232   **accessToken** | **optional.String**| 用户授权码 | 
   233   **active** | **optional.Bool**| 根据成员是否已激活进行筛选资料,缺省返回所有资料 | 
   234   **page** | **optional.Int32**| 当前的页码 | [default to 1]
   235   **perPage** | **optional.Int32**| 每页的数量,最大为 100 | [default to 20]
   236  
   237  ### Return type
   238  
   239  [**[]GroupMember**](GroupMember.md)
   240  
   241  ### Authorization
   242  
   243  No authorization required
   244  
   245  ### HTTP request headers
   246  
   247   - **Content-Type**: application/json, multipart/form-data
   248   - **Accept**: application/json
   249  
   250  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
   251  
   252  # **GetV5UserMembershipsOrgsOrg**
   253  > GroupMember GetV5UserMembershipsOrgsOrg(ctx, org, optional)
   254  获取授权用户在一个组织的成员资料
   255  
   256  获取授权用户在一个组织的成员资料
   257  
   258  ### Required Parameters
   259  
   260  Name | Type | Description  | Notes
   261  ------------- | ------------- | ------------- | -------------
   262   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   263    **org** | **string**| 组织的路径(path/login) | 
   264   **optional** | ***GetV5UserMembershipsOrgsOrgOpts** | optional parameters | nil if no parameters
   265  
   266  ### Optional Parameters
   267  Optional parameters are passed through a pointer to a GetV5UserMembershipsOrgsOrgOpts struct
   268  
   269  Name | Type | Description  | Notes
   270  ------------- | ------------- | ------------- | -------------
   271  
   272   **accessToken** | **optional.String**| 用户授权码 | 
   273  
   274  ### Return type
   275  
   276  [**GroupMember**](GroupMember.md)
   277  
   278  ### Authorization
   279  
   280  No authorization required
   281  
   282  ### HTTP request headers
   283  
   284   - **Content-Type**: application/json, multipart/form-data
   285   - **Accept**: application/json
   286  
   287  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
   288  
   289  # **GetV5UserOrgs**
   290  > []Group GetV5UserOrgs(ctx, optional)
   291  列出授权用户所属的组织
   292  
   293  列出授权用户所属的组织
   294  
   295  ### Required Parameters
   296  
   297  Name | Type | Description  | Notes
   298  ------------- | ------------- | ------------- | -------------
   299   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   300   **optional** | ***GetV5UserOrgsOpts** | optional parameters | nil if no parameters
   301  
   302  ### Optional Parameters
   303  Optional parameters are passed through a pointer to a GetV5UserOrgsOpts struct
   304  
   305  Name | Type | Description  | Notes
   306  ------------- | ------------- | ------------- | -------------
   307   **accessToken** | **optional.String**| 用户授权码 | 
   308   **page** | **optional.Int32**| 当前的页码 | [default to 1]
   309   **perPage** | **optional.Int32**| 每页的数量,最大为 100 | [default to 20]
   310   **admin** | **optional.Bool**| 只列出授权用户管理的组织 | 
   311  
   312  ### Return type
   313  
   314  [**[]Group**](Group.md)
   315  
   316  ### Authorization
   317  
   318  No authorization required
   319  
   320  ### HTTP request headers
   321  
   322   - **Content-Type**: application/json, multipart/form-data
   323   - **Accept**: application/json
   324  
   325  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
   326  
   327  # **GetV5UsersUsernameOrgs**
   328  > []Group GetV5UsersUsernameOrgs(ctx, username, optional)
   329  列出用户所属的组织
   330  
   331  列出用户所属的组织
   332  
   333  ### Required Parameters
   334  
   335  Name | Type | Description  | Notes
   336  ------------- | ------------- | ------------- | -------------
   337   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   338    **username** | **string**| 用户名(username/login) | 
   339   **optional** | ***GetV5UsersUsernameOrgsOpts** | optional parameters | nil if no parameters
   340  
   341  ### Optional Parameters
   342  Optional parameters are passed through a pointer to a GetV5UsersUsernameOrgsOpts struct
   343  
   344  Name | Type | Description  | Notes
   345  ------------- | ------------- | ------------- | -------------
   346  
   347   **accessToken** | **optional.String**| 用户授权码 | 
   348   **page** | **optional.Int32**| 当前的页码 | [default to 1]
   349   **perPage** | **optional.Int32**| 每页的数量,最大为 100 | [default to 20]
   350  
   351  ### Return type
   352  
   353  [**[]Group**](Group.md)
   354  
   355  ### Authorization
   356  
   357  No authorization required
   358  
   359  ### HTTP request headers
   360  
   361   - **Content-Type**: application/json, multipart/form-data
   362   - **Accept**: application/json
   363  
   364  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
   365  
   366  # **PatchV5OrgsOrg**
   367  > GroupDetail PatchV5OrgsOrg(ctx, org, optional)
   368  更新授权用户所管理的组织资料
   369  
   370  更新授权用户所管理的组织资料
   371  
   372  ### Required Parameters
   373  
   374  Name | Type | Description  | Notes
   375  ------------- | ------------- | ------------- | -------------
   376   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   377    **org** | **string**| 组织的路径(path/login) | 
   378   **optional** | ***PatchV5OrgsOrgOpts** | optional parameters | nil if no parameters
   379  
   380  ### Optional Parameters
   381  Optional parameters are passed through a pointer to a PatchV5OrgsOrgOpts struct
   382  
   383  Name | Type | Description  | Notes
   384  ------------- | ------------- | ------------- | -------------
   385  
   386   **accessToken** | **optional.String**| 用户授权码 | 
   387   **email** | **optional.String**| 组织公开的邮箱地址 | 
   388   **location** | **optional.String**| 组织所在地 | 
   389   **name** | **optional.String**| 组织名称 | 
   390   **description** | **optional.String**| 组织简介 | 
   391   **htmlUrl** | **optional.String**| 组织站点 | 
   392  
   393  ### Return type
   394  
   395  [**GroupDetail**](GroupDetail.md)
   396  
   397  ### Authorization
   398  
   399  No authorization required
   400  
   401  ### HTTP request headers
   402  
   403   - **Content-Type**: application/json, multipart/form-data
   404   - **Accept**: application/json
   405  
   406  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
   407  
   408  # **PatchV5UserMembershipsOrgsOrg**
   409  > GroupMember PatchV5UserMembershipsOrgsOrg(ctx, org, optional)
   410  更新授权用户在一个组织的成员资料
   411  
   412  更新授权用户在一个组织的成员资料
   413  
   414  ### Required Parameters
   415  
   416  Name | Type | Description  | Notes
   417  ------------- | ------------- | ------------- | -------------
   418   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   419    **org** | **string**| 组织的路径(path/login) | 
   420   **optional** | ***PatchV5UserMembershipsOrgsOrgOpts** | optional parameters | nil if no parameters
   421  
   422  ### Optional Parameters
   423  Optional parameters are passed through a pointer to a PatchV5UserMembershipsOrgsOrgOpts struct
   424  
   425  Name | Type | Description  | Notes
   426  ------------- | ------------- | ------------- | -------------
   427  
   428   **accessToken** | **optional.String**| 用户授权码 | 
   429   **remark** | **optional.String**| 在组织中的备注信息 | 
   430  
   431  ### Return type
   432  
   433  [**GroupMember**](GroupMember.md)
   434  
   435  ### Authorization
   436  
   437  No authorization required
   438  
   439  ### HTTP request headers
   440  
   441   - **Content-Type**: application/json, multipart/form-data
   442   - **Accept**: application/json
   443  
   444  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
   445  
   446  # **PostV5UsersOrganization**
   447  > Group PostV5UsersOrganization(ctx, name, org, optional)
   448  创建组织
   449  
   450  创建组织
   451  
   452  ### Required Parameters
   453  
   454  Name | Type | Description  | Notes
   455  ------------- | ------------- | ------------- | -------------
   456   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   457    **name** | **string**| 组织名称 | 
   458    **org** | **string**| 组织的路径(path/login) | 
   459   **optional** | ***PostV5UsersOrganizationOpts** | optional parameters | nil if no parameters
   460  
   461  ### Optional Parameters
   462  Optional parameters are passed through a pointer to a PostV5UsersOrganizationOpts struct
   463  
   464  Name | Type | Description  | Notes
   465  ------------- | ------------- | ------------- | -------------
   466  
   467  
   468   **accessToken** | **optional.String**| 用户授权码 | 
   469   **description** | **optional.String**| 组织描述 | 
   470  
   471  ### Return type
   472  
   473  [**Group**](Group.md)
   474  
   475  ### Authorization
   476  
   477  No authorization required
   478  
   479  ### HTTP request headers
   480  
   481   - **Content-Type**: application/json, multipart/form-data
   482   - **Accept**: application/json
   483  
   484  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
   485  
   486  # **PutV5OrgsOrgMembershipsUsername**
   487  > GroupMember PutV5OrgsOrgMembershipsUsername(ctx, org, username, optional)
   488  增加或更新授权用户所管理组织的成员
   489  
   490  增加或更新授权用户所管理组织的成员
   491  
   492  ### Required Parameters
   493  
   494  Name | Type | Description  | Notes
   495  ------------- | ------------- | ------------- | -------------
   496   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   497    **org** | **string**| 组织的路径(path/login) | 
   498    **username** | **string**| 用户名(username/login) | 
   499   **optional** | ***PutV5OrgsOrgMembershipsUsernameOpts** | optional parameters | nil if no parameters
   500  
   501  ### Optional Parameters
   502  Optional parameters are passed through a pointer to a PutV5OrgsOrgMembershipsUsernameOpts struct
   503  
   504  Name | Type | Description  | Notes
   505  ------------- | ------------- | ------------- | -------------
   506  
   507  
   508   **accessToken** | **optional.String**| 用户授权码 | 
   509   **role** | **optional.String**| 设置用户在组织的角色 | [default to member]
   510  
   511  ### Return type
   512  
   513  [**GroupMember**](GroupMember.md)
   514  
   515  ### Authorization
   516  
   517  No authorization required
   518  
   519  ### HTTP request headers
   520  
   521   - **Content-Type**: application/json, multipart/form-data
   522   - **Accept**: application/json
   523  
   524  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
   525