Files
portal/openapi/docs/AccessAuthAPI.md
2026-06-22 11:38:29 +02:00

14 KiB

\AccessAuthAPI

All URIs are relative to http://localhost

Method HTTP request Description
AddAccessauthAaPost Post /aa/ Add Accessauth
AssignAccessauthAaAssignGroupIdAaIdPut Put /aa/assign/{group_id}/{aa_id} Assign Accessauth
ChangeAccessauthAaAaIdPatch Patch /aa/{aa_id} Change Accessauth
DeleteAccessauthAaAaIdDelete Delete /aa/{aa_id} Delete Accessauth
GetAllAccessauthsAaGet Get /aa/ Get All Accessauths
GetOneAccessauthAaAaIdGet Get /aa/{aa_id} Get One Accessauth
UnassignAccessauthAaUnassignGroupIdAaIdPut Put /aa/unassign/{group_id}/{aa_id} Unassign Accessauth

AddAccessauthAaPost

AccessAuthorizationResponse AddAccessauthAaPost(ctx).AccessAuthorizationCreate(accessAuthorizationCreate).Execute()

Add Accessauth

Example

package main

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

func main() {
	accessAuthorizationCreate := *openapiclient.NewAccessAuthorizationCreate("Name_example", false, []openapiclient.TimetableCreate{*openapiclient.NewTimetableCreate(int32(123), "Starttime_example", int32(123))}) // AccessAuthorizationCreate | 

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

Path Parameters

Other Parameters

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

Name Type Description Notes
accessAuthorizationCreate AccessAuthorizationCreate

Return type

AccessAuthorizationResponse

Authorization

OAuth2PasswordBearer

HTTP request headers

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

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

AssignAccessauthAaAssignGroupIdAaIdPut

GroupResponse AssignAccessauthAaAssignGroupIdAaIdPut(ctx, groupId, aaId).Execute()

Assign Accessauth

Example

package main

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

func main() {
	groupId := int32(56) // int32 | 
	aaId := int32(56) // int32 | 

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
groupId int32
aaId int32

Other Parameters

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

Name Type Description Notes

Return type

GroupResponse

Authorization

OAuth2PasswordBearer

HTTP request headers

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

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

ChangeAccessauthAaAaIdPatch

AccessAuthorizationResponse ChangeAccessauthAaAaIdPatch(ctx, aaId).AccessAuthorizationUpdate(accessAuthorizationUpdate).Execute()

Change Accessauth

Example

package main

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

func main() {
	aaId := int32(56) // int32 | 
	accessAuthorizationUpdate := *openapiclient.NewAccessAuthorizationUpdate() // AccessAuthorizationUpdate | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.AccessAuthAPI.ChangeAccessauthAaAaIdPatch(context.Background(), aaId).AccessAuthorizationUpdate(accessAuthorizationUpdate).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `AccessAuthAPI.ChangeAccessauthAaAaIdPatch``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `ChangeAccessauthAaAaIdPatch`: AccessAuthorizationResponse
	fmt.Fprintf(os.Stdout, "Response from `AccessAuthAPI.ChangeAccessauthAaAaIdPatch`: %v\n", resp)
}

Path Parameters

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

Other Parameters

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

Name Type Description Notes

accessAuthorizationUpdate | AccessAuthorizationUpdate | |

Return type

AccessAuthorizationResponse

Authorization

OAuth2PasswordBearer

HTTP request headers

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

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

DeleteAccessauthAaAaIdDelete

interface{} DeleteAccessauthAaAaIdDelete(ctx, aaId).Execute()

Delete Accessauth

Example

package main

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

func main() {
	aaId := int32(56) // int32 | 

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

Path Parameters

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

Other Parameters

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

Name Type Description Notes

Return type

interface{}

Authorization

OAuth2PasswordBearer

HTTP request headers

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

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

GetAllAccessauthsAaGet

[]AccessAuthorizationResponse GetAllAccessauthsAaGet(ctx).Execute()

Get All Accessauths

Example

package main

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

func main() {

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

Path Parameters

This endpoint does not need any parameter.

Other Parameters

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

Return type

[]AccessAuthorizationResponse

Authorization

OAuth2PasswordBearer

HTTP request headers

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

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

GetOneAccessauthAaAaIdGet

AccessAuthorizationResponse GetOneAccessauthAaAaIdGet(ctx, aaId).Execute()

Get One Accessauth

Example

package main

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

func main() {
	aaId := int32(56) // int32 | 

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

Path Parameters

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

Other Parameters

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

Name Type Description Notes

Return type

AccessAuthorizationResponse

Authorization

OAuth2PasswordBearer

HTTP request headers

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

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

UnassignAccessauthAaUnassignGroupIdAaIdPut

GroupResponse UnassignAccessauthAaUnassignGroupIdAaIdPut(ctx, groupId, aaId).Execute()

Unassign Accessauth

Example

package main

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

func main() {
	groupId := int32(56) // int32 | 
	aaId := int32(56) // int32 | 

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
groupId int32
aaId int32

Other Parameters

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

Name Type Description Notes

Return type

GroupResponse

Authorization

OAuth2PasswordBearer

HTTP request headers

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

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