All URIs are relative to https://localhost/PasswordVault
Method | HTTP request | Description |
---|---|---|
UserGroupsAddMemberToGroup | Post /api/UserGroups/{groupId}/Members | |
UserGroupsCreateUserGroup | Post /api/UserGroups | |
UserGroupsDeleteUserGroup | Delete /api/UserGroups/{groupId} | |
UserGroupsEditUserGroup | Put /api/UserGroups/{groupId} | |
UserGroupsGetUserGroups | Get /api/UserGroups | |
UserGroupsRemoveUserFromGroup | Delete /api/UserGroups/{groupId}/Members/{memberName} |
GroupMember UserGroupsAddMemberToGroup(ctx, groupId).MemberToAdd(memberToAdd).Execute()
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
groupId := int64(789) // int64 | The unique ID of the Vault group.
memberToAdd := *openapiclient.NewGroupMember("MemberId_example", "DomainName_example") // GroupMember | The parameters for the member to be added
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.UserGroupsApi.UserGroupsAddMemberToGroup(context.Background(), groupId).MemberToAdd(memberToAdd).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `UserGroupsApi.UserGroupsAddMemberToGroup``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `UserGroupsAddMemberToGroup`: GroupMember
fmt.Fprintf(os.Stdout, "Response from `UserGroupsApi.UserGroupsAddMemberToGroup`: %v\n", resp)
}
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
groupId | int64 | The unique ID of the Vault group. |
Other parameters are passed through a pointer to a apiUserGroupsAddMemberToGroupRequest struct via the builder pattern
Name | Type | Description | Notes |
---|
memberToAdd | GroupMember | The parameters for the member to be added |
No authorization required
- Content-Type: application/json, text/json, application/xml, text/xml, multipart/form-data, application/x-www-form-urlencoded
- Accept: application/json, text/json, application/xml, text/xml, multipart/form-data, application/vnd.cyberark.api+json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
map[string]interface{} UserGroupsCreateUserGroup(ctx).UserGroup(userGroup).Execute()
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
userGroup := *openapiclient.NewBaseUserGroup("GroupName_example") // BaseUserGroup |
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.UserGroupsApi.UserGroupsCreateUserGroup(context.Background()).UserGroup(userGroup).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `UserGroupsApi.UserGroupsCreateUserGroup``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `UserGroupsCreateUserGroup`: map[string]interface{}
fmt.Fprintf(os.Stdout, "Response from `UserGroupsApi.UserGroupsCreateUserGroup`: %v\n", resp)
}
Other parameters are passed through a pointer to a apiUserGroupsCreateUserGroupRequest struct via the builder pattern
Name | Type | Description | Notes |
---|---|---|---|
userGroup | BaseUserGroup |
map[string]interface{}
No authorization required
- Content-Type: application/json, text/json, application/xml, text/xml, multipart/form-data, application/x-www-form-urlencoded
- Accept: application/json, text/json, application/xml, text/xml, multipart/form-data, application/vnd.cyberark.api+json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
map[string]interface{} UserGroupsDeleteUserGroup(ctx, groupId).Execute()
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
groupId := int64(789) // int64 | The unique ID of the group.
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.UserGroupsApi.UserGroupsDeleteUserGroup(context.Background(), groupId).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `UserGroupsApi.UserGroupsDeleteUserGroup``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `UserGroupsDeleteUserGroup`: map[string]interface{}
fmt.Fprintf(os.Stdout, "Response from `UserGroupsApi.UserGroupsDeleteUserGroup`: %v\n", resp)
}
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
groupId | int64 | The unique ID of the group. |
Other parameters are passed through a pointer to a apiUserGroupsDeleteUserGroupRequest struct via the builder pattern
Name | Type | Description | Notes |
---|
map[string]interface{}
No authorization required
- Content-Type: Not defined
- Accept: application/json, text/json, application/xml, text/xml, multipart/form-data, application/vnd.cyberark.api+json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
map[string]interface{} UserGroupsEditUserGroup(ctx, groupId).Group(group).Execute()
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
groupId := int64(789) // int64 | The unique ID of the group.
group := *openapiclient.NewBaseUserGroup("GroupName_example") // BaseUserGroup |
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.UserGroupsApi.UserGroupsEditUserGroup(context.Background(), groupId).Group(group).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `UserGroupsApi.UserGroupsEditUserGroup``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `UserGroupsEditUserGroup`: map[string]interface{}
fmt.Fprintf(os.Stdout, "Response from `UserGroupsApi.UserGroupsEditUserGroup`: %v\n", resp)
}
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
groupId | int64 | The unique ID of the group. |
Other parameters are passed through a pointer to a apiUserGroupsEditUserGroupRequest struct via the builder pattern
Name | Type | Description | Notes |
---|
group | BaseUserGroup | |
map[string]interface{}
No authorization required
- Content-Type: application/json, text/json, application/xml, text/xml, multipart/form-data, application/x-www-form-urlencoded
- Accept: application/json, text/json, application/xml, text/xml, multipart/form-data, application/vnd.cyberark.api+json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetUserGroupsResponse UserGroupsGetUserGroups(ctx).Search(search).Sort(sort).Filter(filter).IncludeMembers(includeMembers).Execute()
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
search := "search_example" // string | (optional)
sort := []string{"Inner_example"} // []string | (optional)
filter := "filter_example" // string | (optional)
includeMembers := true // bool | Whether or not to return members for each User Group as part of the response. If not sent, the value will be False. (optional)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.UserGroupsApi.UserGroupsGetUserGroups(context.Background()).Search(search).Sort(sort).Filter(filter).IncludeMembers(includeMembers).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `UserGroupsApi.UserGroupsGetUserGroups``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `UserGroupsGetUserGroups`: GetUserGroupsResponse
fmt.Fprintf(os.Stdout, "Response from `UserGroupsApi.UserGroupsGetUserGroups`: %v\n", resp)
}
Other parameters are passed through a pointer to a apiUserGroupsGetUserGroupsRequest struct via the builder pattern
Name | Type | Description | Notes |
---|---|---|---|
search | string | ||
sort | []string | ||
filter | string | ||
includeMembers | bool | Whether or not to return members for each User Group as part of the response. If not sent, the value will be False. |
No authorization required
- Content-Type: Not defined
- Accept: application/json, text/json, application/xml, text/xml, multipart/form-data, application/vnd.cyberark.api+json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
UserGroupsRemoveUserFromGroup(ctx, groupId, memberName).Execute()
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
groupId := int64(789) // int64 | The unique ID of the group.
memberName := "memberName_example" // string | The name of the user/group to remove from the group members
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.UserGroupsApi.UserGroupsRemoveUserFromGroup(context.Background(), groupId, memberName).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `UserGroupsApi.UserGroupsRemoveUserFromGroup``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
}
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
groupId | int64 | The unique ID of the group. | |
memberName | string | The name of the user/group to remove from the group members |
Other parameters are passed through a pointer to a apiUserGroupsRemoveUserFromGroupRequest struct via the builder pattern
Name | Type | Description | Notes |
---|
(empty response body)
No authorization required
- Content-Type: Not defined
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]