\ComponentAPI

All URIs are relative to http://localhost

Method	HTTP request	Description
AdminRealmsRealmComponentsGet	Get /admin/realms/{realm}/components
AdminRealmsRealmComponentsIdDelete	Delete /admin/realms/{realm}/components/{id}
AdminRealmsRealmComponentsIdGet	Get /admin/realms/{realm}/components/{id}
AdminRealmsRealmComponentsIdPut	Put /admin/realms/{realm}/components/{id}
AdminRealmsRealmComponentsIdSubComponentTypesGet	Get /admin/realms/{realm}/components/{id}/sub-component-types	List of subcomponent types that are available to configure for a particular parent component.
AdminRealmsRealmComponentsPost	Post /admin/realms/{realm}/components

AdminRealmsRealmComponentsGet

[]ComponentRepresentation AdminRealmsRealmComponentsGet(ctx, realm).Name(name).Parent(parent).Type_(type_).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/daytonaio/daytona-ee-draft/pkg/keycloak-admin-client"
)

func main() {
	realm := "realm_example" // string | realm name (not id!)
	name := "name_example" // string |  (optional)
	parent := "parent_example" // string |  (optional)
	type_ := "type__example" // string |  (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ComponentAPI.AdminRealmsRealmComponentsGet(context.Background(), realm).Name(name).Parent(parent).Type_(type_).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ComponentAPI.AdminRealmsRealmComponentsGet``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `AdminRealmsRealmComponentsGet`: []ComponentRepresentation
	fmt.Fprintf(os.Stdout, "Response from `ComponentAPI.AdminRealmsRealmComponentsGet`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
realm	string	realm name (not id!)

Other Parameters

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

Name	Type	Description	Notes

Return type

[]ComponentRepresentation

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

AdminRealmsRealmComponentsIdDelete

AdminRealmsRealmComponentsIdDelete(ctx, realm, id).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/daytonaio/daytona-ee-draft/pkg/keycloak-admin-client"
)

func main() {
	realm := "realm_example" // string | realm name (not id!)
	id := "id_example" // string | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.ComponentAPI.AdminRealmsRealmComponentsIdDelete(context.Background(), realm, id).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ComponentAPI.AdminRealmsRealmComponentsIdDelete``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
realm	string	realm name (not id!)
id	string

Other Parameters

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

Name	Type	Description	Notes

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

AdminRealmsRealmComponentsIdGet

ComponentRepresentation AdminRealmsRealmComponentsIdGet(ctx, realm, id).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/daytonaio/daytona-ee-draft/pkg/keycloak-admin-client"
)

func main() {
	realm := "realm_example" // string | realm name (not id!)
	id := "id_example" // string | 

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

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
realm	string	realm name (not id!)
id	string

Other Parameters

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

Name	Type	Description	Notes

Return type

ComponentRepresentation

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

AdminRealmsRealmComponentsIdPut

AdminRealmsRealmComponentsIdPut(ctx, realm, id).ComponentRepresentation(componentRepresentation).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/daytonaio/daytona-ee-draft/pkg/keycloak-admin-client"
)

func main() {
	realm := "realm_example" // string | realm name (not id!)
	id := "id_example" // string | 
	componentRepresentation := *openapiclient.NewComponentRepresentation() // ComponentRepresentation |  (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.ComponentAPI.AdminRealmsRealmComponentsIdPut(context.Background(), realm, id).ComponentRepresentation(componentRepresentation).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ComponentAPI.AdminRealmsRealmComponentsIdPut``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
realm	string	realm name (not id!)
id	string

Other Parameters

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

Name	Type	Description	Notes

componentRepresentation | ComponentRepresentation | |

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: Not defined

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

AdminRealmsRealmComponentsIdSubComponentTypesGet

[]ComponentTypeRepresentation AdminRealmsRealmComponentsIdSubComponentTypesGet(ctx, realm, id).Type_(type_).Execute()

List of subcomponent types that are available to configure for a particular parent component.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/daytonaio/daytona-ee-draft/pkg/keycloak-admin-client"
)

func main() {
	realm := "realm_example" // string | realm name (not id!)
	id := "id_example" // string | 
	type_ := "type__example" // string |  (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ComponentAPI.AdminRealmsRealmComponentsIdSubComponentTypesGet(context.Background(), realm, id).Type_(type_).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ComponentAPI.AdminRealmsRealmComponentsIdSubComponentTypesGet``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `AdminRealmsRealmComponentsIdSubComponentTypesGet`: []ComponentTypeRepresentation
	fmt.Fprintf(os.Stdout, "Response from `ComponentAPI.AdminRealmsRealmComponentsIdSubComponentTypesGet`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
realm	string	realm name (not id!)
id	string

Other Parameters

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

Name	Type	Description	Notes

type_ | string | |

Return type

[]ComponentTypeRepresentation

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

AdminRealmsRealmComponentsPost

AdminRealmsRealmComponentsPost(ctx, realm).ComponentRepresentation(componentRepresentation).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/daytonaio/daytona-ee-draft/pkg/keycloak-admin-client"
)

func main() {
	realm := "realm_example" // string | realm name (not id!)
	componentRepresentation := *openapiclient.NewComponentRepresentation() // ComponentRepresentation |  (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.ComponentAPI.AdminRealmsRealmComponentsPost(context.Background(), realm).ComponentRepresentation(componentRepresentation).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ComponentAPI.AdminRealmsRealmComponentsPost``: %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.
realm	string	realm name (not id!)

Other Parameters

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

Name	Type	Description	Notes

componentRepresentation | ComponentRepresentation | |

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: Not defined

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

Files

ComponentAPI.md

Latest commit

History

ComponentAPI.md

File metadata and controls

\ComponentAPI

AdminRealmsRealmComponentsGet

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

AdminRealmsRealmComponentsIdDelete

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

AdminRealmsRealmComponentsIdGet

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

AdminRealmsRealmComponentsIdPut

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

AdminRealmsRealmComponentsIdSubComponentTypesGet

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

AdminRealmsRealmComponentsPost

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers