All URIs are relative to https://localhost/cloudapi
| Method | HTTP request | Description |
|---|---|---|
| CreateUser | Post /1.0.0/users | Create a new user. |
| DeleteUser | Delete /1.0.0/users/{userUrn} | Delete the specified user. |
| GetUser | Get /1.0.0/users/{userUrn} | Get a specified user by id. |
| QueryUserGroups | Get /1.0.0/users/{userUrn}/groups | Get a list of groups that the user with the given id belongs to. |
| QueryUsers | Get /1.0.0/users | Get a list of users. |
| UpdateUser | Put /1.0.0/users/{userUrn} | Modify the details of a user. A non-administrator user may only modify their own password. An administrator can edit any user. |
VcdUser CreateUser(ctx, newUser) Create a new user.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| newUser | VcdUser |
- Content-Type: application/json
- Accept: application/json;version=36.0
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DeleteUser(ctx, userUrn) Delete the specified user.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| userUrn | string | userUrn |
(empty response body)
- Content-Type: Not defined
- Accept: /;version=36.0
[Back to top] [Back to API list] [Back to Model list] [Back to README]
VcdUser GetUser(ctx, userUrn) Get a specified user by id.
Get a specified user by id.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| userUrn | string | userUrn |
- Content-Type: Not defined
- Accept: application/json;version=36.0
[Back to top] [Back to API list] [Back to Model list] [Back to README]
EntityReferences QueryUserGroups(ctx, page, pageSize, userUrn, optional) Get a list of groups that the user with the given id belongs to.
Get a list of references of groups that the user with the given id belongs to.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| page | int32 | Page to fetch, zero offset. | [default to 1] |
| pageSize | int32 | Results per page to fetch. | [default to 25] |
| userUrn | string | userUrn | |
| optional | *UserApiQueryUserGroupsOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a UserApiQueryUserGroupsOpts struct
| Name | Type | Description | Notes |
|---|
filter | optional.String| Filter for a query. FIQL format. | sortAsc | optional.String| Field to use for ascending sort | sortDesc | optional.String| Field to use for descending sort |
- Content-Type: Not defined
- Accept: application/json;version=36.0
[Back to top] [Back to API list] [Back to Model list] [Back to README]
VcdUsers QueryUsers(ctx, page, pageSize, optional) Get a list of users.
Get a list of users.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| page | int32 | Page to fetch, zero offset. | [default to 1] |
| pageSize | int32 | Results per page to fetch. | [default to 25] |
| optional | *UserApiQueryUsersOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a UserApiQueryUsersOpts struct
| Name | Type | Description | Notes |
|---|
filter | optional.String| Filter for a query. FIQL format. | sortAsc | optional.String| Field to use for ascending sort | sortDesc | optional.String| Field to use for descending sort |
- Content-Type: Not defined
- Accept: application/json;version=36.0
[Back to top] [Back to API list] [Back to Model list] [Back to README]
VcdUser UpdateUser(ctx, updatedUser, userUrn) Modify the details of a user. A non-administrator user may only modify their own password. An administrator can edit any user.
Modify basic details of the specified user.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| updatedUser | VcdUser | ||
| userUrn | string | userUrn |
- Content-Type: application/json
- Accept: application/json;version=36.0
[Back to top] [Back to API list] [Back to Model list] [Back to README]