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

487 lines
14 KiB
Markdown

# \AccessAuthAPI
All URIs are relative to *http://localhost*
Method | HTTP request | Description
------------- | ------------- | -------------
[**AddAccessauthAaPost**](AccessAuthAPI.md#AddAccessauthAaPost) | **Post** /aa/ | Add Accessauth
[**AssignAccessauthAaAssignGroupIdAaIdPut**](AccessAuthAPI.md#AssignAccessauthAaAssignGroupIdAaIdPut) | **Put** /aa/assign/{group_id}/{aa_id} | Assign Accessauth
[**ChangeAccessauthAaAaIdPatch**](AccessAuthAPI.md#ChangeAccessauthAaAaIdPatch) | **Patch** /aa/{aa_id} | Change Accessauth
[**DeleteAccessauthAaAaIdDelete**](AccessAuthAPI.md#DeleteAccessauthAaAaIdDelete) | **Delete** /aa/{aa_id} | Delete Accessauth
[**GetAllAccessauthsAaGet**](AccessAuthAPI.md#GetAllAccessauthsAaGet) | **Get** /aa/ | Get All Accessauths
[**GetOneAccessauthAaAaIdGet**](AccessAuthAPI.md#GetOneAccessauthAaAaIdGet) | **Get** /aa/{aa_id} | Get One Accessauth
[**UnassignAccessauthAaUnassignGroupIdAaIdPut**](AccessAuthAPI.md#UnassignAccessauthAaUnassignGroupIdAaIdPut) | **Put** /aa/unassign/{group_id}/{aa_id} | Unassign Accessauth
## AddAccessauthAaPost
> AccessAuthorizationResponse AddAccessauthAaPost(ctx).AccessAuthorizationCreate(accessAuthorizationCreate).Execute()
Add Accessauth
### Example
```go
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**](AccessAuthorizationCreate.md) | |
### Return type
[**AccessAuthorizationResponse**](AccessAuthorizationResponse.md)
### Authorization
[OAuth2PasswordBearer](../README.md#OAuth2PasswordBearer)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
[[Back to Model list]](../README.md#documentation-for-models)
[[Back to README]](../README.md)
## AssignAccessauthAaAssignGroupIdAaIdPut
> GroupResponse AssignAccessauthAaAssignGroupIdAaIdPut(ctx, groupId, aaId).Execute()
Assign Accessauth
### Example
```go
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**](GroupResponse.md)
### Authorization
[OAuth2PasswordBearer](../README.md#OAuth2PasswordBearer)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
[[Back to Model list]](../README.md#documentation-for-models)
[[Back to README]](../README.md)
## ChangeAccessauthAaAaIdPatch
> AccessAuthorizationResponse ChangeAccessauthAaAaIdPatch(ctx, aaId).AccessAuthorizationUpdate(accessAuthorizationUpdate).Execute()
Change Accessauth
### Example
```go
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**](AccessAuthorizationUpdate.md) | |
### Return type
[**AccessAuthorizationResponse**](AccessAuthorizationResponse.md)
### Authorization
[OAuth2PasswordBearer](../README.md#OAuth2PasswordBearer)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
[[Back to Model list]](../README.md#documentation-for-models)
[[Back to README]](../README.md)
## DeleteAccessauthAaAaIdDelete
> interface{} DeleteAccessauthAaAaIdDelete(ctx, aaId).Execute()
Delete Accessauth
### Example
```go
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](../README.md#OAuth2PasswordBearer)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
[[Back to Model list]](../README.md#documentation-for-models)
[[Back to README]](../README.md)
## GetAllAccessauthsAaGet
> []AccessAuthorizationResponse GetAllAccessauthsAaGet(ctx).Execute()
Get All Accessauths
### Example
```go
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**](AccessAuthorizationResponse.md)
### Authorization
[OAuth2PasswordBearer](../README.md#OAuth2PasswordBearer)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
[[Back to Model list]](../README.md#documentation-for-models)
[[Back to README]](../README.md)
## GetOneAccessauthAaAaIdGet
> AccessAuthorizationResponse GetOneAccessauthAaAaIdGet(ctx, aaId).Execute()
Get One Accessauth
### Example
```go
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**](AccessAuthorizationResponse.md)
### Authorization
[OAuth2PasswordBearer](../README.md#OAuth2PasswordBearer)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
[[Back to Model list]](../README.md#documentation-for-models)
[[Back to README]](../README.md)
## UnassignAccessauthAaUnassignGroupIdAaIdPut
> GroupResponse UnassignAccessauthAaUnassignGroupIdAaIdPut(ctx, groupId, aaId).Execute()
Unassign Accessauth
### Example
```go
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**](GroupResponse.md)
### Authorization
[OAuth2PasswordBearer](../README.md#OAuth2PasswordBearer)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
[[Back to Model list]](../README.md#documentation-for-models)
[[Back to README]](../README.md)