\RBACManagementAPI

All URIs are relative to http://localhost

Method	HTTP request	Description
CreateRole	Post /api/v1/customers/{cUUID}/rbac/role	Create a custom role
DeleteRole	Delete /api/v1/customers/{cUUID}/rbac/role/{rUUID}	Delete a custom role
EditRole	Put /api/v1/customers/{cUUID}/rbac/role/{rUUID}	Edit a custom role
GetRole	Get /api/v1/customers/{cUUID}/rbac/role/{rUUID}	Get a role's information
GetRoleBindings	Get /api/v1/customers/{cUUID}/rbac/role_binding	Get all the role bindings available
ListPermissions	Get /api/v1/customers/{cUUID}/rbac/permissions	List all the permissions available
ListRoles	Get /api/v1/customers/{cUUID}/rbac/role	List all the roles available
SetRoleBinding	Post /api/v1/customers/{cUUID}/rbac/role_binding/{userUUID}	Set the role bindings of a user

CreateRole

Role CreateRole(ctx, cUUID).RoleFormData(roleFormData).Request(request).Execute()

Create a custom role

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/yugabyte/platform-go-client/v1"
)

func main() {
	cUUID := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | 
	roleFormData := *openapiclient.NewRoleFormData("Description_example", "Name_example", []openapiclient.Permission{*openapiclient.NewPermission()}) // RoleFormData | create role form data
	request := TODO // interface{} |  (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.RBACManagementAPI.CreateRole(context.Background(), cUUID).RoleFormData(roleFormData).Request(request).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `RBACManagementAPI.CreateRole``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `CreateRole`: Role
	fmt.Fprintf(os.Stdout, "Response from `RBACManagementAPI.CreateRole`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
cUUID	string

Other Parameters

Other parameters are passed through a pointer to a apiCreateRoleRequest struct via the builder pattern

Name	Type	Description	Notes

roleFormData | RoleFormData | create role form data | request | interface{} | |

Return type

Role

Authorization

apiKeyAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteRole

YBPSuccess DeleteRole(ctx, cUUID, rUUID).Request(request).Execute()

Delete a custom role

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/yugabyte/platform-go-client/v1"
)

func main() {
	cUUID := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | 
	rUUID := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | 
	request := TODO // interface{} |  (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.RBACManagementAPI.DeleteRole(context.Background(), cUUID, rUUID).Request(request).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `RBACManagementAPI.DeleteRole``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `DeleteRole`: YBPSuccess
	fmt.Fprintf(os.Stdout, "Response from `RBACManagementAPI.DeleteRole`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
cUUID	string
rUUID	string

Other Parameters

Other parameters are passed through a pointer to a apiDeleteRoleRequest struct via the builder pattern

Name	Type	Description	Notes

request | interface{} | |

Return type

YBPSuccess

Authorization

apiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

EditRole

Role EditRole(ctx, cUUID, rUUID).RoleFormData(roleFormData).Request(request).Execute()

Edit a custom role

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/yugabyte/platform-go-client/v1"
)

func main() {
	cUUID := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | 
	rUUID := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | 
	roleFormData := *openapiclient.NewRoleFormData("Description_example", "Name_example", []openapiclient.Permission{*openapiclient.NewPermission()}) // RoleFormData | edit role form data
	request := TODO // interface{} |  (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.RBACManagementAPI.EditRole(context.Background(), cUUID, rUUID).RoleFormData(roleFormData).Request(request).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `RBACManagementAPI.EditRole``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `EditRole`: Role
	fmt.Fprintf(os.Stdout, "Response from `RBACManagementAPI.EditRole`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
cUUID	string
rUUID	string

Other Parameters

Other parameters are passed through a pointer to a apiEditRoleRequest struct via the builder pattern

Name	Type	Description	Notes

roleFormData | RoleFormData | edit role form data | request | interface{} | |

Return type

Role

Authorization

apiKeyAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetRole

Role GetRole(ctx, cUUID, rUUID).Execute()

Get a role's information

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/yugabyte/platform-go-client/v1"
)

func main() {
	cUUID := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | 
	rUUID := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.RBACManagementAPI.GetRole(context.Background(), cUUID, rUUID).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `RBACManagementAPI.GetRole``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetRole`: Role
	fmt.Fprintf(os.Stdout, "Response from `RBACManagementAPI.GetRole`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
cUUID	string
rUUID	string

Other Parameters

Other parameters are passed through a pointer to a apiGetRoleRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

Role

Authorization

apiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetRoleBindings

map[string]RoleBinding GetRoleBindings(ctx, cUUID).UserUUID(userUUID).Execute()

Get all the role bindings available

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/yugabyte/platform-go-client/v1"
)

func main() {
	cUUID := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | 
	userUUID := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | Optional user UUID to filter role binding map (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.RBACManagementAPI.GetRoleBindings(context.Background(), cUUID).UserUUID(userUUID).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `RBACManagementAPI.GetRoleBindings``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetRoleBindings`: map[string]RoleBinding
	fmt.Fprintf(os.Stdout, "Response from `RBACManagementAPI.GetRoleBindings`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
cUUID	string

Other Parameters

Other parameters are passed through a pointer to a apiGetRoleBindingsRequest struct via the builder pattern

Name	Type	Description	Notes

userUUID | string | Optional user UUID to filter role binding map |

Return type

map[string]RoleBinding

Authorization

apiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ListPermissions

[]PermissionInfo ListPermissions(ctx, cUUID).ResourceType(resourceType).Execute()

List all the permissions available

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/yugabyte/platform-go-client/v1"
)

func main() {
	cUUID := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | 
	resourceType := "resourceType_example" // string | Optional resource type to filter permission list (optional) (default to "null")

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.RBACManagementAPI.ListPermissions(context.Background(), cUUID).ResourceType(resourceType).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `RBACManagementAPI.ListPermissions``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `ListPermissions`: []PermissionInfo
	fmt.Fprintf(os.Stdout, "Response from `RBACManagementAPI.ListPermissions`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
cUUID	string

Other Parameters

Other parameters are passed through a pointer to a apiListPermissionsRequest struct via the builder pattern

Name	Type	Description	Notes

resourceType | string | Optional resource type to filter permission list | [default to "null"]

Return type

[]PermissionInfo

Authorization

apiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ListRoles

[]Role ListRoles(ctx, cUUID).RoleType(roleType).Execute()

List all the roles available

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/yugabyte/platform-go-client/v1"
)

func main() {
	cUUID := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | 
	roleType := "roleType_example" // string | Optional role type to filter roles list (optional) (default to "null")

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.RBACManagementAPI.ListRoles(context.Background(), cUUID).RoleType(roleType).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `RBACManagementAPI.ListRoles``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `ListRoles`: []Role
	fmt.Fprintf(os.Stdout, "Response from `RBACManagementAPI.ListRoles`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
cUUID	string

Other Parameters

Other parameters are passed through a pointer to a apiListRolesRequest struct via the builder pattern

Name	Type	Description	Notes

roleType | string | Optional role type to filter roles list | [default to "null"]

Return type

[]Role

Authorization

apiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

SetRoleBinding

[]RoleBinding SetRoleBinding(ctx, cUUID, userUUID).RoleBindingFormData(roleBindingFormData).Request(request).Execute()

Set the role bindings of a user

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/yugabyte/platform-go-client/v1"
)

func main() {
	cUUID := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | 
	userUUID := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | 
	roleBindingFormData := *openapiclient.NewRoleBindingFormData([]openapiclient.RoleResourceDefinition{*openapiclient.NewRoleResourceDefinition("RoleUUID_example")}) // RoleBindingFormData | set role bindings form data
	request := TODO // interface{} |  (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.RBACManagementAPI.SetRoleBinding(context.Background(), cUUID, userUUID).RoleBindingFormData(roleBindingFormData).Request(request).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `RBACManagementAPI.SetRoleBinding``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `SetRoleBinding`: []RoleBinding
	fmt.Fprintf(os.Stdout, "Response from `RBACManagementAPI.SetRoleBinding`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
cUUID	string
userUUID	string

Other Parameters

Other parameters are passed through a pointer to a apiSetRoleBindingRequest struct via the builder pattern

Name	Type	Description	Notes

roleBindingFormData | RoleBindingFormData | set role bindings form data | request | interface{} | |

Return type

[]RoleBinding

Authorization

apiKeyAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

FilesExpand file tree

RBACManagementAPI.md

Latest commit

History

RBACManagementAPI.md

File metadata and controls

\RBACManagementAPI

CreateRole

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

DeleteRole

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

EditRole

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetRole

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetRoleBindings

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

ListPermissions

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

ListRoles

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

SetRoleBinding

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers