Skip to content

Latest commit

 

History

History
4482 lines (2828 loc) · 123 KB

CoreApi.md

File metadata and controls

4482 lines (2828 loc) · 123 KB

\CoreApi

All URIs are relative to http://localhost/api/v3

Method HTTP request Description
CoreApplicationsCheckAccessRetrieve Get /core/applications/{slug}/check_access/
CoreApplicationsCreate Post /core/applications/
CoreApplicationsDestroy Delete /core/applications/{slug}/
CoreApplicationsList Get /core/applications/
CoreApplicationsMetricsList Get /core/applications/{slug}/metrics/
CoreApplicationsPartialUpdate Patch /core/applications/{slug}/
CoreApplicationsRetrieve Get /core/applications/{slug}/
CoreApplicationsSetIconCreate Post /core/applications/{slug}/set_icon/
CoreApplicationsSetIconUrlCreate Post /core/applications/{slug}/set_icon_url/
CoreApplicationsUpdate Put /core/applications/{slug}/
CoreApplicationsUsedByList Get /core/applications/{slug}/used_by/
CoreAuthenticatedSessionsDestroy Delete /core/authenticated_sessions/{uuid}/
CoreAuthenticatedSessionsList Get /core/authenticated_sessions/
CoreAuthenticatedSessionsRetrieve Get /core/authenticated_sessions/{uuid}/
CoreAuthenticatedSessionsUsedByList Get /core/authenticated_sessions/{uuid}/used_by/
CoreBrandsCreate Post /core/brands/
CoreBrandsCurrentRetrieve Get /core/brands/current/
CoreBrandsDestroy Delete /core/brands/{brand_uuid}/
CoreBrandsList Get /core/brands/
CoreBrandsPartialUpdate Patch /core/brands/{brand_uuid}/
CoreBrandsRetrieve Get /core/brands/{brand_uuid}/
CoreBrandsUpdate Put /core/brands/{brand_uuid}/
CoreBrandsUsedByList Get /core/brands/{brand_uuid}/used_by/
CoreGroupsAddUserCreate Post /core/groups/{group_uuid}/add_user/
CoreGroupsCreate Post /core/groups/
CoreGroupsDestroy Delete /core/groups/{group_uuid}/
CoreGroupsList Get /core/groups/
CoreGroupsPartialUpdate Patch /core/groups/{group_uuid}/
CoreGroupsRemoveUserCreate Post /core/groups/{group_uuid}/remove_user/
CoreGroupsRetrieve Get /core/groups/{group_uuid}/
CoreGroupsUpdate Put /core/groups/{group_uuid}/
CoreGroupsUsedByList Get /core/groups/{group_uuid}/used_by/
CoreTokensCreate Post /core/tokens/
CoreTokensDestroy Delete /core/tokens/{identifier}/
CoreTokensList Get /core/tokens/
CoreTokensPartialUpdate Patch /core/tokens/{identifier}/
CoreTokensRetrieve Get /core/tokens/{identifier}/
CoreTokensSetKeyCreate Post /core/tokens/{identifier}/set_key/
CoreTokensUpdate Put /core/tokens/{identifier}/
CoreTokensUsedByList Get /core/tokens/{identifier}/used_by/
CoreTokensViewKeyRetrieve Get /core/tokens/{identifier}/view_key/
CoreTransactionalApplicationsUpdate Put /core/transactional/applications/
CoreUserConsentDestroy Delete /core/user_consent/{id}/
CoreUserConsentList Get /core/user_consent/
CoreUserConsentRetrieve Get /core/user_consent/{id}/
CoreUserConsentUsedByList Get /core/user_consent/{id}/used_by/
CoreUsersCreate Post /core/users/
CoreUsersDestroy Delete /core/users/{id}/
CoreUsersImpersonateCreate Post /core/users/{id}/impersonate/
CoreUsersImpersonateEndRetrieve Get /core/users/impersonate_end/
CoreUsersList Get /core/users/
CoreUsersMeRetrieve Get /core/users/me/
CoreUsersMetricsRetrieve Get /core/users/{id}/metrics/
CoreUsersPartialUpdate Patch /core/users/{id}/
CoreUsersPathsRetrieve Get /core/users/paths/
CoreUsersRecoveryCreate Post /core/users/{id}/recovery/
CoreUsersRecoveryEmailCreate Post /core/users/{id}/recovery_email/
CoreUsersRetrieve Get /core/users/{id}/
CoreUsersServiceAccountCreate Post /core/users/service_account/
CoreUsersSetPasswordCreate Post /core/users/{id}/set_password/
CoreUsersUpdate Put /core/users/{id}/
CoreUsersUsedByList Get /core/users/{id}/used_by/

CoreApplicationsCheckAccessRetrieve

PolicyTestResult CoreApplicationsCheckAccessRetrieve(ctx, slug).ForUser(forUser).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    slug := "slug_example" // string | 
    forUser := int32(56) // int32 |  (optional)

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

Path Parameters

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

Other Parameters

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

Name Type Description Notes

forUser | int32 | |

Return type

PolicyTestResult

Authorization

authentik

HTTP request headers

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

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

CoreApplicationsCreate

Application CoreApplicationsCreate(ctx).ApplicationRequest(applicationRequest).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    applicationRequest := *openapiclient.NewApplicationRequest("Name_example", "Slug_example") // ApplicationRequest | 

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

Path Parameters

Other Parameters

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

Name Type Description Notes
applicationRequest ApplicationRequest

Return type

Application

Authorization

authentik

HTTP request headers

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

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

