Files
portal/openapi/docs/AccessAuthAPI.md
2026-06-25 11:26:20 +02:00

14 KiB

\AccessAuthAPI

All URIs are relative to http://localhost

Method HTTP request Description
AddAccessauthApiV1AaPost Post /api/v1/aa/ Add Accessauth
AssignAccessauthApiV1AaAssignGroupIdAaIdPut Put /api/v1/aa/assign/{group_id}/{aa_id} Assign Accessauth
ChangeAccessauthApiV1AaAaIdPatch Patch /api/v1/aa/{aa_id} Change Accessauth
DeleteAccessauthApiV1AaAaIdDelete Delete /api/v1/aa/{aa_id} Delete Accessauth
GetAllAccessauthsApiV1AaGet Get /api/v1/aa/ Get All Accessauths
GetOneAccessauthApiV1AaAaIdGet Get /api/v1/aa/{aa_id} Get One Accessauth
UnassignAccessauthApiV1AaUnassignGroupIdAaIdPut Put /api/v1/aa/unassign/{group_id}/{aa_id} Unassign Accessauth

AddAccessauthApiV1AaPost

AccessAuthorizationResponse AddAccessauthApiV1AaPost(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.AddAccessauthApiV1AaPost(context.Background()).AccessAuthorizationCreate(accessAuthorizationCreate).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `AccessAuthAPI.AddAccessauthApiV1AaPost``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `AddAccessauthApiV1AaPost`: AccessAuthorizationResponse
	fmt.Fprintf(os.Stdout, "Response from `AccessAuthAPI.AddAccessauthApiV1AaPost`: %v\n", resp)
}

Path Parameters

Other Parameters

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

AssignAccessauthApiV1AaAssignGroupIdAaIdPut

GroupResponse AssignAccessauthApiV1AaAssignGroupIdAaIdPut(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.AssignAccessauthApiV1AaAssignGroupIdAaIdPut(context.Background(), groupId, aaId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `AccessAuthAPI.AssignAccessauthApiV1AaAssignGroupIdAaIdPut``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `AssignAccessauthApiV1AaAssignGroupIdAaIdPut`: GroupResponse
	fmt.Fprintf(os.Stdout, "Response from `AccessAuthAPI.AssignAccessauthApiV1AaAssignGroupIdAaIdPut`: %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 apiAssignAccessauthApiV1AaAssignGroupIdAaIdPutRequest 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]

ChangeAccessauthApiV1AaAaIdPatch

AccessAuthorizationResponse ChangeAccessauthApiV1AaAaIdPatch(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.ChangeAccessauthApiV1AaAaIdPatch(context.Background(), aaId).AccessAuthorizationUpdate(accessAuthorizationUpdate).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `AccessAuthAPI.ChangeAccessauthApiV1AaAaIdPatch``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `ChangeAccessauthApiV1AaAaIdPatch`: AccessAuthorizationResponse
	fmt.Fprintf(os.Stdout, "Response from `AccessAuthAPI.ChangeAccessauthApiV1AaAaIdPatch`: %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 apiChangeAccessauthApiV1AaAaIdPatchRequest 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]

DeleteAccessauthApiV1AaAaIdDelete

interface{} DeleteAccessauthApiV1AaAaIdDelete(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.DeleteAccessauthApiV1AaAaIdDelete(context.Background(), aaId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `AccessAuthAPI.DeleteAccessauthApiV1AaAaIdDelete``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `DeleteAccessauthApiV1AaAaIdDelete`: interface{}
	fmt.Fprintf(os.Stdout, "Response from `AccessAuthAPI.DeleteAccessauthApiV1AaAaIdDelete`: %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 apiDeleteAccessauthApiV1AaAaIdDeleteRequest 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]

GetAllAccessauthsApiV1AaGet

[]AccessAuthorizationResponse GetAllAccessauthsApiV1AaGet(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.GetAllAccessauthsApiV1AaGet(context.Background()).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `AccessAuthAPI.GetAllAccessauthsApiV1AaGet``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetAllAccessauthsApiV1AaGet`: []AccessAuthorizationResponse
	fmt.Fprintf(os.Stdout, "Response from `AccessAuthAPI.GetAllAccessauthsApiV1AaGet`: %v\n", resp)
}

Path Parameters

This endpoint does not need any parameter.

Other Parameters

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

GetOneAccessauthApiV1AaAaIdGet

AccessAuthorizationResponse GetOneAccessauthApiV1AaAaIdGet(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.GetOneAccessauthApiV1AaAaIdGet(context.Background(), aaId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `AccessAuthAPI.GetOneAccessauthApiV1AaAaIdGet``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetOneAccessauthApiV1AaAaIdGet`: AccessAuthorizationResponse
	fmt.Fprintf(os.Stdout, "Response from `AccessAuthAPI.GetOneAccessauthApiV1AaAaIdGet`: %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 apiGetOneAccessauthApiV1AaAaIdGetRequest 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]

UnassignAccessauthApiV1AaUnassignGroupIdAaIdPut

GroupResponse UnassignAccessauthApiV1AaUnassignGroupIdAaIdPut(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.UnassignAccessauthApiV1AaUnassignGroupIdAaIdPut(context.Background(), groupId, aaId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `AccessAuthAPI.UnassignAccessauthApiV1AaUnassignGroupIdAaIdPut``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `UnassignAccessauthApiV1AaUnassignGroupIdAaIdPut`: GroupResponse
	fmt.Fprintf(os.Stdout, "Response from `AccessAuthAPI.UnassignAccessauthApiV1AaUnassignGroupIdAaIdPut`: %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 apiUnassignAccessauthApiV1AaUnassignGroupIdAaIdPutRequest 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]