Skip to content

LDAPOIDCRoleManagementAPI.md

Latest commit

 

History

History
372 lines (237 loc) · 10.3 KB

LDAPOIDCRoleManagementAPI.md

File metadata and controls

372 lines (237 loc) · 10.3 KB

\LDAPOIDCRoleManagementAPI

All URIs are relative to http://localhost

Method HTTP request Description
DeleteOidcGroupMapping Delete /api/v1/customers/{cUUID}/oidc_mappings/{groupName} Delete a OIDC group mapping
ListLdapDnToYbaRoles Get /api/v1/customers/{cUUID}/ldap_mappings List LDAP Mappings
ListOidcGroupToYbaRoles Get /api/v1/customers/{cUUID}/oidc_mappings List OIDC Group Mappings
MapOidcGroupToYbaRoles Put /api/v1/customers/{cUUID}/oidc_mappings Set OIDC Mappings
SetLdapDnToYbaRoles Put /api/v1/customers/{cUUID}/ldap_mappings Set LDAP Mappings

DeleteOidcGroupMapping

YBPSuccess DeleteOidcGroupMapping(ctx, cUUID, groupName).Request(request).Execute()

Delete a OIDC group mapping

Example

package main

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

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

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

Path Parameters

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

Other Parameters

Other parameters are passed through a pointer to a apiDeleteOidcGroupMappingRequest 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]

ListLdapDnToYbaRoles

LdapDnToYbaRoleData ListLdapDnToYbaRoles(ctx, cUUID).Execute()

List LDAP Mappings

Example

package main

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

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

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.LDAPOIDCRoleManagementAPI.ListLdapDnToYbaRoles(context.Background(), cUUID).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `LDAPOIDCRoleManagementAPI.ListLdapDnToYbaRoles``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `ListLdapDnToYbaRoles`: LdapDnToYbaRoleData
	fmt.Fprintf(os.Stdout, "Response from `LDAPOIDCRoleManagementAPI.ListLdapDnToYbaRoles`: %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 apiListLdapDnToYbaRolesRequest struct via the builder pattern

Name Type Description Notes

Return type

LdapDnToYbaRoleData

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]

ListOidcGroupToYbaRoles

OidcGroupToYbaRolesData ListOidcGroupToYbaRoles(ctx, cUUID).Execute()

List OIDC Group Mappings

Example

package main

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

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

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.LDAPOIDCRoleManagementAPI.ListOidcGroupToYbaRoles(context.Background(), cUUID).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `LDAPOIDCRoleManagementAPI.ListOidcGroupToYbaRoles``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `ListOidcGroupToYbaRoles`: OidcGroupToYbaRolesData
	fmt.Fprintf(os.Stdout, "Response from `LDAPOIDCRoleManagementAPI.ListOidcGroupToYbaRoles`: %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 apiListOidcGroupToYbaRolesRequest struct via the builder pattern

Name Type Description Notes

Return type

OidcGroupToYbaRolesData

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]

MapOidcGroupToYbaRoles

MapOidcGroupToYbaRoles(ctx, cUUID).OidcMappings(oidcMappings).Request(request).Execute()

Set OIDC Mappings

Example

package main

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

func main() {
	cUUID := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | 
	oidcMappings := *openapiclient.NewOidcGroupToYbaRolesData() // OidcGroupToYbaRolesData | New OIDC Mappings to be set
	request := TODO // interface{} |  (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.LDAPOIDCRoleManagementAPI.MapOidcGroupToYbaRoles(context.Background(), cUUID).OidcMappings(oidcMappings).Request(request).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `LDAPOIDCRoleManagementAPI.MapOidcGroupToYbaRoles``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
}

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 apiMapOidcGroupToYbaRolesRequest struct via the builder pattern

Name Type Description Notes

oidcMappings | OidcGroupToYbaRolesData | New OIDC Mappings to be set | request | interface{} | |

Return type

(empty response body)

Authorization

apiKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: Not defined

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

SetLdapDnToYbaRoles

SetLdapDnToYbaRoles(ctx, cUUID).LdapMappings(ldapMappings).Request(request).Execute()

Set LDAP Mappings

Example

package main

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

func main() {
	cUUID := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | 
	ldapMappings := *openapiclient.NewLdapDnToYbaRoleData() // LdapDnToYbaRoleData | New LDAP Mappings to be set
	request := TODO // interface{} |  (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.LDAPOIDCRoleManagementAPI.SetLdapDnToYbaRoles(context.Background(), cUUID).LdapMappings(ldapMappings).Request(request).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `LDAPOIDCRoleManagementAPI.SetLdapDnToYbaRoles``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
}

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 apiSetLdapDnToYbaRolesRequest struct via the builder pattern

Name Type Description Notes

ldapMappings | LdapDnToYbaRoleData | New LDAP Mappings to be set | request | interface{} | |

Return type

(empty response body)

Authorization

apiKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: Not defined

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