CoreApplicationsDestroy

CoreApplicationsDestroy(ctx, slug).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    slug := "slug_example" // string | 

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

Other Parameters

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

Name Type Description Notes

Return type

(empty response body)

Authorization

authentik

HTTP request headers

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

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

CoreApplicationsList

PaginatedApplicationList CoreApplicationsList(ctx).ForUser(forUser).Group(group).MetaDescription(metaDescription).MetaLaunchUrl(metaLaunchUrl).MetaPublisher(metaPublisher).Name(name).OnlyWithLaunchUrl(onlyWithLaunchUrl).Ordering(ordering).Page(page).PageSize(pageSize).Search(search).Slug(slug).SuperuserFullList(superuserFullList).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    forUser := int32(56) // int32 |  (optional)
    group := "group_example" // string |  (optional)
    metaDescription := "metaDescription_example" // string |  (optional)
    metaLaunchUrl := "metaLaunchUrl_example" // string |  (optional)
    metaPublisher := "metaPublisher_example" // string |  (optional)
    name := "name_example" // string |  (optional)
    onlyWithLaunchUrl := true // bool |  (optional)
    ordering := "ordering_example" // string | Which field to use when ordering the results. (optional)
    page := int32(56) // int32 | A page number within the paginated result set. (optional)
    pageSize := int32(56) // int32 | Number of results to return per page. (optional)
    search := "search_example" // string | A search term. (optional)
    slug := "slug_example" // string |  (optional)
    superuserFullList := true // bool |  (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.CoreApi.CoreApplicationsList(context.Background()).ForUser(forUser).Group(group).MetaDescription(metaDescription).MetaLaunchUrl(metaLaunchUrl).MetaPublisher(metaPublisher).Name(name).OnlyWithLaunchUrl(onlyWithLaunchUrl).Ordering(ordering).Page(page).PageSize(pageSize).Search(search).Slug(slug).SuperuserFullList(superuserFullList).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `CoreApi.CoreApplicationsList``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `CoreApplicationsList`: PaginatedApplicationList
    fmt.Fprintf(os.Stdout, "Response from `CoreApi.CoreApplicationsList`: %v\n", resp)
}

Path Parameters

Other Parameters

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

Name Type Description Notes
forUser int32
group string
metaDescription string
metaLaunchUrl string
metaPublisher string
name string
onlyWithLaunchUrl bool
ordering string Which field to use when ordering the results.
page int32 A page number within the paginated result set.
pageSize int32 Number of results to return per page.
search string A search term.
slug string
superuserFullList bool

Return type

PaginatedApplicationList

Authorization

authentik

HTTP request headers

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

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

CoreApplicationsMetricsList

[]Coordinate CoreApplicationsMetricsList(ctx, slug).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    slug := "slug_example" // string | 

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

Path Parameters

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

Other Parameters

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

Name Type Description Notes

Return type

[]Coordinate

Authorization

authentik

HTTP request headers

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

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

CoreApplicationsPartialUpdate

Application CoreApplicationsPartialUpdate(ctx, slug).PatchedApplicationRequest(patchedApplicationRequest).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    slug := "slug_example" // string | 
    patchedApplicationRequest := *openapiclient.NewPatchedApplicationRequest() // PatchedApplicationRequest |  (optional)

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

Path Parameters

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

Other Parameters

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

Name Type Description Notes

patchedApplicationRequest | PatchedApplicationRequest | |

Return type

Application

Authorization

authentik

HTTP request headers

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

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

CoreApplicationsRetrieve

Application CoreApplicationsRetrieve(ctx, slug).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    slug := "slug_example" // string | 

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

Path Parameters

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

Other Parameters

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

Name Type Description Notes

Return type

Application

Authorization

authentik

HTTP request headers

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

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

CoreApplicationsSetIconCreate

CoreApplicationsSetIconCreate(ctx, slug).File(file).Clear(clear).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    slug := "slug_example" // string | 
    file := os.NewFile(1234, "some_file") // *os.File |  (optional)
    clear := true // bool |  (optional) (default to false)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.CoreApi.CoreApplicationsSetIconCreate(context.Background(), slug).File(file).Clear(clear).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `CoreApi.CoreApplicationsSetIconCreate``: %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.
slug string

Other Parameters

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

Name Type Description Notes

file | *os.File | | clear | bool | | [default to false]

Return type

(empty response body)

Authorization

authentik

HTTP request headers

  • Content-Type: multipart/form-data
  • Accept: application/json

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

CoreApplicationsSetIconUrlCreate

CoreApplicationsSetIconUrlCreate(ctx, slug).FilePathRequest(filePathRequest).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    slug := "slug_example" // string | 
    filePathRequest := *openapiclient.NewFilePathRequest("Url_example") // FilePathRequest | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.CoreApi.CoreApplicationsSetIconUrlCreate(context.Background(), slug).FilePathRequest(filePathRequest).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `CoreApi.CoreApplicationsSetIconUrlCreate``: %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.
slug string

Other Parameters

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

Name Type Description Notes

filePathRequest | FilePathRequest | |

Return type

(empty response body)

Authorization

authentik

HTTP request headers

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

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

CoreApplicationsUpdate

Application CoreApplicationsUpdate(ctx, slug).ApplicationRequest(applicationRequest).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    slug := "slug_example" // string | 
    applicationRequest := *openapiclient.NewApplicationRequest("Name_example", "Slug_example") // ApplicationRequest | 

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

Path Parameters

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

Other Parameters

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

Name Type Description Notes

