Skip to content

ClientInitialAccessAPI.md

Latest commit

 

History

History
220 lines (138 loc) · 6.29 KB

ClientInitialAccessAPI.md

File metadata and controls

220 lines (138 loc) · 6.29 KB

\ClientInitialAccessAPI

All URIs are relative to https://keycloak.example.com/admin/realms

Method HTTP request Description
DeleteClientsInitialAcces Delete /{realm}/clients-initial-access/{id}
GetClientsInitialAccess Get /{realm}/clients-initial-access
PostClientsInitialAccess Post /{realm}/clients-initial-access

DeleteClientsInitialAcces

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

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

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

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

Other Parameters

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

Name Type Description Notes

Return type

(empty response body)

Authorization

access_token

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

GetClientsInitialAccess

[]ClientInitialAccessPresentation GetClientsInitialAccess(ctx, realm).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

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

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

Name Type Description Notes

Return type

[]ClientInitialAccessPresentation

Authorization

access_token

HTTP request headers

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

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

PostClientsInitialAccess

ClientInitialAccessPresentation PostClientsInitialAccess(ctx, realm).ClientInitialAccessCreatePresentation(clientInitialAccessCreatePresentation).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	realm := "realm_example" // string | realm name (not id!)
	clientInitialAccessCreatePresentation := *openapiclient.NewClientInitialAccessCreatePresentation() // ClientInitialAccessCreatePresentation | ClientInitialAccessCreatePresentation (optional)

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

Name Type Description Notes

clientInitialAccessCreatePresentation | ClientInitialAccessCreatePresentation | ClientInitialAccessCreatePresentation |

Return type

ClientInitialAccessPresentation

Authorization

access_token

HTTP request headers

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

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