All URIs are relative to https://api.au.sumologic.com/api
Method | HTTP request | Description |
---|---|---|
AssignRoleToUser | Put /v1/roles/{roleId}/users/{userId} | Assign a role to a user. |
CreateRole | Post /v1/roles | Create a new role. |
DeleteRole | Delete /v1/roles/{id} | Delete a role. |
GetRole | Get /v1/roles/{id} | Get a role. |
ListRoles | Get /v1/roles | Get a list of roles. |
RemoveRoleFromUser | Delete /v1/roles/{roleId}/users/{userId} | Remove role from a user. |
UpdateRole | Put /v1/roles/{id} | Update a role. |
RoleModel AssignRoleToUser(ctx, roleId, userId).Execute()
Assign a role to a user.
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
roleId := "roleId_example" // string | Identifier of the role to assign.
userId := "userId_example" // string | Identifier of the user to assign the role to.
configuration := openapiclient.NewConfiguration()
api_client := openapiclient.NewAPIClient(configuration)
resp, r, err := api_client.RoleManagementApi.AssignRoleToUser(context.Background(), roleId, userId).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `RoleManagementApi.AssignRoleToUser``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `AssignRoleToUser`: RoleModel
fmt.Fprintf(os.Stdout, "Response from `RoleManagementApi.AssignRoleToUser`: %v\n", resp)
}
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
roleId | string | Identifier of the role to assign. | |
userId | string | Identifier of the user to assign the role to. |
Other parameters are passed through a pointer to a apiAssignRoleToUserRequest struct via the builder pattern
Name | Type | Description | Notes |
---|
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
RoleModel CreateRole(ctx).CreateRoleDefinition(createRoleDefinition).Execute()
Create a new role.
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
createRoleDefinition := *openapiclient.NewCreateRoleDefinition("DataAdmin") // CreateRoleDefinition | Information about the new role.
configuration := openapiclient.NewConfiguration()
api_client := openapiclient.NewAPIClient(configuration)
resp, r, err := api_client.RoleManagementApi.CreateRole(context.Background()).CreateRoleDefinition(createRoleDefinition).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `RoleManagementApi.CreateRole``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `CreateRole`: RoleModel
fmt.Fprintf(os.Stdout, "Response from `RoleManagementApi.CreateRole`: %v\n", resp)
}
Other parameters are passed through a pointer to a apiCreateRoleRequest struct via the builder pattern
Name | Type | Description | Notes |
---|---|---|---|
createRoleDefinition | CreateRoleDefinition | Information about the new role. |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DeleteRole(ctx, id).Execute()
Delete a role.
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
id := "id_example" // string | Identifier of the role to delete.
configuration := openapiclient.NewConfiguration()
api_client := openapiclient.NewAPIClient(configuration)
resp, r, err := api_client.RoleManagementApi.DeleteRole(context.Background(), id).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `RoleManagementApi.DeleteRole``: %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. | |
id | string | Identifier of the role to delete. |
Other parameters are passed through a pointer to a apiDeleteRoleRequest struct via the builder pattern
Name | Type | Description | Notes |
---|
(empty response body)
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
RoleModel GetRole(ctx, id).Execute()
Get a role.
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
id := "id_example" // string | Identifier of the role to fetch.
configuration := openapiclient.NewConfiguration()
api_client := openapiclient.NewAPIClient(configuration)
resp, r, err := api_client.RoleManagementApi.GetRole(context.Background(), id).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `RoleManagementApi.GetRole``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetRole`: RoleModel
fmt.Fprintf(os.Stdout, "Response from `RoleManagementApi.GetRole`: %v\n", resp)
}
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
id | string | Identifier of the role to fetch. |
Other parameters are passed through a pointer to a apiGetRoleRequest struct via the builder pattern
Name | Type | Description | Notes |
---|
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ListRoleModelsResponse ListRoles(ctx).Limit(limit).Token(token).SortBy(sortBy).Name(name).Execute()
Get a list of roles.
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
limit := int32(56) // int32 | Limit the number of roles returned in the response. The number of roles returned may be less than the `limit`. (optional) (default to 100)
token := "token_example" // string | Continuation token to get the next page of results. A page object with the next continuation token is returned in the response body. Subsequent GET requests should specify the continuation token to get the next page of results. `token` is set to null when no more pages are left. (optional)
sortBy := "sortBy_example" // string | Sort the list of roles by the `name` field. (optional)
name := "name_example" // string | Only return roles matching the given name. (optional)
configuration := openapiclient.NewConfiguration()
api_client := openapiclient.NewAPIClient(configuration)
resp, r, err := api_client.RoleManagementApi.ListRoles(context.Background()).Limit(limit).Token(token).SortBy(sortBy).Name(name).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `RoleManagementApi.ListRoles``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `ListRoles`: ListRoleModelsResponse
fmt.Fprintf(os.Stdout, "Response from `RoleManagementApi.ListRoles`: %v\n", resp)
}
Other parameters are passed through a pointer to a apiListRolesRequest struct via the builder pattern
Name | Type | Description | Notes |
---|---|---|---|
limit | int32 | Limit the number of roles returned in the response. The number of roles returned may be less than the `limit`. | [default to 100] |
token | string | Continuation token to get the next page of results. A page object with the next continuation token is returned in the response body. Subsequent GET requests should specify the continuation token to get the next page of results. `token` is set to null when no more pages are left. | |
sortBy | string | Sort the list of roles by the `name` field. | |
name | string | Only return roles matching the given name. |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
RemoveRoleFromUser(ctx, roleId, userId).Execute()
Remove role from a user.
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
roleId := "roleId_example" // string | Identifier of the role to delete.
userId := "userId_example" // string | Identifier of the user to remove the role from.
configuration := openapiclient.NewConfiguration()
api_client := openapiclient.NewAPIClient(configuration)
resp, r, err := api_client.RoleManagementApi.RemoveRoleFromUser(context.Background(), roleId, userId).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `RoleManagementApi.RemoveRoleFromUser``: %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. | |
roleId | string | Identifier of the role to delete. | |
userId | string | Identifier of the user to remove the role from. |
Other parameters are passed through a pointer to a apiRemoveRoleFromUserRequest struct via the builder pattern
Name | Type | Description | Notes |
---|
(empty response body)
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
RoleModel UpdateRole(ctx, id).UpdateRoleDefinition(updateRoleDefinition).Execute()
Update a role.
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
id := "id_example" // string | Identifier of the role to update.
updateRoleDefinition := *openapiclient.NewUpdateRoleDefinition("DataAdmin", "Manage data of the org.", "!_sourceCategory=billing", []string{"Users_example"}, []string{"Capabilities_example"}) // UpdateRoleDefinition | Information to update about the role.
configuration := openapiclient.NewConfiguration()
api_client := openapiclient.NewAPIClient(configuration)
resp, r, err := api_client.RoleManagementApi.UpdateRole(context.Background(), id).UpdateRoleDefinition(updateRoleDefinition).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `RoleManagementApi.UpdateRole``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `UpdateRole`: RoleModel
fmt.Fprintf(os.Stdout, "Response from `RoleManagementApi.UpdateRole`: %v\n", resp)
}
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
id | string | Identifier of the role to update. |
Other parameters are passed through a pointer to a apiUpdateRoleRequest struct via the builder pattern
Name | Type | Description | Notes |
---|
updateRoleDefinition | UpdateRoleDefinition | Information to update about the role. |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]