applicationRequest | ApplicationRequest | |

Return type

Application

Authorization

authentik

HTTP request headers

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

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

CoreApplicationsUsedByList

[]UsedBy CoreApplicationsUsedByList(ctx, slug).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    slug := "slug_example" // string | 

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

Path Parameters

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

Other Parameters

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

Name Type Description Notes

Return type

[]UsedBy

Authorization

authentik

HTTP request headers

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

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

CoreAuthenticatedSessionsDestroy

CoreAuthenticatedSessionsDestroy(ctx, uuid).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    uuid := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | A UUID string identifying this Authenticated Session.

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.CoreApi.CoreAuthenticatedSessionsDestroy(context.Background(), uuid).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `CoreApi.CoreAuthenticatedSessionsDestroy``: %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.
uuid string A UUID string identifying this Authenticated Session.

Other Parameters

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

Name Type Description Notes

Return type

(empty response body)

Authorization

authentik

HTTP request headers

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

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

CoreAuthenticatedSessionsList

PaginatedAuthenticatedSessionList CoreAuthenticatedSessionsList(ctx).LastIp(lastIp).LastUserAgent(lastUserAgent).Ordering(ordering).Page(page).PageSize(pageSize).Search(search).UserUsername(userUsername).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    lastIp := "lastIp_example" // string |  (optional)
    lastUserAgent := "lastUserAgent_example" // string |  (optional)
    ordering := "ordering_example" // string | Which field to use when ordering the results. (optional)
    page := int32(56) // int32 | A page number within the paginated result set. (optional)
    pageSize := int32(56) // int32 | Number of results to return per page. (optional)
    search := "search_example" // string | A search term. (optional)
    userUsername := "userUsername_example" // string |  (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.CoreApi.CoreAuthenticatedSessionsList(context.Background()).LastIp(lastIp).LastUserAgent(lastUserAgent).Ordering(ordering).Page(page).PageSize(pageSize).Search(search).UserUsername(userUsername).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `CoreApi.CoreAuthenticatedSessionsList``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `CoreAuthenticatedSessionsList`: PaginatedAuthenticatedSessionList
    fmt.Fprintf(os.Stdout, "Response from `CoreApi.CoreAuthenticatedSessionsList`: %v\n", resp)
}

Path Parameters

Other Parameters

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

Name Type Description Notes
lastIp string
lastUserAgent string
ordering string Which field to use when ordering the results.
page int32 A page number within the paginated result set.
pageSize int32 Number of results to return per page.
search string A search term.
userUsername string

Return type

PaginatedAuthenticatedSessionList

Authorization

authentik

HTTP request headers

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

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

CoreAuthenticatedSessionsRetrieve

AuthenticatedSession CoreAuthenticatedSessionsRetrieve(ctx, uuid).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    uuid := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | A UUID string identifying this Authenticated Session.

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
uuid string A UUID string identifying this Authenticated Session.

Other Parameters

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

Name Type Description Notes

Return type

AuthenticatedSession

Authorization

authentik

HTTP request headers

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

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

CoreAuthenticatedSessionsUsedByList

[]UsedBy CoreAuthenticatedSessionsUsedByList(ctx, uuid).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    uuid := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | A UUID string identifying this Authenticated Session.

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
uuid string A UUID string identifying this Authenticated Session.

Other Parameters

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

Name Type Description Notes

Return type

[]UsedBy

Authorization

authentik

HTTP request headers

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

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

CoreBrandsCreate

Brand CoreBrandsCreate(ctx).BrandRequest(brandRequest).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    brandRequest := *openapiclient.NewBrandRequest("Domain_example") // BrandRequest | 

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

Path Parameters

Other Parameters

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

Name Type Description Notes
brandRequest BrandRequest

Return type

Brand

Authorization

authentik

HTTP request headers

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

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

CoreBrandsCurrentRetrieve

CurrentBrand CoreBrandsCurrentRetrieve(ctx).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {

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

Path Parameters

This endpoint does not need any parameter.

Other Parameters

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

Return type

CurrentBrand

Authorization

authentik

HTTP request headers

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

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

CoreBrandsDestroy

CoreBrandsDestroy(ctx, brandUuid).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    brandUuid := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | A UUID string identifying this Brand.

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.CoreApi.CoreBrandsDestroy(context.Background(), brandUuid).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `CoreApi.CoreBrandsDestroy``: %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.
brandUuid string A UUID string identifying this Brand.

Other Parameters

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

Name Type Description Notes

Return type

(empty response body)

Authorization

authentik

HTTP request headers

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

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

CoreBrandsList

PaginatedBrandList CoreBrandsList(ctx).BrandUuid(brandUuid).BrandingFavicon(brandingFavicon).BrandingLogo(brandingLogo).BrandingTitle(brandingTitle).Default_(default_).Domain(domain).FlowAuthentication(flowAuthentication).FlowDeviceCode(flowDeviceCode).FlowInvalidation(flowInvalidation).FlowRecovery(flowRecovery).FlowUnenrollment(flowUnenrollment).FlowUserSettings(flowUserSettings).Ordering(ordering).Page(page).PageSize(pageSize).Search(search).WebCertificate(webCertificate).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    brandUuid := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string |  (optional)
    brandingFavicon := "brandingFavicon_example" // string |  (optional)
    brandingLogo := "brandingLogo_example" // string |  (optional)
    brandingTitle := "brandingTitle_example" // string |  (optional)
    default_ := true // bool |  (optional)
    domain := "domain_example" // string |  (optional)
    flowAuthentication := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string |  (optional)
    flowDeviceCode := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string |  (optional)
    flowInvalidation := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string |  (optional)
    flowRecovery := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string |  (optional)
    flowUnenrollment := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string |  (optional)
    flowUserSettings := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string |  (optional)
    ordering := "ordering_example" // string | Which field to use when ordering the results. (optional)
    page := int32(56) // int32 | A page number within the paginated result set. (optional)
    pageSize := int32(56) // int32 | Number of results to return per page. (optional)
    search := "search_example" // string | A search term. (optional)
    webCertificate := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string |  (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.CoreApi.CoreBrandsList(context.Background()).BrandUuid(brandUuid).BrandingFavicon(brandingFavicon).BrandingLogo(brandingLogo).BrandingTitle(brandingTitle).Default_(default_).Domain(domain).FlowAuthentication(flowAuthentication).FlowDeviceCode(flowDeviceCode).FlowInvalidation(flowInvalidation).FlowRecovery(flowRecovery).FlowUnenrollment(flowUnenrollment).FlowUserSettings(flowUserSettings).Ordering(ordering).Page(page).PageSize(pageSize).Search(search).WebCertificate(webCertificate).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `CoreApi.CoreBrandsList``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `CoreBrandsList`: PaginatedBrandList
    fmt.Fprintf(os.Stdout, "Response from `CoreApi.CoreBrandsList`: %v\n", resp)
}

