\ClientScopesAPI

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

Method	HTTP request	Description
DeleteClientScope	Delete /{realm}/client-scopes/{id}
DeleteClientTemplate	Delete /{realm}/client-templates/{id}
GetClientScope	Get /{realm}/client-scopes/{id}
GetClientScopes	Get /{realm}/client-scopes
GetClientTemplate	Get /{realm}/client-templates/{id}
GetClientTemplates	Get /{realm}/client-templates
PostClientScopes	Post /{realm}/client-scopes
PostClientTemplates	Post /{realm}/client-templates
PutClientScope	Put /{realm}/client-scopes/{id}
PutClientTemplate	Put /{realm}/client-templates/{id}

DeleteClientScope

DeleteClientScope(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.ClientScopesAPI.DeleteClientScope(context.Background(), realm, id).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ClientScopesAPI.DeleteClientScope``: %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 apiDeleteClientScopeRequest 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]

DeleteClientTemplate

DeleteClientTemplate(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.ClientScopesAPI.DeleteClientTemplate(context.Background(), realm, id).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ClientScopesAPI.DeleteClientTemplate``: %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 apiDeleteClientTemplateRequest 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]

GetClientScope

ClientScopeRepresentation GetClientScope(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)
	resp, r, err := apiClient.ClientScopesAPI.GetClientScope(context.Background(), realm, id).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ClientScopesAPI.GetClientScope``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetClientScope`: ClientScopeRepresentation
	fmt.Fprintf(os.Stdout, "Response from `ClientScopesAPI.GetClientScope`: %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 apiGetClientScopeRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

ClientScopeRepresentation

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]

GetClientScopes

[]ClientScopeRepresentation GetClientScopes(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.ClientScopesAPI.GetClientScopes(context.Background(), realm).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ClientScopesAPI.GetClientScopes``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetClientScopes`: []ClientScopeRepresentation
	fmt.Fprintf(os.Stdout, "Response from `ClientScopesAPI.GetClientScopes`: %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 apiGetClientScopesRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

[]ClientScopeRepresentation

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]

GetClientTemplate

ClientScopeRepresentation GetClientTemplate(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)
	resp, r, err := apiClient.ClientScopesAPI.GetClientTemplate(context.Background(), realm, id).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ClientScopesAPI.GetClientTemplate``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetClientTemplate`: ClientScopeRepresentation
	fmt.Fprintf(os.Stdout, "Response from `ClientScopesAPI.GetClientTemplate`: %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 apiGetClientTemplateRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

ClientScopeRepresentation

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]

GetClientTemplates

[]ClientScopeRepresentation GetClientTemplates(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.ClientScopesAPI.GetClientTemplates(context.Background(), realm).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ClientScopesAPI.GetClientTemplates``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetClientTemplates`: []ClientScopeRepresentation
	fmt.Fprintf(os.Stdout, "Response from `ClientScopesAPI.GetClientTemplates`: %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 apiGetClientTemplatesRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

[]ClientScopeRepresentation

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]

PostClientScopes

PostClientScopes(ctx, realm).ClientScopeRepresentation(clientScopeRepresentation).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!)
	clientScopeRepresentation := *openapiclient.NewClientScopeRepresentation() // ClientScopeRepresentation | ClientScopeRepresentation (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.ClientScopesAPI.PostClientScopes(context.Background(), realm).ClientScopeRepresentation(clientScopeRepresentation).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ClientScopesAPI.PostClientScopes``: %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 apiPostClientScopesRequest struct via the builder pattern

Name	Type	Description	Notes

clientScopeRepresentation | ClientScopeRepresentation | ClientScopeRepresentation |

Return type

(empty response body)

Authorization

access_token

HTTP request headers

Content-Type: application/json
Accept: Not defined

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

PostClientTemplates

PostClientTemplates(ctx, realm).ClientScopeRepresentation(clientScopeRepresentation).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!)
	clientScopeRepresentation := *openapiclient.NewClientScopeRepresentation() // ClientScopeRepresentation | ClientScopeRepresentation (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.ClientScopesAPI.PostClientTemplates(context.Background(), realm).ClientScopeRepresentation(clientScopeRepresentation).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ClientScopesAPI.PostClientTemplates``: %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 apiPostClientTemplatesRequest struct via the builder pattern

Name	Type	Description	Notes

clientScopeRepresentation | ClientScopeRepresentation | ClientScopeRepresentation |

Return type

(empty response body)

Authorization

access_token

HTTP request headers

Content-Type: application/json
Accept: Not defined

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

PutClientScope

PutClientScope(ctx, realm, id).ClientScopeRepresentation(clientScopeRepresentation).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 | 
	clientScopeRepresentation := *openapiclient.NewClientScopeRepresentation() // ClientScopeRepresentation | ClientScopeRepresentation (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.ClientScopesAPI.PutClientScope(context.Background(), realm, id).ClientScopeRepresentation(clientScopeRepresentation).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ClientScopesAPI.PutClientScope``: %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 apiPutClientScopeRequest struct via the builder pattern

Name	Type	Description	Notes

clientScopeRepresentation | ClientScopeRepresentation | ClientScopeRepresentation |

Return type

(empty response body)

Authorization

access_token

HTTP request headers

Content-Type: application/json
Accept: Not defined

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

PutClientTemplate

PutClientTemplate(ctx, realm, id).ClientScopeRepresentation(clientScopeRepresentation).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 | 
	clientScopeRepresentation := *openapiclient.NewClientScopeRepresentation() // ClientScopeRepresentation | ClientScopeRepresentation (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.ClientScopesAPI.PutClientTemplate(context.Background(), realm, id).ClientScopeRepresentation(clientScopeRepresentation).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ClientScopesAPI.PutClientTemplate``: %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 apiPutClientTemplateRequest struct via the builder pattern

Name	Type	Description	Notes

clientScopeRepresentation | ClientScopeRepresentation | ClientScopeRepresentation |

Return type

(empty response body)

Authorization

access_token

HTTP request headers

Content-Type: application/json
Accept: Not defined

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

FilesExpand file tree

ClientScopesAPI.md

Latest commit

History

ClientScopesAPI.md

File metadata and controls

\ClientScopesAPI

DeleteClientScope

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

DeleteClientTemplate

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetClientScope

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetClientScopes

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetClientTemplate

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetClientTemplates

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

PostClientScopes

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

PostClientTemplates

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

PutClientScope

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

PutClientTemplate

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers