All URIs are relative to http://localhost/api/v2.0
| Method | HTTP request | Description |
|---|---|---|
| CreateUserGroup | Post /usergroups | Create user group |
| DeleteUserGroup | Delete /usergroups/{group_id} | Delete user group |
| GetUserGroup | Get /usergroups/{group_id} | Get user group information |
| ListUserGroups | Get /usergroups | Get all user groups information |
| SearchUserGroups | Get /usergroups/search | Search groups by groupname |
| UpdateUserGroup | Put /usergroups/{group_id} | Update group information |
CreateUserGroup(ctx, optional) Create user group
Create user group information
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| optional | *UsergroupApiCreateUserGroupOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a UsergroupApiCreateUserGroupOpts struct
| Name | Type | Description | Notes |
|---|---|---|---|
| xRequestId | optional.String | An unique ID for the request | |
| usergroup | optional.Interface of UserGroup |
(empty response body)
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DeleteUserGroup(ctx, groupId, optional) Delete user group
Delete user group
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| groupId | int32 | ||
| optional | *UsergroupApiDeleteUserGroupOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a UsergroupApiDeleteUserGroupOpts struct
| Name | Type | Description | Notes |
|---|
xRequestId | optional.String| An unique ID for the request |
(empty response body)
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
UserGroup GetUserGroup(ctx, groupId, optional) Get user group information
Get user group information
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| groupId | int64 | Group ID | |
| optional | *UsergroupApiGetUserGroupOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a UsergroupApiGetUserGroupOpts struct
| Name | Type | Description | Notes |
|---|
xRequestId | optional.String| An unique ID for the request |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
[]UserGroup ListUserGroups(ctx, optional) Get all user groups information
Get all user groups information, it is open for system admin
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| optional | *UsergroupApiListUserGroupsOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a UsergroupApiListUserGroupsOpts struct
| Name | Type | Description | Notes |
|---|---|---|---|
| xRequestId | optional.String | An unique ID for the request | |
| page | optional.Int64 | The page number | [default to 1] |
| pageSize | optional.Int64 | The size of per page | [default to 10] |
| ldapGroupDn | optional.String | search with ldap group DN | |
| groupName | optional.String | group name need to search, fuzzy matches |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
[]UserGroupSearchItem SearchUserGroups(ctx, groupname, optional) Search groups by groupname
This endpoint is to search groups by group name. It's open for all authenticated requests.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| groupname | string | Group name for filtering results. | |
| optional | *UsergroupApiSearchUserGroupsOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a UsergroupApiSearchUserGroupsOpts struct
| Name | Type | Description | Notes |
|---|
xRequestId | optional.String| An unique ID for the request | page | optional.Int64| The page number | [default to 1] pageSize | optional.Int64| The size of per page | [default to 10]
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
UpdateUserGroup(ctx, groupId, optional) Update group information
Update user group information
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| groupId | int64 | Group ID | |
| optional | *UsergroupApiUpdateUserGroupOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a UsergroupApiUpdateUserGroupOpts struct
| Name | Type | Description | Notes |
|---|
xRequestId | optional.String| An unique ID for the request | usergroup | optional.Interface of UserGroup| |
(empty response body)
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]