Path Parameters

Other Parameters

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

Name Type Description Notes
brandUuid string
brandingFavicon string
brandingLogo string
brandingTitle string
default_ bool
domain string
flowAuthentication string
flowDeviceCode string
flowInvalidation string
flowRecovery string
flowUnenrollment string
flowUserSettings string
ordering string Which field to use when ordering the results.
page int32 A page number within the paginated result set.
pageSize int32 Number of results to return per page.
search string A search term.
webCertificate string

Return type

PaginatedBrandList

Authorization

authentik

HTTP request headers

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

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

CoreBrandsPartialUpdate

Brand CoreBrandsPartialUpdate(ctx, brandUuid).PatchedBrandRequest(patchedBrandRequest).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    brandUuid := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | A UUID string identifying this Brand.
    patchedBrandRequest := *openapiclient.NewPatchedBrandRequest() // PatchedBrandRequest |  (optional)

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
brandUuid string A UUID string identifying this Brand.

Other Parameters

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

Name Type Description Notes

patchedBrandRequest | PatchedBrandRequest | |

Return type

Brand

Authorization

authentik

HTTP request headers

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

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

CoreBrandsRetrieve

Brand CoreBrandsRetrieve(ctx, brandUuid).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    brandUuid := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | A UUID string identifying this Brand.

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
brandUuid string A UUID string identifying this Brand.

Other Parameters

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

Name Type Description Notes

Return type

Brand

Authorization

authentik

HTTP request headers

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

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

CoreBrandsUpdate

Brand CoreBrandsUpdate(ctx, brandUuid).BrandRequest(brandRequest).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    brandUuid := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | A UUID string identifying this Brand.
    brandRequest := *openapiclient.NewBrandRequest("Domain_example") // BrandRequest | 

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
brandUuid string A UUID string identifying this Brand.

Other Parameters

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

Name Type Description Notes

brandRequest | BrandRequest | |

Return type

Brand

Authorization

authentik

HTTP request headers

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

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

CoreBrandsUsedByList

[]UsedBy CoreBrandsUsedByList(ctx, brandUuid).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    brandUuid := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | A UUID string identifying this Brand.

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
brandUuid string A UUID string identifying this Brand.

Other Parameters

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

Name Type Description Notes

Return type

[]UsedBy

Authorization

authentik

HTTP request headers

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

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

CoreGroupsAddUserCreate

CoreGroupsAddUserCreate(ctx, groupUuid).UserAccountRequest(userAccountRequest).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    groupUuid := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | A UUID string identifying this Group.
    userAccountRequest := *openapiclient.NewUserAccountRequest(int32(123)) // UserAccountRequest | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.CoreApi.CoreGroupsAddUserCreate(context.Background(), groupUuid).UserAccountRequest(userAccountRequest).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `CoreApi.CoreGroupsAddUserCreate``: %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.
groupUuid string A UUID string identifying this Group.

Other Parameters

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

Name Type Description Notes

userAccountRequest | UserAccountRequest | |

Return type

(empty response body)

Authorization

authentik

HTTP request headers

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

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

CoreGroupsCreate

Group CoreGroupsCreate(ctx).GroupRequest(groupRequest).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    groupRequest := *openapiclient.NewGroupRequest("Name_example") // GroupRequest | 

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

Path Parameters

Other Parameters

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

Name Type Description Notes
groupRequest GroupRequest

Return type

Group

Authorization

authentik

HTTP request headers

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

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

CoreGroupsDestroy

CoreGroupsDestroy(ctx, groupUuid).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    groupUuid := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | A UUID string identifying this Group.

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.CoreApi.CoreGroupsDestroy(context.Background(), groupUuid).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `CoreApi.CoreGroupsDestroy``: %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.
groupUuid string A UUID string identifying this Group.

Other Parameters

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

Name Type Description Notes

Return type

(empty response body)

Authorization

authentik

HTTP request headers

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

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

CoreGroupsList

PaginatedGroupList CoreGroupsList(ctx).Attributes(attributes).IncludeUsers(includeUsers).IsSuperuser(isSuperuser).MembersByPk(membersByPk).MembersByUsername(membersByUsername).Name(name).Ordering(ordering).Page(page).PageSize(pageSize).Search(search).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    attributes := "attributes_example" // string | Attributes (optional)
    includeUsers := true // bool |  (optional) (default to true)
    isSuperuser := true // bool |  (optional)
    membersByPk := []int32{int32(123)} // []int32 |  (optional)
    membersByUsername := []string{"Inner_example"} // []string | Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (optional)
    name := "name_example" // string |  (optional)
    ordering := "ordering_example" // string | Which field to use when ordering the results. (optional)
    page := int32(56) // int32 | A page number within the paginated result set. (optional)
    pageSize := int32(56) // int32 | Number of results to return per page. (optional)
    search := "search_example" // string | A search term. (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.CoreApi.CoreGroupsList(context.Background()).Attributes(attributes).IncludeUsers(includeUsers).IsSuperuser(isSuperuser).MembersByPk(membersByPk).MembersByUsername(membersByUsername).Name(name).Ordering(ordering).Page(page).PageSize(pageSize).Search(search).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `CoreApi.CoreGroupsList``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `CoreGroupsList`: PaginatedGroupList
    fmt.Fprintf(os.Stdout, "Response from `CoreApi.CoreGroupsList`: %v\n", resp)
}

Path Parameters

Other Parameters

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

Name Type Description Notes
attributes string Attributes
includeUsers bool [default to true]
isSuperuser bool
membersByPk []int32
membersByUsername []string Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.
name string
ordering string Which field to use when ordering the results.
page int32 A page number within the paginated result set.
pageSize int32 Number of results to return per page.
search string A search term.

Return type

PaginatedGroupList

Authorization

authentik

HTTP request headers

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

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

CoreGroupsPartialUpdate

Group CoreGroupsPartialUpdate(ctx, groupUuid).PatchedGroupRequest(patchedGroupRequest).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    groupUuid := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | A UUID string identifying this Group.
    patchedGroupRequest := *openapiclient.NewPatchedGroupRequest() // PatchedGroupRequest |  (optional)

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
groupUuid string A UUID string identifying this Group.

Other Parameters

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

Name Type Description Notes

patchedGroupRequest | PatchedGroupRequest | |

Return type

Group

Authorization

authentik

HTTP request headers

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

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

CoreGroupsRemoveUserCreate

CoreGroupsRemoveUserCreate(ctx, groupUuid).UserAccountRequest(userAccountRequest).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    groupUuid := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | A UUID string identifying this Group.
    userAccountRequest := *openapiclient.NewUserAccountRequest(int32(123)) // UserAccountRequest | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.CoreApi.CoreGroupsRemoveUserCreate(context.Background(), groupUuid).UserAccountRequest(userAccountRequest).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `CoreApi.CoreGroupsRemoveUserCreate``: %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.
groupUuid string A UUID string identifying this Group.

Other Parameters

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

Name Type Description Notes

userAccountRequest | UserAccountRequest | |

Return type

(empty response body)

Authorization

authentik

HTTP request headers

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

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

CoreGroupsRetrieve

Group CoreGroupsRetrieve(ctx, groupUuid).IncludeUsers(includeUsers).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    groupUuid := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | A UUID string identifying this Group.
    includeUsers := true // bool |  (optional) (default to true)

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
groupUuid string A UUID string identifying this Group.

Other Parameters

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

Name Type Description Notes

includeUsers | bool | | [default to true]

Return type

Group

Authorization

authentik

HTTP request headers

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

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

CoreGroupsUpdate

Group CoreGroupsUpdate(ctx, groupUuid).GroupRequest(groupRequest).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    groupUuid := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | A UUID string identifying this Group.
    groupRequest := *openapiclient.NewGroupRequest("Name_example") // GroupRequest | 

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
groupUuid string A UUID string identifying this Group.

Other Parameters

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

Name Type Description Notes

groupRequest | GroupRequest | |

Return type

Group

Authorization

authentik

HTTP request headers

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

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

CoreGroupsUsedByList

[]UsedBy CoreGroupsUsedByList(ctx, groupUuid).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    groupUuid := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | A UUID string identifying this Group.

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
groupUuid string A UUID string identifying this Group.

Other Parameters

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

Name Type Description Notes

Return type

[]UsedBy

Authorization

authentik

HTTP request headers

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

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

CoreTokensCreate

Token CoreTokensCreate(ctx).TokenRequest(tokenRequest).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    tokenRequest := *openapiclient.NewTokenRequest("Identifier_example") // TokenRequest | 

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

Path Parameters

Other Parameters

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

Name Type Description Notes
tokenRequest TokenRequest

Return type

Token

Authorization

authentik

HTTP request headers

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

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

CoreTokensDestroy

CoreTokensDestroy(ctx, identifier).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    identifier := "identifier_example" // string | 

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

Other Parameters

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

Name Type Description Notes

Return type

(empty response body)

Authorization

authentik

HTTP request headers

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

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

CoreTokensList

PaginatedTokenList CoreTokensList(ctx).Description(description).Expires(expires).Expiring(expiring).Identifier(identifier).Intent(intent).Managed(managed).Ordering(ordering).Page(page).PageSize(pageSize).Search(search).UserUsername(userUsername).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    "time"
    openapiclient "./openapi"
)

func main() {
    description := "description_example" // string |  (optional)
    expires := time.Now() // time.Time |  (optional)
    expiring := true // bool |  (optional)
    identifier := "identifier_example" // string |  (optional)
    intent := "intent_example" // string |  (optional)
    managed := "managed_example" // string |  (optional)
    ordering := "ordering_example" // string | Which field to use when ordering the results. (optional)
    page := int32(56) // int32 | A page number within the paginated result set. (optional)
    pageSize := int32(56) // int32 | Number of results to return per page. (optional)
    search := "search_example" // string | A search term. (optional)
    userUsername := "userUsername_example" // string |  (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.CoreApi.CoreTokensList(context.Background()).Description(description).Expires(expires).Expiring(expiring).Identifier(identifier).Intent(intent).Managed(managed).Ordering(ordering).Page(page).PageSize(pageSize).Search(search).UserUsername(userUsername).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `CoreApi.CoreTokensList``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `CoreTokensList`: PaginatedTokenList
    fmt.Fprintf(os.Stdout, "Response from `CoreApi.CoreTokensList`: %v\n", resp)
}

Path Parameters

Other Parameters

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

Name Type Description Notes
description string
expires time.Time
expiring bool
identifier string
intent string
managed string
ordering string Which field to use when ordering the results.
page int32 A page number within the paginated result set.
pageSize int32 Number of results to return per page.
search string A search term.
userUsername string

Return type

PaginatedTokenList

Authorization

authentik

HTTP request headers

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

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

CoreTokensPartialUpdate

Token CoreTokensPartialUpdate(ctx, identifier).PatchedTokenRequest(patchedTokenRequest).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    identifier := "identifier_example" // string | 
    patchedTokenRequest := *openapiclient.NewPatchedTokenRequest() // PatchedTokenRequest |  (optional)

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

Path Parameters

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

Other Parameters

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

Name Type Description Notes

patchedTokenRequest | PatchedTokenRequest | |

Return type

Token

Authorization

authentik

HTTP request headers

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

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

CoreTokensRetrieve

Token CoreTokensRetrieve(ctx, identifier).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    identifier := "identifier_example" // string | 

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

Path Parameters

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

Other Parameters

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

Name Type Description Notes

Return type

Token

Authorization

authentik

HTTP request headers

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

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

CoreTokensSetKeyCreate

CoreTokensSetKeyCreate(ctx, identifier).TokenSetKeyRequest(tokenSetKeyRequest).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    identifier := "identifier_example" // string | 
    tokenSetKeyRequest := *openapiclient.NewTokenSetKeyRequest("Key_example") // TokenSetKeyRequest | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.CoreApi.CoreTokensSetKeyCreate(context.Background(), identifier).TokenSetKeyRequest(tokenSetKeyRequest).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `CoreApi.CoreTokensSetKeyCreate``: %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.
identifier string

Other Parameters

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

Name Type Description Notes

tokenSetKeyRequest | TokenSetKeyRequest | |

Return type

(empty response body)

Authorization

authentik

HTTP request headers

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

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

CoreTokensUpdate

Token CoreTokensUpdate(ctx, identifier).TokenRequest(tokenRequest).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    identifier := "identifier_example" // string | 
    tokenRequest := *openapiclient.NewTokenRequest("Identifier_example") // TokenRequest | 

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

Path Parameters

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

Other Parameters

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

Name Type Description Notes

tokenRequest | TokenRequest | |

Return type

Token

Authorization

authentik

HTTP request headers

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

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

CoreTokensUsedByList

[]UsedBy CoreTokensUsedByList(ctx, identifier).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    identifier := "identifier_example" // string | 

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

Path Parameters

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

Other Parameters

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

Name Type Description Notes

Return type

[]UsedBy

Authorization

authentik

HTTP request headers

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

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

CoreTokensViewKeyRetrieve

TokenView CoreTokensViewKeyRetrieve(ctx, identifier).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    identifier := "identifier_example" // string | 

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

Path Parameters

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

Other Parameters

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

Name Type Description Notes

Return type

TokenView

Authorization

authentik

HTTP request headers

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

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

CoreTransactionalApplicationsUpdate

TransactionApplicationResponse CoreTransactionalApplicationsUpdate(ctx).TransactionApplicationRequest(transactionApplicationRequest).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    transactionApplicationRequest := *openapiclient.NewTransactionApplicationRequest(*openapiclient.NewApplicationRequest("Name_example", "Slug_example"), openapiclient.ProviderModelEnum("authentik_providers_google_workspace.googleworkspaceprovider"), openapiclient.modelRequest{GoogleWorkspaceProviderRequest: openapiclient.NewGoogleWorkspaceProviderRequest("Name_example", "DelegatedSubject_example", interface{}(123), "DefaultGroupEmailDomain_example")}) // TransactionApplicationRequest | 

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

Path Parameters

Other Parameters

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

Name Type Description Notes
transactionApplicationRequest TransactionApplicationRequest

Return type

TransactionApplicationResponse

Authorization

authentik

HTTP request headers

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

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

CoreUserConsentDestroy

CoreUserConsentDestroy(ctx, id).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    id := int32(56) // int32 | A unique integer value identifying this User Consent.

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.CoreApi.CoreUserConsentDestroy(context.Background(), id).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `CoreApi.CoreUserConsentDestroy``: %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.
id int32 A unique integer value identifying this User Consent.

Other Parameters

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

Name Type Description Notes

Return type

(empty response body)

Authorization

authentik

HTTP request headers

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

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

CoreUserConsentList

PaginatedUserConsentList CoreUserConsentList(ctx).Application(application).Ordering(ordering).Page(page).PageSize(pageSize).Search(search).User(user).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    application := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string |  (optional)
    ordering := "ordering_example" // string | Which field to use when ordering the results. (optional)
    page := int32(56) // int32 | A page number within the paginated result set. (optional)
    pageSize := int32(56) // int32 | Number of results to return per page. (optional)
    search := "search_example" // string | A search term. (optional)
    user := int32(56) // int32 |  (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.CoreApi.CoreUserConsentList(context.Background()).Application(application).Ordering(ordering).Page(page).PageSize(pageSize).Search(search).User(user).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `CoreApi.CoreUserConsentList``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `CoreUserConsentList`: PaginatedUserConsentList
    fmt.Fprintf(os.Stdout, "Response from `CoreApi.CoreUserConsentList`: %v\n", resp)
}

Path Parameters

Other Parameters

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

Name Type Description Notes
application string
ordering string Which field to use when ordering the results.
page int32 A page number within the paginated result set.
pageSize int32 Number of results to return per page.
search string A search term.
user int32

Return type

PaginatedUserConsentList

Authorization

authentik

HTTP request headers

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

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

CoreUserConsentRetrieve

UserConsent CoreUserConsentRetrieve(ctx, id).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    id := int32(56) // int32 | A unique integer value identifying this User Consent.

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id int32 A unique integer value identifying this User Consent.

Other Parameters

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

Name Type Description Notes

Return type

UserConsent

Authorization

authentik

HTTP request headers

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

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

CoreUserConsentUsedByList

[]UsedBy CoreUserConsentUsedByList(ctx, id).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    id := int32(56) // int32 | A unique integer value identifying this User Consent.

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id int32 A unique integer value identifying this User Consent.

Other Parameters

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

Name Type Description Notes

Return type

[]UsedBy

Authorization

authentik

HTTP request headers

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

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

CoreUsersCreate

User CoreUsersCreate(ctx).UserRequest(userRequest).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    userRequest := *openapiclient.NewUserRequest("Username_example", "Name_example") // UserRequest | 

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

Path Parameters

Other Parameters

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

Name Type Description Notes
userRequest UserRequest

Return type

User

Authorization

authentik

HTTP request headers

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

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

CoreUsersDestroy

CoreUsersDestroy(ctx, id).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    id := int32(56) // int32 | A unique integer value identifying this User.

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.CoreApi.CoreUsersDestroy(context.Background(), id).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `CoreApi.CoreUsersDestroy``: %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.
id int32 A unique integer value identifying this User.

Other Parameters

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

Name Type Description Notes

Return type

(empty response body)

Authorization

authentik

HTTP request headers

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

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

CoreUsersImpersonateCreate

CoreUsersImpersonateCreate(ctx, id).ImpersonationRequest(impersonationRequest).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    id := int32(56) // int32 | A unique integer value identifying this User.
    impersonationRequest := *openapiclient.NewImpersonationRequest("Reason_example") // ImpersonationRequest | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.CoreApi.CoreUsersImpersonateCreate(context.Background(), id).ImpersonationRequest(impersonationRequest).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `CoreApi.CoreUsersImpersonateCreate``: %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.
id int32 A unique integer value identifying this User.

Other Parameters

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

Name Type Description Notes

impersonationRequest | ImpersonationRequest | |

Return type

(empty response body)

Authorization

authentik

HTTP request headers

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

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

CoreUsersImpersonateEndRetrieve

CoreUsersImpersonateEndRetrieve(ctx).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.CoreApi.CoreUsersImpersonateEndRetrieve(context.Background()).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `CoreApi.CoreUsersImpersonateEndRetrieve``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

This endpoint does not need any parameter.

Other Parameters

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

Return type

(empty response body)

Authorization

authentik

HTTP request headers

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

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

CoreUsersList

PaginatedUserList CoreUsersList(ctx).Attributes(attributes).Email(email).GroupsByName(groupsByName).GroupsByPk(groupsByPk).IncludeGroups(includeGroups).IsActive(isActive).IsSuperuser(isSuperuser).Name(name).Ordering(ordering).Page(page).PageSize(pageSize).Path(path).PathStartswith(pathStartswith).Search(search).Type_(type_).Username(username).Uuid(uuid).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    attributes := "attributes_example" // string | Attributes (optional)
    email := "email_example" // string |  (optional)
    groupsByName := []string{"Inner_example"} // []string |  (optional)
    groupsByPk := []string{"Inner_example"} // []string |  (optional)
    includeGroups := true // bool |  (optional) (default to true)
    isActive := true // bool |  (optional)
    isSuperuser := true // bool |  (optional)
    name := "name_example" // string |  (optional)
    ordering := "ordering_example" // string | Which field to use when ordering the results. (optional)
    page := int32(56) // int32 | A page number within the paginated result set. (optional)
    pageSize := int32(56) // int32 | Number of results to return per page. (optional)
    path := "path_example" // string |  (optional)
    pathStartswith := "pathStartswith_example" // string |  (optional)
    search := "search_example" // string | A search term. (optional)
    type_ := []string{"Type_example"} // []string |  (optional)
    username := "username_example" // string |  (optional)
    uuid := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string |  (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.CoreApi.CoreUsersList(context.Background()).Attributes(attributes).Email(email).GroupsByName(groupsByName).GroupsByPk(groupsByPk).IncludeGroups(includeGroups).IsActive(isActive).IsSuperuser(isSuperuser).Name(name).Ordering(ordering).Page(page).PageSize(pageSize).Path(path).PathStartswith(pathStartswith).Search(search).Type_(type_).Username(username).Uuid(uuid).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `CoreApi.CoreUsersList``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `CoreUsersList`: PaginatedUserList
    fmt.Fprintf(os.Stdout, "Response from `CoreApi.CoreUsersList`: %v\n", resp)
}

Path Parameters

Other Parameters

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

Name Type Description Notes
attributes string Attributes
email string
groupsByName []string
groupsByPk []string
includeGroups bool [default to true]
isActive bool
isSuperuser bool
name string
ordering string Which field to use when ordering the results.
page int32 A page number within the paginated result set.
pageSize int32 Number of results to return per page.
path string
pathStartswith string
search string A search term.
type_ []string
username string
uuid string

Return type

PaginatedUserList

Authorization

authentik

HTTP request headers

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

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

CoreUsersMeRetrieve

SessionUser CoreUsersMeRetrieve(ctx).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {

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

Path Parameters

This endpoint does not need any parameter.

Other Parameters

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

Return type

SessionUser

Authorization

authentik

HTTP request headers

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

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

CoreUsersMetricsRetrieve

UserMetrics CoreUsersMetricsRetrieve(ctx, id).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    id := int32(56) // int32 | A unique integer value identifying this User.

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id int32 A unique integer value identifying this User.

Other Parameters

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

Name Type Description Notes

Return type

UserMetrics

Authorization

authentik

HTTP request headers

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

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

CoreUsersPartialUpdate

User CoreUsersPartialUpdate(ctx, id).PatchedUserRequest(patchedUserRequest).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    id := int32(56) // int32 | A unique integer value identifying this User.
    patchedUserRequest := *openapiclient.NewPatchedUserRequest() // PatchedUserRequest |  (optional)

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id int32 A unique integer value identifying this User.

Other Parameters

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

Name Type Description Notes

patchedUserRequest | PatchedUserRequest | |

Return type

User

Authorization

authentik

HTTP request headers

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

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

CoreUsersPathsRetrieve

UserPath CoreUsersPathsRetrieve(ctx).Search(search).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    search := "search_example" // string |  (optional)

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

Path Parameters

Other Parameters

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

Name Type Description Notes
search string

Return type

UserPath

Authorization

authentik

HTTP request headers

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

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

CoreUsersRecoveryCreate

Link CoreUsersRecoveryCreate(ctx, id).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    id := int32(56) // int32 | A unique integer value identifying this User.

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id int32 A unique integer value identifying this User.

Other Parameters

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

Name Type Description Notes

Return type

Link

Authorization

authentik

HTTP request headers

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

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

CoreUsersRecoveryEmailCreate

CoreUsersRecoveryEmailCreate(ctx, id).EmailStage(emailStage).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    emailStage := "emailStage_example" // string | 
    id := int32(56) // int32 | A unique integer value identifying this User.

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.CoreApi.CoreUsersRecoveryEmailCreate(context.Background(), id).EmailStage(emailStage).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `CoreApi.CoreUsersRecoveryEmailCreate``: %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.
id int32 A unique integer value identifying this User.

Other Parameters

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

Name Type Description Notes
emailStage string

Return type

(empty response body)

Authorization

authentik

HTTP request headers

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

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

CoreUsersRetrieve

User CoreUsersRetrieve(ctx, id).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    id := int32(56) // int32 | A unique integer value identifying this User.

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id int32 A unique integer value identifying this User.

Other Parameters

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

Name Type Description Notes

Return type

User

Authorization

authentik

HTTP request headers

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

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

CoreUsersServiceAccountCreate

UserServiceAccountResponse CoreUsersServiceAccountCreate(ctx).UserServiceAccountRequest(userServiceAccountRequest).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    userServiceAccountRequest := *openapiclient.NewUserServiceAccountRequest("Name_example") // UserServiceAccountRequest | 

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

Path Parameters

Other Parameters

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

Name Type Description Notes
userServiceAccountRequest UserServiceAccountRequest

Return type

UserServiceAccountResponse

Authorization

authentik

HTTP request headers

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

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

CoreUsersSetPasswordCreate

CoreUsersSetPasswordCreate(ctx, id).UserPasswordSetRequest(userPasswordSetRequest).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    id := int32(56) // int32 | A unique integer value identifying this User.
    userPasswordSetRequest := *openapiclient.NewUserPasswordSetRequest("Password_example") // UserPasswordSetRequest | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.CoreApi.CoreUsersSetPasswordCreate(context.Background(), id).UserPasswordSetRequest(userPasswordSetRequest).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `CoreApi.CoreUsersSetPasswordCreate``: %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.
id int32 A unique integer value identifying this User.

Other Parameters

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

Name Type Description Notes

userPasswordSetRequest | UserPasswordSetRequest | |

Return type

(empty response body)

Authorization

authentik

HTTP request headers

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

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

CoreUsersUpdate

User CoreUsersUpdate(ctx, id).UserRequest(userRequest).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    id := int32(56) // int32 | A unique integer value identifying this User.
    userRequest := *openapiclient.NewUserRequest("Username_example", "Name_example") // UserRequest | 

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id int32 A unique integer value identifying this User.

Other Parameters

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

Name Type Description Notes

userRequest | UserRequest | |

Return type

User

Authorization

authentik

HTTP request headers

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

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

CoreUsersUsedByList

[]UsedBy CoreUsersUsedByList(ctx, id).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    id := int32(56) // int32 | A unique integer value identifying this User.

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id int32 A unique integer value identifying this User.

Other Parameters

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

Name Type Description Notes

Return type

[]UsedBy

Authorization

authentik

HTTP request headers

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

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