Skip to content

Files

Latest commit

 

History

History
8425 lines (5326 loc) · 253 KB

ProvidersApi.md

File metadata and controls

8425 lines (5326 loc) · 253 KB

\ProvidersApi

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

Method HTTP request Description
ProvidersAllDestroy Delete /providers/all/{id}/
ProvidersAllList Get /providers/all/
ProvidersAllRetrieve Get /providers/all/{id}/
ProvidersAllTypesList Get /providers/all/types/
ProvidersAllUsedByList Get /providers/all/{id}/used_by/
ProvidersGoogleWorkspaceCreate Post /providers/google_workspace/
ProvidersGoogleWorkspaceDestroy Delete /providers/google_workspace/{id}/
ProvidersGoogleWorkspaceGroupsCreate Post /providers/google_workspace_groups/
ProvidersGoogleWorkspaceGroupsDestroy Delete /providers/google_workspace_groups/{id}/
ProvidersGoogleWorkspaceGroupsList Get /providers/google_workspace_groups/
ProvidersGoogleWorkspaceGroupsRetrieve Get /providers/google_workspace_groups/{id}/
ProvidersGoogleWorkspaceGroupsUsedByList Get /providers/google_workspace_groups/{id}/used_by/
ProvidersGoogleWorkspaceList Get /providers/google_workspace/
ProvidersGoogleWorkspacePartialUpdate Patch /providers/google_workspace/{id}/
ProvidersGoogleWorkspaceRetrieve Get /providers/google_workspace/{id}/
ProvidersGoogleWorkspaceSyncObjectCreate Post /providers/google_workspace/{id}/sync/object/
ProvidersGoogleWorkspaceSyncStatusRetrieve Get /providers/google_workspace/{id}/sync/status/
ProvidersGoogleWorkspaceUpdate Put /providers/google_workspace/{id}/
ProvidersGoogleWorkspaceUsedByList Get /providers/google_workspace/{id}/used_by/
ProvidersGoogleWorkspaceUsersCreate Post /providers/google_workspace_users/
ProvidersGoogleWorkspaceUsersDestroy Delete /providers/google_workspace_users/{id}/
ProvidersGoogleWorkspaceUsersList Get /providers/google_workspace_users/
ProvidersGoogleWorkspaceUsersRetrieve Get /providers/google_workspace_users/{id}/
ProvidersGoogleWorkspaceUsersUsedByList Get /providers/google_workspace_users/{id}/used_by/
ProvidersLdapCreate Post /providers/ldap/
ProvidersLdapDestroy Delete /providers/ldap/{id}/
ProvidersLdapList Get /providers/ldap/
ProvidersLdapPartialUpdate Patch /providers/ldap/{id}/
ProvidersLdapRetrieve Get /providers/ldap/{id}/
ProvidersLdapUpdate Put /providers/ldap/{id}/
ProvidersLdapUsedByList Get /providers/ldap/{id}/used_by/
ProvidersMicrosoftEntraCreate Post /providers/microsoft_entra/
ProvidersMicrosoftEntraDestroy Delete /providers/microsoft_entra/{id}/
ProvidersMicrosoftEntraGroupsCreate Post /providers/microsoft_entra_groups/
ProvidersMicrosoftEntraGroupsDestroy Delete /providers/microsoft_entra_groups/{id}/
ProvidersMicrosoftEntraGroupsList Get /providers/microsoft_entra_groups/
ProvidersMicrosoftEntraGroupsRetrieve Get /providers/microsoft_entra_groups/{id}/
ProvidersMicrosoftEntraGroupsUsedByList Get /providers/microsoft_entra_groups/{id}/used_by/
ProvidersMicrosoftEntraList Get /providers/microsoft_entra/
ProvidersMicrosoftEntraPartialUpdate Patch /providers/microsoft_entra/{id}/
ProvidersMicrosoftEntraRetrieve Get /providers/microsoft_entra/{id}/
ProvidersMicrosoftEntraSyncObjectCreate Post /providers/microsoft_entra/{id}/sync/object/
ProvidersMicrosoftEntraSyncStatusRetrieve Get /providers/microsoft_entra/{id}/sync/status/
ProvidersMicrosoftEntraUpdate Put /providers/microsoft_entra/{id}/
ProvidersMicrosoftEntraUsedByList Get /providers/microsoft_entra/{id}/used_by/
ProvidersMicrosoftEntraUsersCreate Post /providers/microsoft_entra_users/
ProvidersMicrosoftEntraUsersDestroy Delete /providers/microsoft_entra_users/{id}/
ProvidersMicrosoftEntraUsersList Get /providers/microsoft_entra_users/
ProvidersMicrosoftEntraUsersRetrieve Get /providers/microsoft_entra_users/{id}/
ProvidersMicrosoftEntraUsersUsedByList Get /providers/microsoft_entra_users/{id}/used_by/
ProvidersOauth2Create Post /providers/oauth2/
ProvidersOauth2Destroy Delete /providers/oauth2/{id}/
ProvidersOauth2List Get /providers/oauth2/
ProvidersOauth2PartialUpdate Patch /providers/oauth2/{id}/
ProvidersOauth2PreviewUserRetrieve Get /providers/oauth2/{id}/preview_user/
ProvidersOauth2Retrieve Get /providers/oauth2/{id}/
ProvidersOauth2SetupUrlsRetrieve Get /providers/oauth2/{id}/setup_urls/
ProvidersOauth2Update Put /providers/oauth2/{id}/
ProvidersOauth2UsedByList Get /providers/oauth2/{id}/used_by/
ProvidersProxyCreate Post /providers/proxy/
ProvidersProxyDestroy Delete /providers/proxy/{id}/
ProvidersProxyList Get /providers/proxy/
ProvidersProxyPartialUpdate Patch /providers/proxy/{id}/
ProvidersProxyRetrieve Get /providers/proxy/{id}/
ProvidersProxyUpdate Put /providers/proxy/{id}/
ProvidersProxyUsedByList Get /providers/proxy/{id}/used_by/
ProvidersRacCreate Post /providers/rac/
ProvidersRacDestroy Delete /providers/rac/{id}/
ProvidersRacList Get /providers/rac/
ProvidersRacPartialUpdate Patch /providers/rac/{id}/
ProvidersRacRetrieve Get /providers/rac/{id}/
ProvidersRacUpdate Put /providers/rac/{id}/
ProvidersRacUsedByList Get /providers/rac/{id}/used_by/
ProvidersRadiusCreate Post /providers/radius/
ProvidersRadiusDestroy Delete /providers/radius/{id}/
ProvidersRadiusList Get /providers/radius/
ProvidersRadiusPartialUpdate Patch /providers/radius/{id}/
ProvidersRadiusRetrieve Get /providers/radius/{id}/
ProvidersRadiusUpdate Put /providers/radius/{id}/
ProvidersRadiusUsedByList Get /providers/radius/{id}/used_by/
ProvidersSamlCreate Post /providers/saml/
ProvidersSamlDestroy Delete /providers/saml/{id}/
ProvidersSamlImportMetadataCreate Post /providers/saml/import_metadata/
ProvidersSamlList Get /providers/saml/
ProvidersSamlMetadataRetrieve Get /providers/saml/{id}/metadata/
ProvidersSamlPartialUpdate Patch /providers/saml/{id}/
ProvidersSamlPreviewUserRetrieve Get /providers/saml/{id}/preview_user/
ProvidersSamlRetrieve Get /providers/saml/{id}/
ProvidersSamlUpdate Put /providers/saml/{id}/
ProvidersSamlUsedByList Get /providers/saml/{id}/used_by/
ProvidersScimCreate Post /providers/scim/
ProvidersScimDestroy Delete /providers/scim/{id}/
ProvidersScimGroupsCreate Post /providers/scim_groups/
ProvidersScimGroupsDestroy Delete /providers/scim_groups/{id}/
ProvidersScimGroupsList Get /providers/scim_groups/
ProvidersScimGroupsRetrieve Get /providers/scim_groups/{id}/
ProvidersScimGroupsUsedByList Get /providers/scim_groups/{id}/used_by/
ProvidersScimList Get /providers/scim/
ProvidersScimPartialUpdate Patch /providers/scim/{id}/
ProvidersScimRetrieve Get /providers/scim/{id}/
ProvidersScimSyncObjectCreate Post /providers/scim/{id}/sync/object/
ProvidersScimSyncStatusRetrieve Get /providers/scim/{id}/sync/status/
ProvidersScimUpdate Put /providers/scim/{id}/
ProvidersScimUsedByList Get /providers/scim/{id}/used_by/
ProvidersScimUsersCreate Post /providers/scim_users/
ProvidersScimUsersDestroy Delete /providers/scim_users/{id}/
ProvidersScimUsersList Get /providers/scim_users/
ProvidersScimUsersRetrieve Get /providers/scim_users/{id}/
ProvidersScimUsersUsedByList Get /providers/scim_users/{id}/used_by/
ProvidersSsfCreate Post /providers/ssf/
ProvidersSsfDestroy Delete /providers/ssf/{id}/
ProvidersSsfList Get /providers/ssf/
ProvidersSsfPartialUpdate Patch /providers/ssf/{id}/
ProvidersSsfRetrieve Get /providers/ssf/{id}/
ProvidersSsfUpdate Put /providers/ssf/{id}/
ProvidersSsfUsedByList Get /providers/ssf/{id}/used_by/

ProvidersAllDestroy

ProvidersAllDestroy(ctx, id).Execute()

Example

package main

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

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

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

Other Parameters

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

ProvidersAllList

PaginatedProviderList ProvidersAllList(ctx).ApplicationIsnull(applicationIsnull).Backchannel(backchannel).Ordering(ordering).Page(page).PageSize(pageSize).Search(search).Execute()

Example

package main

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

func main() {
    applicationIsnull := true // bool |  (optional)
    backchannel := true // bool | When not set all providers are returned. When set to true, only backchannel providers are returned. When set to false, backchannel providers are excluded (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.ProvidersApi.ProvidersAllList(context.Background()).ApplicationIsnull(applicationIsnull).Backchannel(backchannel).Ordering(ordering).Page(page).PageSize(pageSize).Search(search).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ProvidersApi.ProvidersAllList``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ProvidersAllList`: PaginatedProviderList
    fmt.Fprintf(os.Stdout, "Response from `ProvidersApi.ProvidersAllList`: %v\n", resp)
}

Path Parameters

Other Parameters

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

Name Type Description Notes
applicationIsnull bool
backchannel bool When not set all providers are returned. When set to true, only backchannel providers are returned. When set to false, backchannel providers are excluded
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

PaginatedProviderList

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]

ProvidersAllRetrieve

Provider ProvidersAllRetrieve(ctx, id).Execute()

Example

package main

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

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

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ProvidersApi.ProvidersAllRetrieve(context.Background(), id).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ProvidersApi.ProvidersAllRetrieve``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ProvidersAllRetrieve`: Provider
    fmt.Fprintf(os.Stdout, "Response from `ProvidersApi.ProvidersAllRetrieve`: %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 provider.

Other Parameters

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

Name Type Description Notes

Return type

Provider

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]

ProvidersAllTypesList

[]TypeCreate ProvidersAllTypesList(ctx).Execute()

Example

package main

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

func main() {

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

Path Parameters

This endpoint does not need any parameter.

Other Parameters

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

Return type

[]TypeCreate

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]

ProvidersAllUsedByList

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

Example

package main

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

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

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ProvidersApi.ProvidersAllUsedByList(context.Background(), id).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ProvidersApi.ProvidersAllUsedByList``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ProvidersAllUsedByList`: []UsedBy
    fmt.Fprintf(os.Stdout, "Response from `ProvidersApi.ProvidersAllUsedByList`: %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 provider.

Other Parameters

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

ProvidersGoogleWorkspaceCreate

GoogleWorkspaceProvider ProvidersGoogleWorkspaceCreate(ctx).GoogleWorkspaceProviderRequest(googleWorkspaceProviderRequest).Execute()

Example

package main

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

func main() {
    googleWorkspaceProviderRequest := *openapiclient.NewGoogleWorkspaceProviderRequest("Name_example", "DelegatedSubject_example", interface{}(123), "DefaultGroupEmailDomain_example") // GoogleWorkspaceProviderRequest | 

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

Path Parameters

Other Parameters

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

Name Type Description Notes
googleWorkspaceProviderRequest GoogleWorkspaceProviderRequest

Return type

GoogleWorkspaceProvider

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]

ProvidersGoogleWorkspaceDestroy

ProvidersGoogleWorkspaceDestroy(ctx, id).Execute()

Example

package main

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

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

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ProvidersApi.ProvidersGoogleWorkspaceDestroy(context.Background(), id).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ProvidersApi.ProvidersGoogleWorkspaceDestroy``: %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 Google Workspace Provider.

Other Parameters

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

ProvidersGoogleWorkspaceGroupsCreate

GoogleWorkspaceProviderGroup ProvidersGoogleWorkspaceGroupsCreate(ctx).GoogleWorkspaceProviderGroupRequest(googleWorkspaceProviderGroupRequest).Execute()

Example

package main

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

func main() {
    googleWorkspaceProviderGroupRequest := *openapiclient.NewGoogleWorkspaceProviderGroupRequest("GoogleId_example", "Group_example", int32(123)) // GoogleWorkspaceProviderGroupRequest | 

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

Path Parameters

Other Parameters

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

Name Type Description Notes
googleWorkspaceProviderGroupRequest GoogleWorkspaceProviderGroupRequest

Return type

GoogleWorkspaceProviderGroup

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]

ProvidersGoogleWorkspaceGroupsDestroy

ProvidersGoogleWorkspaceGroupsDestroy(ctx, id).Execute()

Example

package main

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

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

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

Other Parameters

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

ProvidersGoogleWorkspaceGroupsList

PaginatedGoogleWorkspaceProviderGroupList ProvidersGoogleWorkspaceGroupsList(ctx).GroupGroupUuid(groupGroupUuid).GroupName(groupName).Ordering(ordering).Page(page).PageSize(pageSize).ProviderId(providerId).Search(search).Execute()

Example

package main

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

func main() {
    groupGroupUuid := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string |  (optional)
    groupName := "groupName_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)
    providerId := int32(56) // int32 |  (optional)
    search := "search_example" // string | A search term. (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ProvidersApi.ProvidersGoogleWorkspaceGroupsList(context.Background()).GroupGroupUuid(groupGroupUuid).GroupName(groupName).Ordering(ordering).Page(page).PageSize(pageSize).ProviderId(providerId).Search(search).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ProvidersApi.ProvidersGoogleWorkspaceGroupsList``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ProvidersGoogleWorkspaceGroupsList`: PaginatedGoogleWorkspaceProviderGroupList
    fmt.Fprintf(os.Stdout, "Response from `ProvidersApi.ProvidersGoogleWorkspaceGroupsList`: %v\n", resp)
}

Path Parameters

Other Parameters

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

Name Type Description Notes
groupGroupUuid string
groupName 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.
providerId int32
search string A search term.

Return type

PaginatedGoogleWorkspaceProviderGroupList

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]

ProvidersGoogleWorkspaceGroupsRetrieve

GoogleWorkspaceProviderGroup ProvidersGoogleWorkspaceGroupsRetrieve(ctx, id).Execute()

Example

package main

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

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

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

Path Parameters

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

Other Parameters

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

Name Type Description Notes

Return type

GoogleWorkspaceProviderGroup

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]

ProvidersGoogleWorkspaceGroupsUsedByList

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

Example

package main

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

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

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

Path Parameters

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

Other Parameters

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

ProvidersGoogleWorkspaceList

PaginatedGoogleWorkspaceProviderList ProvidersGoogleWorkspaceList(ctx).DelegatedSubject(delegatedSubject).ExcludeUsersServiceAccount(excludeUsersServiceAccount).FilterGroup(filterGroup).Name(name).Ordering(ordering).Page(page).PageSize(pageSize).Search(search).Execute()

Example

package main

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

func main() {
    delegatedSubject := "delegatedSubject_example" // string |  (optional)
    excludeUsersServiceAccount := true // bool |  (optional)
    filterGroup := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string |  (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.ProvidersApi.ProvidersGoogleWorkspaceList(context.Background()).DelegatedSubject(delegatedSubject).ExcludeUsersServiceAccount(excludeUsersServiceAccount).FilterGroup(filterGroup).Name(name).Ordering(ordering).Page(page).PageSize(pageSize).Search(search).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ProvidersApi.ProvidersGoogleWorkspaceList``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ProvidersGoogleWorkspaceList`: PaginatedGoogleWorkspaceProviderList
    fmt.Fprintf(os.Stdout, "Response from `ProvidersApi.ProvidersGoogleWorkspaceList`: %v\n", resp)
}

Path Parameters

Other Parameters

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

Name Type Description Notes
delegatedSubject string
excludeUsersServiceAccount bool
filterGroup string
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

PaginatedGoogleWorkspaceProviderList

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]

ProvidersGoogleWorkspacePartialUpdate

GoogleWorkspaceProvider ProvidersGoogleWorkspacePartialUpdate(ctx, id).PatchedGoogleWorkspaceProviderRequest(patchedGoogleWorkspaceProviderRequest).Execute()

Example

package main

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

func main() {
    id := int32(56) // int32 | A unique integer value identifying this Google Workspace Provider.
    patchedGoogleWorkspaceProviderRequest := *openapiclient.NewPatchedGoogleWorkspaceProviderRequest() // PatchedGoogleWorkspaceProviderRequest |  (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ProvidersApi.ProvidersGoogleWorkspacePartialUpdate(context.Background(), id).PatchedGoogleWorkspaceProviderRequest(patchedGoogleWorkspaceProviderRequest).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ProvidersApi.ProvidersGoogleWorkspacePartialUpdate``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ProvidersGoogleWorkspacePartialUpdate`: GoogleWorkspaceProvider
    fmt.Fprintf(os.Stdout, "Response from `ProvidersApi.ProvidersGoogleWorkspacePartialUpdate`: %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 Google Workspace Provider.

Other Parameters

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

Name Type Description Notes

patchedGoogleWorkspaceProviderRequest | PatchedGoogleWorkspaceProviderRequest | |

Return type

GoogleWorkspaceProvider

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]

ProvidersGoogleWorkspaceRetrieve

GoogleWorkspaceProvider ProvidersGoogleWorkspaceRetrieve(ctx, id).Execute()

Example

package main

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

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

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ProvidersApi.ProvidersGoogleWorkspaceRetrieve(context.Background(), id).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ProvidersApi.ProvidersGoogleWorkspaceRetrieve``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ProvidersGoogleWorkspaceRetrieve`: GoogleWorkspaceProvider
    fmt.Fprintf(os.Stdout, "Response from `ProvidersApi.ProvidersGoogleWorkspaceRetrieve`: %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 Google Workspace Provider.

Other Parameters

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

Name Type Description Notes

Return type

GoogleWorkspaceProvider

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]

ProvidersGoogleWorkspaceSyncObjectCreate

SyncObjectResult ProvidersGoogleWorkspaceSyncObjectCreate(ctx, id).SyncObjectRequest(syncObjectRequest).Execute()

Example

package main

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

func main() {
    id := int32(56) // int32 | A unique integer value identifying this Google Workspace Provider.
    syncObjectRequest := *openapiclient.NewSyncObjectRequest(openapiclient.SyncObjectModelEnum("authentik.core.models.User"), "SyncObjectId_example") // SyncObjectRequest | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ProvidersApi.ProvidersGoogleWorkspaceSyncObjectCreate(context.Background(), id).SyncObjectRequest(syncObjectRequest).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ProvidersApi.ProvidersGoogleWorkspaceSyncObjectCreate``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ProvidersGoogleWorkspaceSyncObjectCreate`: SyncObjectResult
    fmt.Fprintf(os.Stdout, "Response from `ProvidersApi.ProvidersGoogleWorkspaceSyncObjectCreate`: %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 Google Workspace Provider.

Other Parameters

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

Name Type Description Notes

syncObjectRequest | SyncObjectRequest | |

Return type

SyncObjectResult

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]

ProvidersGoogleWorkspaceSyncStatusRetrieve

SyncStatus ProvidersGoogleWorkspaceSyncStatusRetrieve(ctx, id).Execute()

Example

package main

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

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

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ProvidersApi.ProvidersGoogleWorkspaceSyncStatusRetrieve(context.Background(), id).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ProvidersApi.ProvidersGoogleWorkspaceSyncStatusRetrieve``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ProvidersGoogleWorkspaceSyncStatusRetrieve`: SyncStatus
    fmt.Fprintf(os.Stdout, "Response from `ProvidersApi.ProvidersGoogleWorkspaceSyncStatusRetrieve`: %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 Google Workspace Provider.

Other Parameters

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

Name Type Description Notes

Return type

SyncStatus

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]

ProvidersGoogleWorkspaceUpdate

GoogleWorkspaceProvider ProvidersGoogleWorkspaceUpdate(ctx, id).GoogleWorkspaceProviderRequest(googleWorkspaceProviderRequest).Execute()

Example

package main

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

func main() {
    id := int32(56) // int32 | A unique integer value identifying this Google Workspace Provider.
    googleWorkspaceProviderRequest := *openapiclient.NewGoogleWorkspaceProviderRequest("Name_example", "DelegatedSubject_example", interface{}(123), "DefaultGroupEmailDomain_example") // GoogleWorkspaceProviderRequest | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ProvidersApi.ProvidersGoogleWorkspaceUpdate(context.Background(), id).GoogleWorkspaceProviderRequest(googleWorkspaceProviderRequest).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ProvidersApi.ProvidersGoogleWorkspaceUpdate``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ProvidersGoogleWorkspaceUpdate`: GoogleWorkspaceProvider
    fmt.Fprintf(os.Stdout, "Response from `ProvidersApi.ProvidersGoogleWorkspaceUpdate`: %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 Google Workspace Provider.

Other Parameters

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

Name Type Description Notes

googleWorkspaceProviderRequest | GoogleWorkspaceProviderRequest | |

Return type

GoogleWorkspaceProvider

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]

ProvidersGoogleWorkspaceUsedByList

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

Example

package main

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

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

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ProvidersApi.ProvidersGoogleWorkspaceUsedByList(context.Background(), id).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ProvidersApi.ProvidersGoogleWorkspaceUsedByList``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ProvidersGoogleWorkspaceUsedByList`: []UsedBy
    fmt.Fprintf(os.Stdout, "Response from `ProvidersApi.ProvidersGoogleWorkspaceUsedByList`: %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 Google Workspace Provider.

Other Parameters

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

ProvidersGoogleWorkspaceUsersCreate

GoogleWorkspaceProviderUser ProvidersGoogleWorkspaceUsersCreate(ctx).GoogleWorkspaceProviderUserRequest(googleWorkspaceProviderUserRequest).Execute()

Example

package main

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

func main() {
    googleWorkspaceProviderUserRequest := *openapiclient.NewGoogleWorkspaceProviderUserRequest("GoogleId_example", int32(123), int32(123)) // GoogleWorkspaceProviderUserRequest | 

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

Path Parameters

Other Parameters

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

Name Type Description Notes
googleWorkspaceProviderUserRequest GoogleWorkspaceProviderUserRequest

Return type

GoogleWorkspaceProviderUser

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]

ProvidersGoogleWorkspaceUsersDestroy

ProvidersGoogleWorkspaceUsersDestroy(ctx, id).Execute()

Example

package main

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

func main() {
    id := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | A UUID string identifying this Google Workspace Provider User.

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

Other Parameters

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

ProvidersGoogleWorkspaceUsersList

PaginatedGoogleWorkspaceProviderUserList ProvidersGoogleWorkspaceUsersList(ctx).Ordering(ordering).Page(page).PageSize(pageSize).ProviderId(providerId).Search(search).UserId(userId).UserUsername(userUsername).Execute()

Example

package main

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

func main() {
    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)
    providerId := int32(56) // int32 |  (optional)
    search := "search_example" // string | A search term. (optional)
    userId := int32(56) // int32 |  (optional)
    userUsername := "userUsername_example" // string |  (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ProvidersApi.ProvidersGoogleWorkspaceUsersList(context.Background()).Ordering(ordering).Page(page).PageSize(pageSize).ProviderId(providerId).Search(search).UserId(userId).UserUsername(userUsername).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ProvidersApi.ProvidersGoogleWorkspaceUsersList``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ProvidersGoogleWorkspaceUsersList`: PaginatedGoogleWorkspaceProviderUserList
    fmt.Fprintf(os.Stdout, "Response from `ProvidersApi.ProvidersGoogleWorkspaceUsersList`: %v\n", resp)
}

Path Parameters

Other Parameters

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

Name Type Description Notes
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.
providerId int32
search string A search term.
userId int32
userUsername string

Return type

PaginatedGoogleWorkspaceProviderUserList

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]

ProvidersGoogleWorkspaceUsersRetrieve

GoogleWorkspaceProviderUser ProvidersGoogleWorkspaceUsersRetrieve(ctx, id).Execute()

Example

package main

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

func main() {
    id := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | A UUID string identifying this Google Workspace Provider User.

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string A UUID string identifying this Google Workspace Provider User.

Other Parameters

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

Name Type Description Notes

Return type

GoogleWorkspaceProviderUser

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]

ProvidersGoogleWorkspaceUsersUsedByList

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

Example

package main

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

func main() {
    id := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | A UUID string identifying this Google Workspace Provider User.

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string A UUID string identifying this Google Workspace Provider User.

Other Parameters

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

ProvidersLdapCreate

LDAPProvider ProvidersLdapCreate(ctx).LDAPProviderRequest(lDAPProviderRequest).Execute()

Example

package main

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

func main() {
    lDAPProviderRequest := *openapiclient.NewLDAPProviderRequest("Name_example", "AuthorizationFlow_example", "InvalidationFlow_example") // LDAPProviderRequest | 

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

Path Parameters

Other Parameters

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

Name Type Description Notes
lDAPProviderRequest LDAPProviderRequest

Return type

LDAPProvider

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]

ProvidersLdapDestroy

ProvidersLdapDestroy(ctx, id).Execute()

Example

package main

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

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

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

Other Parameters

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

ProvidersLdapList

PaginatedLDAPProviderList ProvidersLdapList(ctx).ApplicationIsnull(applicationIsnull).AuthorizationFlowSlugIexact(authorizationFlowSlugIexact).BaseDnIexact(baseDnIexact).CertificateKpUuidIexact(certificateKpUuidIexact).CertificateNameIexact(certificateNameIexact).GidStartNumberIexact(gidStartNumberIexact).NameIexact(nameIexact).Ordering(ordering).Page(page).PageSize(pageSize).Search(search).TlsServerNameIexact(tlsServerNameIexact).UidStartNumberIexact(uidStartNumberIexact).Execute()

Example

package main

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

func main() {
    applicationIsnull := true // bool |  (optional)
    authorizationFlowSlugIexact := "authorizationFlowSlugIexact_example" // string |  (optional)
    baseDnIexact := "baseDnIexact_example" // string |  (optional)
    certificateKpUuidIexact := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string |  (optional)
    certificateNameIexact := "certificateNameIexact_example" // string |  (optional)
    gidStartNumberIexact := int32(56) // int32 |  (optional)
    nameIexact := "nameIexact_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)
    tlsServerNameIexact := "tlsServerNameIexact_example" // string |  (optional)
    uidStartNumberIexact := int32(56) // int32 |  (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ProvidersApi.ProvidersLdapList(context.Background()).ApplicationIsnull(applicationIsnull).AuthorizationFlowSlugIexact(authorizationFlowSlugIexact).BaseDnIexact(baseDnIexact).CertificateKpUuidIexact(certificateKpUuidIexact).CertificateNameIexact(certificateNameIexact).GidStartNumberIexact(gidStartNumberIexact).NameIexact(nameIexact).Ordering(ordering).Page(page).PageSize(pageSize).Search(search).TlsServerNameIexact(tlsServerNameIexact).UidStartNumberIexact(uidStartNumberIexact).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ProvidersApi.ProvidersLdapList``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ProvidersLdapList`: PaginatedLDAPProviderList
    fmt.Fprintf(os.Stdout, "Response from `ProvidersApi.ProvidersLdapList`: %v\n", resp)
}

Path Parameters

Other Parameters

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

Name Type Description Notes
applicationIsnull bool
authorizationFlowSlugIexact string
baseDnIexact string
certificateKpUuidIexact string
certificateNameIexact string
gidStartNumberIexact int32
nameIexact 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.
tlsServerNameIexact string
uidStartNumberIexact int32

Return type

PaginatedLDAPProviderList

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]

ProvidersLdapPartialUpdate

LDAPProvider ProvidersLdapPartialUpdate(ctx, id).PatchedLDAPProviderRequest(patchedLDAPProviderRequest).Execute()

Example

package main

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

func main() {
    id := int32(56) // int32 | A unique integer value identifying this LDAP Provider.
    patchedLDAPProviderRequest := *openapiclient.NewPatchedLDAPProviderRequest() // PatchedLDAPProviderRequest |  (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ProvidersApi.ProvidersLdapPartialUpdate(context.Background(), id).PatchedLDAPProviderRequest(patchedLDAPProviderRequest).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ProvidersApi.ProvidersLdapPartialUpdate``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ProvidersLdapPartialUpdate`: LDAPProvider
    fmt.Fprintf(os.Stdout, "Response from `ProvidersApi.ProvidersLdapPartialUpdate`: %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 LDAP Provider.

Other Parameters

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

Name Type Description Notes

patchedLDAPProviderRequest | PatchedLDAPProviderRequest | |

Return type

LDAPProvider

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]

ProvidersLdapRetrieve

LDAPProvider ProvidersLdapRetrieve(ctx, id).Execute()

Example

package main

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

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

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ProvidersApi.ProvidersLdapRetrieve(context.Background(), id).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ProvidersApi.ProvidersLdapRetrieve``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ProvidersLdapRetrieve`: LDAPProvider
    fmt.Fprintf(os.Stdout, "Response from `ProvidersApi.ProvidersLdapRetrieve`: %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 LDAP Provider.

Other Parameters

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

Name Type Description Notes

Return type

LDAPProvider

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]

ProvidersLdapUpdate

LDAPProvider ProvidersLdapUpdate(ctx, id).LDAPProviderRequest(lDAPProviderRequest).Execute()

Example

package main

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

func main() {
    id := int32(56) // int32 | A unique integer value identifying this LDAP Provider.
    lDAPProviderRequest := *openapiclient.NewLDAPProviderRequest("Name_example", "AuthorizationFlow_example", "InvalidationFlow_example") // LDAPProviderRequest | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ProvidersApi.ProvidersLdapUpdate(context.Background(), id).LDAPProviderRequest(lDAPProviderRequest).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ProvidersApi.ProvidersLdapUpdate``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ProvidersLdapUpdate`: LDAPProvider
    fmt.Fprintf(os.Stdout, "Response from `ProvidersApi.ProvidersLdapUpdate`: %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 LDAP Provider.

Other Parameters

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

Name Type Description Notes

lDAPProviderRequest | LDAPProviderRequest | |

Return type

LDAPProvider

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]

ProvidersLdapUsedByList

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

Example

package main

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

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

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ProvidersApi.ProvidersLdapUsedByList(context.Background(), id).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ProvidersApi.ProvidersLdapUsedByList``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ProvidersLdapUsedByList`: []UsedBy
    fmt.Fprintf(os.Stdout, "Response from `ProvidersApi.ProvidersLdapUsedByList`: %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 LDAP Provider.

Other Parameters

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

ProvidersMicrosoftEntraCreate

MicrosoftEntraProvider ProvidersMicrosoftEntraCreate(ctx).MicrosoftEntraProviderRequest(microsoftEntraProviderRequest).Execute()

Example

package main

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

func main() {
    microsoftEntraProviderRequest := *openapiclient.NewMicrosoftEntraProviderRequest("Name_example", "ClientId_example", "ClientSecret_example", "TenantId_example") // MicrosoftEntraProviderRequest | 

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

Path Parameters

Other Parameters

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

Name Type Description Notes
microsoftEntraProviderRequest MicrosoftEntraProviderRequest

Return type

MicrosoftEntraProvider

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]

ProvidersMicrosoftEntraDestroy

ProvidersMicrosoftEntraDestroy(ctx, id).Execute()

Example

package main

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

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

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ProvidersApi.ProvidersMicrosoftEntraDestroy(context.Background(), id).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ProvidersApi.ProvidersMicrosoftEntraDestroy``: %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 Microsoft Entra Provider.

Other Parameters

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

ProvidersMicrosoftEntraGroupsCreate

MicrosoftEntraProviderGroup ProvidersMicrosoftEntraGroupsCreate(ctx).MicrosoftEntraProviderGroupRequest(microsoftEntraProviderGroupRequest).Execute()

Example

package main

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

func main() {
    microsoftEntraProviderGroupRequest := *openapiclient.NewMicrosoftEntraProviderGroupRequest("MicrosoftId_example", "Group_example", int32(123)) // MicrosoftEntraProviderGroupRequest | 

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

Path Parameters

Other Parameters

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

Name Type Description Notes
microsoftEntraProviderGroupRequest MicrosoftEntraProviderGroupRequest

Return type

MicrosoftEntraProviderGroup

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]

ProvidersMicrosoftEntraGroupsDestroy

ProvidersMicrosoftEntraGroupsDestroy(ctx, id).Execute()

Example

package main

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

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

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

Other Parameters

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

ProvidersMicrosoftEntraGroupsList

PaginatedMicrosoftEntraProviderGroupList ProvidersMicrosoftEntraGroupsList(ctx).GroupGroupUuid(groupGroupUuid).GroupName(groupName).Ordering(ordering).Page(page).PageSize(pageSize).ProviderId(providerId).Search(search).Execute()

Example

package main

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

func main() {
    groupGroupUuid := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string |  (optional)
    groupName := "groupName_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)
    providerId := int32(56) // int32 |  (optional)
    search := "search_example" // string | A search term. (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ProvidersApi.ProvidersMicrosoftEntraGroupsList(context.Background()).GroupGroupUuid(groupGroupUuid).GroupName(groupName).Ordering(ordering).Page(page).PageSize(pageSize).ProviderId(providerId).Search(search).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ProvidersApi.ProvidersMicrosoftEntraGroupsList``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ProvidersMicrosoftEntraGroupsList`: PaginatedMicrosoftEntraProviderGroupList
    fmt.Fprintf(os.Stdout, "Response from `ProvidersApi.ProvidersMicrosoftEntraGroupsList`: %v\n", resp)
}

Path Parameters

Other Parameters

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

Name Type Description Notes
groupGroupUuid string
groupName 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.
providerId int32
search string A search term.

Return type

PaginatedMicrosoftEntraProviderGroupList

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]

ProvidersMicrosoftEntraGroupsRetrieve

MicrosoftEntraProviderGroup ProvidersMicrosoftEntraGroupsRetrieve(ctx, id).Execute()

Example

package main

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

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

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

Path Parameters

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

Other Parameters

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

Name Type Description Notes

Return type

MicrosoftEntraProviderGroup

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]

ProvidersMicrosoftEntraGroupsUsedByList

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

Example

package main

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

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

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

Path Parameters

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

Other Parameters

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

ProvidersMicrosoftEntraList

PaginatedMicrosoftEntraProviderList ProvidersMicrosoftEntraList(ctx).ExcludeUsersServiceAccount(excludeUsersServiceAccount).FilterGroup(filterGroup).Name(name).Ordering(ordering).Page(page).PageSize(pageSize).Search(search).Execute()

Example

package main

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

func main() {
    excludeUsersServiceAccount := true // bool |  (optional)
    filterGroup := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string |  (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.ProvidersApi.ProvidersMicrosoftEntraList(context.Background()).ExcludeUsersServiceAccount(excludeUsersServiceAccount).FilterGroup(filterGroup).Name(name).Ordering(ordering).Page(page).PageSize(pageSize).Search(search).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ProvidersApi.ProvidersMicrosoftEntraList``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ProvidersMicrosoftEntraList`: PaginatedMicrosoftEntraProviderList
    fmt.Fprintf(os.Stdout, "Response from `ProvidersApi.ProvidersMicrosoftEntraList`: %v\n", resp)
}

Path Parameters

Other Parameters

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

Name Type Description Notes
excludeUsersServiceAccount bool
filterGroup string
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

PaginatedMicrosoftEntraProviderList

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]

ProvidersMicrosoftEntraPartialUpdate

MicrosoftEntraProvider ProvidersMicrosoftEntraPartialUpdate(ctx, id).PatchedMicrosoftEntraProviderRequest(patchedMicrosoftEntraProviderRequest).Execute()

Example

package main

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

func main() {
    id := int32(56) // int32 | A unique integer value identifying this Microsoft Entra Provider.
    patchedMicrosoftEntraProviderRequest := *openapiclient.NewPatchedMicrosoftEntraProviderRequest() // PatchedMicrosoftEntraProviderRequest |  (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ProvidersApi.ProvidersMicrosoftEntraPartialUpdate(context.Background(), id).PatchedMicrosoftEntraProviderRequest(patchedMicrosoftEntraProviderRequest).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ProvidersApi.ProvidersMicrosoftEntraPartialUpdate``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ProvidersMicrosoftEntraPartialUpdate`: MicrosoftEntraProvider
    fmt.Fprintf(os.Stdout, "Response from `ProvidersApi.ProvidersMicrosoftEntraPartialUpdate`: %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 Microsoft Entra Provider.

Other Parameters

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

Name Type Description Notes

patchedMicrosoftEntraProviderRequest | PatchedMicrosoftEntraProviderRequest | |

Return type

MicrosoftEntraProvider

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]

ProvidersMicrosoftEntraRetrieve

MicrosoftEntraProvider ProvidersMicrosoftEntraRetrieve(ctx, id).Execute()

Example

package main

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

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

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ProvidersApi.ProvidersMicrosoftEntraRetrieve(context.Background(), id).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ProvidersApi.ProvidersMicrosoftEntraRetrieve``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ProvidersMicrosoftEntraRetrieve`: MicrosoftEntraProvider
    fmt.Fprintf(os.Stdout, "Response from `ProvidersApi.ProvidersMicrosoftEntraRetrieve`: %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 Microsoft Entra Provider.

Other Parameters

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

Name Type Description Notes

Return type

MicrosoftEntraProvider

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]

ProvidersMicrosoftEntraSyncObjectCreate

SyncObjectResult ProvidersMicrosoftEntraSyncObjectCreate(ctx, id).SyncObjectRequest(syncObjectRequest).Execute()

Example

package main

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

func main() {
    id := int32(56) // int32 | A unique integer value identifying this Microsoft Entra Provider.
    syncObjectRequest := *openapiclient.NewSyncObjectRequest(openapiclient.SyncObjectModelEnum("authentik.core.models.User"), "SyncObjectId_example") // SyncObjectRequest | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ProvidersApi.ProvidersMicrosoftEntraSyncObjectCreate(context.Background(), id).SyncObjectRequest(syncObjectRequest).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ProvidersApi.ProvidersMicrosoftEntraSyncObjectCreate``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ProvidersMicrosoftEntraSyncObjectCreate`: SyncObjectResult
    fmt.Fprintf(os.Stdout, "Response from `ProvidersApi.ProvidersMicrosoftEntraSyncObjectCreate`: %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 Microsoft Entra Provider.

Other Parameters

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

Name Type Description Notes

syncObjectRequest | SyncObjectRequest | |

Return type

SyncObjectResult

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]

ProvidersMicrosoftEntraSyncStatusRetrieve

SyncStatus ProvidersMicrosoftEntraSyncStatusRetrieve(ctx, id).Execute()

Example

package main

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

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

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ProvidersApi.ProvidersMicrosoftEntraSyncStatusRetrieve(context.Background(), id).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ProvidersApi.ProvidersMicrosoftEntraSyncStatusRetrieve``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ProvidersMicrosoftEntraSyncStatusRetrieve`: SyncStatus
    fmt.Fprintf(os.Stdout, "Response from `ProvidersApi.ProvidersMicrosoftEntraSyncStatusRetrieve`: %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 Microsoft Entra Provider.

Other Parameters

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

Name Type Description Notes

Return type

SyncStatus

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]

ProvidersMicrosoftEntraUpdate

MicrosoftEntraProvider ProvidersMicrosoftEntraUpdate(ctx, id).MicrosoftEntraProviderRequest(microsoftEntraProviderRequest).Execute()

Example

package main

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

func main() {
    id := int32(56) // int32 | A unique integer value identifying this Microsoft Entra Provider.
    microsoftEntraProviderRequest := *openapiclient.NewMicrosoftEntraProviderRequest("Name_example", "ClientId_example", "ClientSecret_example", "TenantId_example") // MicrosoftEntraProviderRequest | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ProvidersApi.ProvidersMicrosoftEntraUpdate(context.Background(), id).MicrosoftEntraProviderRequest(microsoftEntraProviderRequest).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ProvidersApi.ProvidersMicrosoftEntraUpdate``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ProvidersMicrosoftEntraUpdate`: MicrosoftEntraProvider
    fmt.Fprintf(os.Stdout, "Response from `ProvidersApi.ProvidersMicrosoftEntraUpdate`: %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 Microsoft Entra Provider.

Other Parameters

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

Name Type Description Notes

microsoftEntraProviderRequest | MicrosoftEntraProviderRequest | |

Return type

MicrosoftEntraProvider

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]

ProvidersMicrosoftEntraUsedByList

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

Example

package main

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

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

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ProvidersApi.ProvidersMicrosoftEntraUsedByList(context.Background(), id).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ProvidersApi.ProvidersMicrosoftEntraUsedByList``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ProvidersMicrosoftEntraUsedByList`: []UsedBy
    fmt.Fprintf(os.Stdout, "Response from `ProvidersApi.ProvidersMicrosoftEntraUsedByList`: %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 Microsoft Entra Provider.

Other Parameters

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

ProvidersMicrosoftEntraUsersCreate

MicrosoftEntraProviderUser ProvidersMicrosoftEntraUsersCreate(ctx).MicrosoftEntraProviderUserRequest(microsoftEntraProviderUserRequest).Execute()

Example

package main

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

func main() {
    microsoftEntraProviderUserRequest := *openapiclient.NewMicrosoftEntraProviderUserRequest("MicrosoftId_example", int32(123), int32(123)) // MicrosoftEntraProviderUserRequest | 

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

Path Parameters

Other Parameters

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

Name Type Description Notes
microsoftEntraProviderUserRequest MicrosoftEntraProviderUserRequest

Return type

MicrosoftEntraProviderUser

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]

ProvidersMicrosoftEntraUsersDestroy

ProvidersMicrosoftEntraUsersDestroy(ctx, id).Execute()

Example

package main

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

func main() {
    id := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | A UUID string identifying this Microsoft Entra Provider User.

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

Other Parameters

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

ProvidersMicrosoftEntraUsersList

PaginatedMicrosoftEntraProviderUserList ProvidersMicrosoftEntraUsersList(ctx).Ordering(ordering).Page(page).PageSize(pageSize).ProviderId(providerId).Search(search).UserId(userId).UserUsername(userUsername).Execute()

Example

package main

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

func main() {
    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)
    providerId := int32(56) // int32 |  (optional)
    search := "search_example" // string | A search term. (optional)
    userId := int32(56) // int32 |  (optional)
    userUsername := "userUsername_example" // string |  (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ProvidersApi.ProvidersMicrosoftEntraUsersList(context.Background()).Ordering(ordering).Page(page).PageSize(pageSize).ProviderId(providerId).Search(search).UserId(userId).UserUsername(userUsername).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ProvidersApi.ProvidersMicrosoftEntraUsersList``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ProvidersMicrosoftEntraUsersList`: PaginatedMicrosoftEntraProviderUserList
    fmt.Fprintf(os.Stdout, "Response from `ProvidersApi.ProvidersMicrosoftEntraUsersList`: %v\n", resp)
}

Path Parameters

Other Parameters

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

Name Type Description Notes
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.
providerId int32
search string A search term.
userId int32
userUsername string

Return type

PaginatedMicrosoftEntraProviderUserList

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]

ProvidersMicrosoftEntraUsersRetrieve

MicrosoftEntraProviderUser ProvidersMicrosoftEntraUsersRetrieve(ctx, id).Execute()

Example

package main

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

func main() {
    id := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | A UUID string identifying this Microsoft Entra Provider User.

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string A UUID string identifying this Microsoft Entra Provider User.

Other Parameters

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

Name Type Description Notes

Return type

MicrosoftEntraProviderUser

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]

ProvidersMicrosoftEntraUsersUsedByList

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

Example

package main

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

func main() {
    id := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | A UUID string identifying this Microsoft Entra Provider User.

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string A UUID string identifying this Microsoft Entra Provider User.

Other Parameters

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

ProvidersOauth2Create

OAuth2Provider ProvidersOauth2Create(ctx).OAuth2ProviderRequest(oAuth2ProviderRequest).Execute()

Example

package main

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

func main() {
    oAuth2ProviderRequest := *openapiclient.NewOAuth2ProviderRequest("Name_example", "AuthorizationFlow_example", "InvalidationFlow_example", []openapiclient.RedirectURIRequest{*openapiclient.NewRedirectURIRequest(openapiclient.MatchingModeEnum("strict"), "Url_example")}) // OAuth2ProviderRequest | 

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

Path Parameters

Other Parameters

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

Name Type Description Notes
oAuth2ProviderRequest OAuth2ProviderRequest

Return type

OAuth2Provider

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]

ProvidersOauth2Destroy

ProvidersOauth2Destroy(ctx, id).Execute()

Example

package main

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

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

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ProvidersApi.ProvidersOauth2Destroy(context.Background(), id).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ProvidersApi.ProvidersOauth2Destroy``: %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 OAuth2/OpenID Provider.

Other Parameters

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

ProvidersOauth2List

PaginatedOAuth2ProviderList ProvidersOauth2List(ctx).AccessCodeValidity(accessCodeValidity).AccessTokenValidity(accessTokenValidity).Application(application).AuthorizationFlow(authorizationFlow).ClientId(clientId).ClientType(clientType).IncludeClaimsInIdToken(includeClaimsInIdToken).IssuerMode(issuerMode).Name(name).Ordering(ordering).Page(page).PageSize(pageSize).PropertyMappings(propertyMappings).RefreshTokenValidity(refreshTokenValidity).Search(search).SigningKey(signingKey).SubMode(subMode).Execute()

Example

package main

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

func main() {
    accessCodeValidity := "accessCodeValidity_example" // string |  (optional)
    accessTokenValidity := "accessTokenValidity_example" // string |  (optional)
    application := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string |  (optional)
    authorizationFlow := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string |  (optional)
    clientId := "clientId_example" // string |  (optional)
    clientType := "clientType_example" // string | Confidential clients are capable of maintaining the confidentiality of their credentials. Public clients are incapable   (optional)
    includeClaimsInIdToken := true // bool |  (optional)
    issuerMode := "issuerMode_example" // string | Configure how the issuer field of the ID Token should be filled.   (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)
    propertyMappings := []string{"Inner_example"} // []string |  (optional)
    refreshTokenValidity := "refreshTokenValidity_example" // string |  (optional)
    search := "search_example" // string | A search term. (optional)
    signingKey := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string |  (optional)
    subMode := "subMode_example" // string | Configure what data should be used as unique User Identifier. For most cases, the default should be fine.   (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ProvidersApi.ProvidersOauth2List(context.Background()).AccessCodeValidity(accessCodeValidity).AccessTokenValidity(accessTokenValidity).Application(application).AuthorizationFlow(authorizationFlow).ClientId(clientId).ClientType(clientType).IncludeClaimsInIdToken(includeClaimsInIdToken).IssuerMode(issuerMode).Name(name).Ordering(ordering).Page(page).PageSize(pageSize).PropertyMappings(propertyMappings).RefreshTokenValidity(refreshTokenValidity).Search(search).SigningKey(signingKey).SubMode(subMode).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ProvidersApi.ProvidersOauth2List``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ProvidersOauth2List`: PaginatedOAuth2ProviderList
    fmt.Fprintf(os.Stdout, "Response from `ProvidersApi.ProvidersOauth2List`: %v\n", resp)
}

Path Parameters

Other Parameters

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

Name Type Description Notes
accessCodeValidity string
accessTokenValidity string
application string
authorizationFlow string
clientId string
clientType string Confidential clients are capable of maintaining the confidentiality of their credentials. Public clients are incapable
includeClaimsInIdToken bool
issuerMode string Configure how the issuer field of the ID Token should be filled.
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.
propertyMappings []string
refreshTokenValidity string
search string A search term.
signingKey string
subMode string Configure what data should be used as unique User Identifier. For most cases, the default should be fine.

Return type

PaginatedOAuth2ProviderList

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]

ProvidersOauth2PartialUpdate

OAuth2Provider ProvidersOauth2PartialUpdate(ctx, id).PatchedOAuth2ProviderRequest(patchedOAuth2ProviderRequest).Execute()

Example

package main

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

func main() {
    id := int32(56) // int32 | A unique integer value identifying this OAuth2/OpenID Provider.
    patchedOAuth2ProviderRequest := *openapiclient.NewPatchedOAuth2ProviderRequest() // PatchedOAuth2ProviderRequest |  (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ProvidersApi.ProvidersOauth2PartialUpdate(context.Background(), id).PatchedOAuth2ProviderRequest(patchedOAuth2ProviderRequest).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ProvidersApi.ProvidersOauth2PartialUpdate``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ProvidersOauth2PartialUpdate`: OAuth2Provider
    fmt.Fprintf(os.Stdout, "Response from `ProvidersApi.ProvidersOauth2PartialUpdate`: %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 OAuth2/OpenID Provider.

Other Parameters

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

Name Type Description Notes

patchedOAuth2ProviderRequest | PatchedOAuth2ProviderRequest | |

Return type

OAuth2Provider

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]

ProvidersOauth2PreviewUserRetrieve

PropertyMappingPreview ProvidersOauth2PreviewUserRetrieve(ctx, id).ForUser(forUser).Execute()

Example

package main

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

func main() {
    id := int32(56) // int32 | A unique integer value identifying this OAuth2/OpenID Provider.
    forUser := int32(56) // int32 |  (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ProvidersApi.ProvidersOauth2PreviewUserRetrieve(context.Background(), id).ForUser(forUser).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ProvidersApi.ProvidersOauth2PreviewUserRetrieve``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ProvidersOauth2PreviewUserRetrieve`: PropertyMappingPreview
    fmt.Fprintf(os.Stdout, "Response from `ProvidersApi.ProvidersOauth2PreviewUserRetrieve`: %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 OAuth2/OpenID Provider.

Other Parameters

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

Name Type Description Notes

forUser | int32 | |

Return type

PropertyMappingPreview

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]

ProvidersOauth2Retrieve

OAuth2Provider ProvidersOauth2Retrieve(ctx, id).Execute()

Example

package main

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

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

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ProvidersApi.ProvidersOauth2Retrieve(context.Background(), id).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ProvidersApi.ProvidersOauth2Retrieve``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ProvidersOauth2Retrieve`: OAuth2Provider
    fmt.Fprintf(os.Stdout, "Response from `ProvidersApi.ProvidersOauth2Retrieve`: %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 OAuth2/OpenID Provider.

Other Parameters

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

Name Type Description Notes

Return type

OAuth2Provider

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]

ProvidersOauth2SetupUrlsRetrieve

OAuth2ProviderSetupURLs ProvidersOauth2SetupUrlsRetrieve(ctx, id).Execute()

Example

package main

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

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

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ProvidersApi.ProvidersOauth2SetupUrlsRetrieve(context.Background(), id).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ProvidersApi.ProvidersOauth2SetupUrlsRetrieve``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ProvidersOauth2SetupUrlsRetrieve`: OAuth2ProviderSetupURLs
    fmt.Fprintf(os.Stdout, "Response from `ProvidersApi.ProvidersOauth2SetupUrlsRetrieve`: %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 OAuth2/OpenID Provider.

Other Parameters

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

Name Type Description Notes

Return type

OAuth2ProviderSetupURLs

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]

ProvidersOauth2Update

OAuth2Provider ProvidersOauth2Update(ctx, id).OAuth2ProviderRequest(oAuth2ProviderRequest).Execute()

Example

package main

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

func main() {
    id := int32(56) // int32 | A unique integer value identifying this OAuth2/OpenID Provider.
    oAuth2ProviderRequest := *openapiclient.NewOAuth2ProviderRequest("Name_example", "AuthorizationFlow_example", "InvalidationFlow_example", []openapiclient.RedirectURIRequest{*openapiclient.NewRedirectURIRequest(openapiclient.MatchingModeEnum("strict"), "Url_example")}) // OAuth2ProviderRequest | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ProvidersApi.ProvidersOauth2Update(context.Background(), id).OAuth2ProviderRequest(oAuth2ProviderRequest).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ProvidersApi.ProvidersOauth2Update``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ProvidersOauth2Update`: OAuth2Provider
    fmt.Fprintf(os.Stdout, "Response from `ProvidersApi.ProvidersOauth2Update`: %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 OAuth2/OpenID Provider.

Other Parameters

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

Name Type Description Notes

oAuth2ProviderRequest | OAuth2ProviderRequest | |

Return type

OAuth2Provider

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]

ProvidersOauth2UsedByList

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

Example

package main

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

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

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ProvidersApi.ProvidersOauth2UsedByList(context.Background(), id).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ProvidersApi.ProvidersOauth2UsedByList``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ProvidersOauth2UsedByList`: []UsedBy
    fmt.Fprintf(os.Stdout, "Response from `ProvidersApi.ProvidersOauth2UsedByList`: %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 OAuth2/OpenID Provider.

Other Parameters

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

ProvidersProxyCreate

ProxyProvider ProvidersProxyCreate(ctx).ProxyProviderRequest(proxyProviderRequest).Execute()

Example

package main

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

func main() {
    proxyProviderRequest := *openapiclient.NewProxyProviderRequest("Name_example", "AuthorizationFlow_example", "InvalidationFlow_example", "ExternalHost_example") // ProxyProviderRequest | 

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

Path Parameters

Other Parameters

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

Name Type Description Notes
proxyProviderRequest ProxyProviderRequest

Return type

ProxyProvider

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]

ProvidersProxyDestroy

ProvidersProxyDestroy(ctx, id).Execute()

Example

package main

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

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

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

Other Parameters

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

ProvidersProxyList

PaginatedProxyProviderList ProvidersProxyList(ctx).ApplicationIsnull(applicationIsnull).AuthorizationFlowSlugIexact(authorizationFlowSlugIexact).BasicAuthEnabledIexact(basicAuthEnabledIexact).BasicAuthPasswordAttributeIexact(basicAuthPasswordAttributeIexact).BasicAuthUserAttributeIexact(basicAuthUserAttributeIexact).CertificateKpUuidIexact(certificateKpUuidIexact).CertificateNameIexact(certificateNameIexact).CookieDomainIexact(cookieDomainIexact).ExternalHostIexact(externalHostIexact).InternalHostIexact(internalHostIexact).InternalHostSslValidationIexact(internalHostSslValidationIexact).ModeIexact(modeIexact).NameIexact(nameIexact).Ordering(ordering).Page(page).PageSize(pageSize).PropertyMappingsIexact(propertyMappingsIexact).Search(search).SkipPathRegexIexact(skipPathRegexIexact).Execute()

Example

package main

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

func main() {
    applicationIsnull := true // bool |  (optional)
    authorizationFlowSlugIexact := "authorizationFlowSlugIexact_example" // string |  (optional)
    basicAuthEnabledIexact := true // bool |  (optional)
    basicAuthPasswordAttributeIexact := "basicAuthPasswordAttributeIexact_example" // string |  (optional)
    basicAuthUserAttributeIexact := "basicAuthUserAttributeIexact_example" // string |  (optional)
    certificateKpUuidIexact := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string |  (optional)
    certificateNameIexact := "certificateNameIexact_example" // string |  (optional)
    cookieDomainIexact := "cookieDomainIexact_example" // string |  (optional)
    externalHostIexact := "externalHostIexact_example" // string |  (optional)
    internalHostIexact := "internalHostIexact_example" // string |  (optional)
    internalHostSslValidationIexact := true // bool |  (optional)
    modeIexact := "modeIexact_example" // string |  (optional)
    nameIexact := "nameIexact_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)
    propertyMappingsIexact := []string{"Inner_example"} // []string |  (optional)
    search := "search_example" // string | A search term. (optional)
    skipPathRegexIexact := "skipPathRegexIexact_example" // string |  (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ProvidersApi.ProvidersProxyList(context.Background()).ApplicationIsnull(applicationIsnull).AuthorizationFlowSlugIexact(authorizationFlowSlugIexact).BasicAuthEnabledIexact(basicAuthEnabledIexact).BasicAuthPasswordAttributeIexact(basicAuthPasswordAttributeIexact).BasicAuthUserAttributeIexact(basicAuthUserAttributeIexact).CertificateKpUuidIexact(certificateKpUuidIexact).CertificateNameIexact(certificateNameIexact).CookieDomainIexact(cookieDomainIexact).ExternalHostIexact(externalHostIexact).InternalHostIexact(internalHostIexact).InternalHostSslValidationIexact(internalHostSslValidationIexact).ModeIexact(modeIexact).NameIexact(nameIexact).Ordering(ordering).Page(page).PageSize(pageSize).PropertyMappingsIexact(propertyMappingsIexact).Search(search).SkipPathRegexIexact(skipPathRegexIexact).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ProvidersApi.ProvidersProxyList``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ProvidersProxyList`: PaginatedProxyProviderList
    fmt.Fprintf(os.Stdout, "Response from `ProvidersApi.ProvidersProxyList`: %v\n", resp)
}

Path Parameters

Other Parameters

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

Name Type Description Notes
applicationIsnull bool
authorizationFlowSlugIexact string
basicAuthEnabledIexact bool
basicAuthPasswordAttributeIexact string
basicAuthUserAttributeIexact string
certificateKpUuidIexact string
certificateNameIexact string
cookieDomainIexact string
externalHostIexact string
internalHostIexact string
internalHostSslValidationIexact bool
modeIexact string
nameIexact 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.
propertyMappingsIexact []string
search string A search term.
skipPathRegexIexact string

Return type

PaginatedProxyProviderList

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]

ProvidersProxyPartialUpdate

ProxyProvider ProvidersProxyPartialUpdate(ctx, id).PatchedProxyProviderRequest(patchedProxyProviderRequest).Execute()

Example

package main

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

func main() {
    id := int32(56) // int32 | A unique integer value identifying this Proxy Provider.
    patchedProxyProviderRequest := *openapiclient.NewPatchedProxyProviderRequest() // PatchedProxyProviderRequest |  (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ProvidersApi.ProvidersProxyPartialUpdate(context.Background(), id).PatchedProxyProviderRequest(patchedProxyProviderRequest).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ProvidersApi.ProvidersProxyPartialUpdate``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ProvidersProxyPartialUpdate`: ProxyProvider
    fmt.Fprintf(os.Stdout, "Response from `ProvidersApi.ProvidersProxyPartialUpdate`: %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 Proxy Provider.

Other Parameters

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

Name Type Description Notes

patchedProxyProviderRequest | PatchedProxyProviderRequest | |

Return type

ProxyProvider

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]

ProvidersProxyRetrieve

ProxyProvider ProvidersProxyRetrieve(ctx, id).Execute()

Example

package main

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

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

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ProvidersApi.ProvidersProxyRetrieve(context.Background(), id).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ProvidersApi.ProvidersProxyRetrieve``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ProvidersProxyRetrieve`: ProxyProvider
    fmt.Fprintf(os.Stdout, "Response from `ProvidersApi.ProvidersProxyRetrieve`: %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 Proxy Provider.

Other Parameters

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

Name Type Description Notes

Return type

ProxyProvider

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]

ProvidersProxyUpdate

ProxyProvider ProvidersProxyUpdate(ctx, id).ProxyProviderRequest(proxyProviderRequest).Execute()

Example

package main

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

func main() {
    id := int32(56) // int32 | A unique integer value identifying this Proxy Provider.
    proxyProviderRequest := *openapiclient.NewProxyProviderRequest("Name_example", "AuthorizationFlow_example", "InvalidationFlow_example", "ExternalHost_example") // ProxyProviderRequest | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ProvidersApi.ProvidersProxyUpdate(context.Background(), id).ProxyProviderRequest(proxyProviderRequest).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ProvidersApi.ProvidersProxyUpdate``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ProvidersProxyUpdate`: ProxyProvider
    fmt.Fprintf(os.Stdout, "Response from `ProvidersApi.ProvidersProxyUpdate`: %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 Proxy Provider.

Other Parameters

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

Name Type Description Notes

proxyProviderRequest | ProxyProviderRequest | |

Return type

ProxyProvider

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]

ProvidersProxyUsedByList

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

Example

package main

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

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

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ProvidersApi.ProvidersProxyUsedByList(context.Background(), id).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ProvidersApi.ProvidersProxyUsedByList``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ProvidersProxyUsedByList`: []UsedBy
    fmt.Fprintf(os.Stdout, "Response from `ProvidersApi.ProvidersProxyUsedByList`: %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 Proxy Provider.

Other Parameters

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

ProvidersRacCreate

RACProvider ProvidersRacCreate(ctx).RACProviderRequest(rACProviderRequest).Execute()

Example

package main

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

func main() {
    rACProviderRequest := *openapiclient.NewRACProviderRequest("Name_example", "AuthorizationFlow_example") // RACProviderRequest | 

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

Path Parameters

Other Parameters

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

Name Type Description Notes
rACProviderRequest RACProviderRequest

Return type

RACProvider

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]

ProvidersRacDestroy

ProvidersRacDestroy(ctx, id).Execute()

Example

package main

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

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

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

Other Parameters

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

ProvidersRacList

PaginatedRACProviderList ProvidersRacList(ctx).ApplicationIsnull(applicationIsnull).NameIexact(nameIexact).Ordering(ordering).Page(page).PageSize(pageSize).Search(search).Execute()

Example

package main

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

func main() {
    applicationIsnull := true // bool |  (optional)
    nameIexact := "nameIexact_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.ProvidersApi.ProvidersRacList(context.Background()).ApplicationIsnull(applicationIsnull).NameIexact(nameIexact).Ordering(ordering).Page(page).PageSize(pageSize).Search(search).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ProvidersApi.ProvidersRacList``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ProvidersRacList`: PaginatedRACProviderList
    fmt.Fprintf(os.Stdout, "Response from `ProvidersApi.ProvidersRacList`: %v\n", resp)
}

Path Parameters

Other Parameters

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

Name Type Description Notes
applicationIsnull bool
nameIexact 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

PaginatedRACProviderList

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]

ProvidersRacPartialUpdate

RACProvider ProvidersRacPartialUpdate(ctx, id).PatchedRACProviderRequest(patchedRACProviderRequest).Execute()

Example

package main

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

func main() {
    id := int32(56) // int32 | A unique integer value identifying this RAC Provider.
    patchedRACProviderRequest := *openapiclient.NewPatchedRACProviderRequest() // PatchedRACProviderRequest |  (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ProvidersApi.ProvidersRacPartialUpdate(context.Background(), id).PatchedRACProviderRequest(patchedRACProviderRequest).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ProvidersApi.ProvidersRacPartialUpdate``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ProvidersRacPartialUpdate`: RACProvider
    fmt.Fprintf(os.Stdout, "Response from `ProvidersApi.ProvidersRacPartialUpdate`: %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 RAC Provider.

Other Parameters

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

Name Type Description Notes

patchedRACProviderRequest | PatchedRACProviderRequest | |

Return type

RACProvider

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]

ProvidersRacRetrieve

RACProvider ProvidersRacRetrieve(ctx, id).Execute()

Example

package main

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

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

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ProvidersApi.ProvidersRacRetrieve(context.Background(), id).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ProvidersApi.ProvidersRacRetrieve``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ProvidersRacRetrieve`: RACProvider
    fmt.Fprintf(os.Stdout, "Response from `ProvidersApi.ProvidersRacRetrieve`: %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 RAC Provider.

Other Parameters

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

Name Type Description Notes

Return type

RACProvider

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]

ProvidersRacUpdate

RACProvider ProvidersRacUpdate(ctx, id).RACProviderRequest(rACProviderRequest).Execute()

Example

package main

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

func main() {
    id := int32(56) // int32 | A unique integer value identifying this RAC Provider.
    rACProviderRequest := *openapiclient.NewRACProviderRequest("Name_example", "AuthorizationFlow_example") // RACProviderRequest | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ProvidersApi.ProvidersRacUpdate(context.Background(), id).RACProviderRequest(rACProviderRequest).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ProvidersApi.ProvidersRacUpdate``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ProvidersRacUpdate`: RACProvider
    fmt.Fprintf(os.Stdout, "Response from `ProvidersApi.ProvidersRacUpdate`: %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 RAC Provider.

Other Parameters

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

Name Type Description Notes

rACProviderRequest | RACProviderRequest | |

Return type

RACProvider

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]

ProvidersRacUsedByList

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

Example

package main

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

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

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ProvidersApi.ProvidersRacUsedByList(context.Background(), id).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ProvidersApi.ProvidersRacUsedByList``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ProvidersRacUsedByList`: []UsedBy
    fmt.Fprintf(os.Stdout, "Response from `ProvidersApi.ProvidersRacUsedByList`: %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 RAC Provider.

Other Parameters

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

ProvidersRadiusCreate

RadiusProvider ProvidersRadiusCreate(ctx).RadiusProviderRequest(radiusProviderRequest).Execute()

Example

package main

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

func main() {
    radiusProviderRequest := *openapiclient.NewRadiusProviderRequest("Name_example", "AuthorizationFlow_example", "InvalidationFlow_example") // RadiusProviderRequest | 

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

Path Parameters

Other Parameters

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

Name Type Description Notes
radiusProviderRequest RadiusProviderRequest

Return type

RadiusProvider

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]

ProvidersRadiusDestroy

ProvidersRadiusDestroy(ctx, id).Execute()

Example

package main

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

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

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

Other Parameters

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

ProvidersRadiusList

PaginatedRadiusProviderList ProvidersRadiusList(ctx).ApplicationIsnull(applicationIsnull).AuthorizationFlowSlugIexact(authorizationFlowSlugIexact).ClientNetworksIexact(clientNetworksIexact).NameIexact(nameIexact).Ordering(ordering).Page(page).PageSize(pageSize).Search(search).Execute()

Example

package main

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

func main() {
    applicationIsnull := true // bool |  (optional)
    authorizationFlowSlugIexact := "authorizationFlowSlugIexact_example" // string |  (optional)
    clientNetworksIexact := "clientNetworksIexact_example" // string |  (optional)
    nameIexact := "nameIexact_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.ProvidersApi.ProvidersRadiusList(context.Background()).ApplicationIsnull(applicationIsnull).AuthorizationFlowSlugIexact(authorizationFlowSlugIexact).ClientNetworksIexact(clientNetworksIexact).NameIexact(nameIexact).Ordering(ordering).Page(page).PageSize(pageSize).Search(search).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ProvidersApi.ProvidersRadiusList``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ProvidersRadiusList`: PaginatedRadiusProviderList
    fmt.Fprintf(os.Stdout, "Response from `ProvidersApi.ProvidersRadiusList`: %v\n", resp)
}

Path Parameters

Other Parameters

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

Name Type Description Notes
applicationIsnull bool
authorizationFlowSlugIexact string
clientNetworksIexact string
nameIexact 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

PaginatedRadiusProviderList

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]

ProvidersRadiusPartialUpdate

RadiusProvider ProvidersRadiusPartialUpdate(ctx, id).PatchedRadiusProviderRequest(patchedRadiusProviderRequest).Execute()

Example

package main

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

func main() {
    id := int32(56) // int32 | A unique integer value identifying this Radius Provider.
    patchedRadiusProviderRequest := *openapiclient.NewPatchedRadiusProviderRequest() // PatchedRadiusProviderRequest |  (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ProvidersApi.ProvidersRadiusPartialUpdate(context.Background(), id).PatchedRadiusProviderRequest(patchedRadiusProviderRequest).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ProvidersApi.ProvidersRadiusPartialUpdate``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ProvidersRadiusPartialUpdate`: RadiusProvider
    fmt.Fprintf(os.Stdout, "Response from `ProvidersApi.ProvidersRadiusPartialUpdate`: %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 Radius Provider.

Other Parameters

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

Name Type Description Notes

patchedRadiusProviderRequest | PatchedRadiusProviderRequest | |

Return type

RadiusProvider

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]

ProvidersRadiusRetrieve

RadiusProvider ProvidersRadiusRetrieve(ctx, id).Execute()

Example

package main

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

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

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ProvidersApi.ProvidersRadiusRetrieve(context.Background(), id).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ProvidersApi.ProvidersRadiusRetrieve``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ProvidersRadiusRetrieve`: RadiusProvider
    fmt.Fprintf(os.Stdout, "Response from `ProvidersApi.ProvidersRadiusRetrieve`: %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 Radius Provider.

Other Parameters

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

Name Type Description Notes

Return type

RadiusProvider

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]

ProvidersRadiusUpdate

RadiusProvider ProvidersRadiusUpdate(ctx, id).RadiusProviderRequest(radiusProviderRequest).Execute()

Example

package main

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

func main() {
    id := int32(56) // int32 | A unique integer value identifying this Radius Provider.
    radiusProviderRequest := *openapiclient.NewRadiusProviderRequest("Name_example", "AuthorizationFlow_example", "InvalidationFlow_example") // RadiusProviderRequest | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ProvidersApi.ProvidersRadiusUpdate(context.Background(), id).RadiusProviderRequest(radiusProviderRequest).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ProvidersApi.ProvidersRadiusUpdate``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ProvidersRadiusUpdate`: RadiusProvider
    fmt.Fprintf(os.Stdout, "Response from `ProvidersApi.ProvidersRadiusUpdate`: %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 Radius Provider.

Other Parameters

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

Name Type Description Notes

radiusProviderRequest | RadiusProviderRequest | |

Return type

RadiusProvider

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]

ProvidersRadiusUsedByList

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

Example

package main

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

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

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ProvidersApi.ProvidersRadiusUsedByList(context.Background(), id).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ProvidersApi.ProvidersRadiusUsedByList``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ProvidersRadiusUsedByList`: []UsedBy
    fmt.Fprintf(os.Stdout, "Response from `ProvidersApi.ProvidersRadiusUsedByList`: %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 Radius Provider.

Other Parameters

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

ProvidersSamlCreate

SAMLProvider ProvidersSamlCreate(ctx).SAMLProviderRequest(sAMLProviderRequest).Execute()

Example

package main

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

func main() {
    sAMLProviderRequest := *openapiclient.NewSAMLProviderRequest("Name_example", "AuthorizationFlow_example", "InvalidationFlow_example", "AcsUrl_example") // SAMLProviderRequest | 

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

Path Parameters

Other Parameters

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

Name Type Description Notes
sAMLProviderRequest SAMLProviderRequest

Return type

SAMLProvider

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]

ProvidersSamlDestroy

ProvidersSamlDestroy(ctx, id).Execute()

Example

package main

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

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

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

Other Parameters

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

ProvidersSamlImportMetadataCreate

ProvidersSamlImportMetadataCreate(ctx).Name(name).AuthorizationFlow(authorizationFlow).InvalidationFlow(invalidationFlow).File(file).Execute()

Example

package main

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

func main() {
    name := "name_example" // string | 
    authorizationFlow := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | 
    invalidationFlow := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | 
    file := os.NewFile(1234, "some_file") // *os.File | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ProvidersApi.ProvidersSamlImportMetadataCreate(context.Background()).Name(name).AuthorizationFlow(authorizationFlow).InvalidationFlow(invalidationFlow).File(file).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ProvidersApi.ProvidersSamlImportMetadataCreate``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

Other Parameters

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

Name Type Description Notes
name string
authorizationFlow string
invalidationFlow string
file *os.File

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]

ProvidersSamlList

PaginatedSAMLProviderList ProvidersSamlList(ctx).AcsUrl(acsUrl).AssertionValidNotBefore(assertionValidNotBefore).AssertionValidNotOnOrAfter(assertionValidNotOnOrAfter).Audience(audience).AuthenticationFlow(authenticationFlow).AuthnContextClassRefMapping(authnContextClassRefMapping).AuthorizationFlow(authorizationFlow).BackchannelApplication(backchannelApplication).DefaultRelayState(defaultRelayState).DigestAlgorithm(digestAlgorithm).EncryptionKp(encryptionKp).InvalidationFlow(invalidationFlow).IsBackchannel(isBackchannel).Issuer(issuer).Name(name).NameIdMapping(nameIdMapping).Ordering(ordering).Page(page).PageSize(pageSize).PropertyMappings(propertyMappings).Search(search).SessionValidNotOnOrAfter(sessionValidNotOnOrAfter).SignAssertion(signAssertion).SignResponse(signResponse).SignatureAlgorithm(signatureAlgorithm).SigningKp(signingKp).SpBinding(spBinding).VerificationKp(verificationKp).Execute()

Example

package main

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

func main() {
    acsUrl := "acsUrl_example" // string |  (optional)
    assertionValidNotBefore := "assertionValidNotBefore_example" // string |  (optional)
    assertionValidNotOnOrAfter := "assertionValidNotOnOrAfter_example" // string |  (optional)
    audience := "audience_example" // string |  (optional)
    authenticationFlow := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string |  (optional)
    authnContextClassRefMapping := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string |  (optional)
    authorizationFlow := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string |  (optional)
    backchannelApplication := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string |  (optional)
    defaultRelayState := "defaultRelayState_example" // string |  (optional)
    digestAlgorithm := "digestAlgorithm_example" // string |  (optional)
    encryptionKp := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string |  (optional)
    invalidationFlow := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string |  (optional)
    isBackchannel := true // bool |  (optional)
    issuer := "issuer_example" // string |  (optional)
    name := "name_example" // string |  (optional)
    nameIdMapping := "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)
    propertyMappings := []string{"Inner_example"} // []string |  (optional)
    search := "search_example" // string | A search term. (optional)
    sessionValidNotOnOrAfter := "sessionValidNotOnOrAfter_example" // string |  (optional)
    signAssertion := true // bool |  (optional)
    signResponse := true // bool |  (optional)
    signatureAlgorithm := "signatureAlgorithm_example" // string |  (optional)
    signingKp := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string |  (optional)
    spBinding := "spBinding_example" // string | This determines how authentik sends the response back to the Service Provider.   (optional)
    verificationKp := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string |  (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ProvidersApi.ProvidersSamlList(context.Background()).AcsUrl(acsUrl).AssertionValidNotBefore(assertionValidNotBefore).AssertionValidNotOnOrAfter(assertionValidNotOnOrAfter).Audience(audience).AuthenticationFlow(authenticationFlow).AuthnContextClassRefMapping(authnContextClassRefMapping).AuthorizationFlow(authorizationFlow).BackchannelApplication(backchannelApplication).DefaultRelayState(defaultRelayState).DigestAlgorithm(digestAlgorithm).EncryptionKp(encryptionKp).InvalidationFlow(invalidationFlow).IsBackchannel(isBackchannel).Issuer(issuer).Name(name).NameIdMapping(nameIdMapping).Ordering(ordering).Page(page).PageSize(pageSize).PropertyMappings(propertyMappings).Search(search).SessionValidNotOnOrAfter(sessionValidNotOnOrAfter).SignAssertion(signAssertion).SignResponse(signResponse).SignatureAlgorithm(signatureAlgorithm).SigningKp(signingKp).SpBinding(spBinding).VerificationKp(verificationKp).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ProvidersApi.ProvidersSamlList``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ProvidersSamlList`: PaginatedSAMLProviderList
    fmt.Fprintf(os.Stdout, "Response from `ProvidersApi.ProvidersSamlList`: %v\n", resp)
}

Path Parameters

Other Parameters

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

Name Type Description Notes
acsUrl string
assertionValidNotBefore string
assertionValidNotOnOrAfter string
audience string
authenticationFlow string
authnContextClassRefMapping string
authorizationFlow string
backchannelApplication string
defaultRelayState string
digestAlgorithm string
encryptionKp string
invalidationFlow string
isBackchannel bool
issuer string
name string
nameIdMapping 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.
propertyMappings []string
search string A search term.
sessionValidNotOnOrAfter string
signAssertion bool
signResponse bool
signatureAlgorithm string
signingKp string
spBinding string This determines how authentik sends the response back to the Service Provider.
verificationKp string

Return type

PaginatedSAMLProviderList

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]

ProvidersSamlMetadataRetrieve

SAMLMetadata ProvidersSamlMetadataRetrieve(ctx, id).Download(download).ForceBinding(forceBinding).Execute()

Example

package main

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

func main() {
    id := int32(56) // int32 | A unique integer value identifying this SAML Provider.
    download := true // bool |  (optional)
    forceBinding := "forceBinding_example" // string | Optionally force the metadata to only include one binding. (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ProvidersApi.ProvidersSamlMetadataRetrieve(context.Background(), id).Download(download).ForceBinding(forceBinding).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ProvidersApi.ProvidersSamlMetadataRetrieve``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ProvidersSamlMetadataRetrieve`: SAMLMetadata
    fmt.Fprintf(os.Stdout, "Response from `ProvidersApi.ProvidersSamlMetadataRetrieve`: %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 SAML Provider.

Other Parameters

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

Name Type Description Notes

download | bool | | forceBinding | string | Optionally force the metadata to only include one binding. |

Return type

SAMLMetadata

Authorization

authentik

HTTP request headers

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

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

ProvidersSamlPartialUpdate

SAMLProvider ProvidersSamlPartialUpdate(ctx, id).PatchedSAMLProviderRequest(patchedSAMLProviderRequest).Execute()

Example

package main

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

func main() {
    id := int32(56) // int32 | A unique integer value identifying this SAML Provider.
    patchedSAMLProviderRequest := *openapiclient.NewPatchedSAMLProviderRequest() // PatchedSAMLProviderRequest |  (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ProvidersApi.ProvidersSamlPartialUpdate(context.Background(), id).PatchedSAMLProviderRequest(patchedSAMLProviderRequest).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ProvidersApi.ProvidersSamlPartialUpdate``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ProvidersSamlPartialUpdate`: SAMLProvider
    fmt.Fprintf(os.Stdout, "Response from `ProvidersApi.ProvidersSamlPartialUpdate`: %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 SAML Provider.

Other Parameters

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

Name Type Description Notes

patchedSAMLProviderRequest | PatchedSAMLProviderRequest | |

Return type

SAMLProvider

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]

ProvidersSamlPreviewUserRetrieve

PropertyMappingPreview ProvidersSamlPreviewUserRetrieve(ctx, id).ForUser(forUser).Execute()

Example

package main

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

func main() {
    id := int32(56) // int32 | A unique integer value identifying this SAML Provider.
    forUser := int32(56) // int32 |  (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ProvidersApi.ProvidersSamlPreviewUserRetrieve(context.Background(), id).ForUser(forUser).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ProvidersApi.ProvidersSamlPreviewUserRetrieve``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ProvidersSamlPreviewUserRetrieve`: PropertyMappingPreview
    fmt.Fprintf(os.Stdout, "Response from `ProvidersApi.ProvidersSamlPreviewUserRetrieve`: %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 SAML Provider.

Other Parameters

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

Name Type Description Notes

forUser | int32 | |

Return type

PropertyMappingPreview

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]

ProvidersSamlRetrieve

SAMLProvider ProvidersSamlRetrieve(ctx, id).Execute()

Example

package main

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

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

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ProvidersApi.ProvidersSamlRetrieve(context.Background(), id).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ProvidersApi.ProvidersSamlRetrieve``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ProvidersSamlRetrieve`: SAMLProvider
    fmt.Fprintf(os.Stdout, "Response from `ProvidersApi.ProvidersSamlRetrieve`: %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 SAML Provider.

Other Parameters

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

Name Type Description Notes

Return type

SAMLProvider

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]

ProvidersSamlUpdate

SAMLProvider ProvidersSamlUpdate(ctx, id).SAMLProviderRequest(sAMLProviderRequest).Execute()

Example

package main

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

func main() {
    id := int32(56) // int32 | A unique integer value identifying this SAML Provider.
    sAMLProviderRequest := *openapiclient.NewSAMLProviderRequest("Name_example", "AuthorizationFlow_example", "InvalidationFlow_example", "AcsUrl_example") // SAMLProviderRequest | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ProvidersApi.ProvidersSamlUpdate(context.Background(), id).SAMLProviderRequest(sAMLProviderRequest).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ProvidersApi.ProvidersSamlUpdate``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ProvidersSamlUpdate`: SAMLProvider
    fmt.Fprintf(os.Stdout, "Response from `ProvidersApi.ProvidersSamlUpdate`: %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 SAML Provider.

Other Parameters

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

Name Type Description Notes

sAMLProviderRequest | SAMLProviderRequest | |

Return type

SAMLProvider

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]

ProvidersSamlUsedByList

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

Example

package main

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

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

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ProvidersApi.ProvidersSamlUsedByList(context.Background(), id).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ProvidersApi.ProvidersSamlUsedByList``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ProvidersSamlUsedByList`: []UsedBy
    fmt.Fprintf(os.Stdout, "Response from `ProvidersApi.ProvidersSamlUsedByList`: %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 SAML Provider.

Other Parameters

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

ProvidersScimCreate

SCIMProvider ProvidersScimCreate(ctx).SCIMProviderRequest(sCIMProviderRequest).Execute()

Example

package main

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

func main() {
    sCIMProviderRequest := *openapiclient.NewSCIMProviderRequest("Name_example", "Url_example", "Token_example") // SCIMProviderRequest | 

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

Path Parameters

Other Parameters

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

Name Type Description Notes
sCIMProviderRequest SCIMProviderRequest

Return type

SCIMProvider

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]

ProvidersScimDestroy

ProvidersScimDestroy(ctx, id).Execute()

Example

package main

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

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

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

Other Parameters

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

ProvidersScimGroupsCreate

SCIMProviderGroup ProvidersScimGroupsCreate(ctx).SCIMProviderGroupRequest(sCIMProviderGroupRequest).Execute()

Example

package main

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

func main() {
    sCIMProviderGroupRequest := *openapiclient.NewSCIMProviderGroupRequest("ScimId_example", "Group_example", int32(123)) // SCIMProviderGroupRequest | 

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

Path Parameters

Other Parameters

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

Name Type Description Notes
sCIMProviderGroupRequest SCIMProviderGroupRequest

Return type

SCIMProviderGroup

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]

ProvidersScimGroupsDestroy

ProvidersScimGroupsDestroy(ctx, id).Execute()

Example

package main

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

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

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

Other Parameters

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

ProvidersScimGroupsList

PaginatedSCIMProviderGroupList ProvidersScimGroupsList(ctx).GroupGroupUuid(groupGroupUuid).GroupName(groupName).Ordering(ordering).Page(page).PageSize(pageSize).ProviderId(providerId).Search(search).Execute()

Example

package main

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

func main() {
    groupGroupUuid := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string |  (optional)
    groupName := "groupName_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)
    providerId := int32(56) // int32 |  (optional)
    search := "search_example" // string | A search term. (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ProvidersApi.ProvidersScimGroupsList(context.Background()).GroupGroupUuid(groupGroupUuid).GroupName(groupName).Ordering(ordering).Page(page).PageSize(pageSize).ProviderId(providerId).Search(search).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ProvidersApi.ProvidersScimGroupsList``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ProvidersScimGroupsList`: PaginatedSCIMProviderGroupList
    fmt.Fprintf(os.Stdout, "Response from `ProvidersApi.ProvidersScimGroupsList`: %v\n", resp)
}

Path Parameters

Other Parameters

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

Name Type Description Notes
groupGroupUuid string
groupName 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.
providerId int32
search string A search term.

Return type

PaginatedSCIMProviderGroupList

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]

ProvidersScimGroupsRetrieve

SCIMProviderGroup ProvidersScimGroupsRetrieve(ctx, id).Execute()

Example

package main

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

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

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string A UUID string identifying this scim provider group.

Other Parameters

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

Name Type Description Notes

Return type

SCIMProviderGroup

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]

ProvidersScimGroupsUsedByList

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

Example

package main

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

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

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string A UUID string identifying this scim provider group.

Other Parameters

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

ProvidersScimList

PaginatedSCIMProviderList ProvidersScimList(ctx).ExcludeUsersServiceAccount(excludeUsersServiceAccount).FilterGroup(filterGroup).Name(name).Ordering(ordering).Page(page).PageSize(pageSize).Search(search).Url(url).Execute()

Example

package main

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

func main() {
    excludeUsersServiceAccount := true // bool |  (optional)
    filterGroup := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string |  (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)
    url := "url_example" // string |  (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ProvidersApi.ProvidersScimList(context.Background()).ExcludeUsersServiceAccount(excludeUsersServiceAccount).FilterGroup(filterGroup).Name(name).Ordering(ordering).Page(page).PageSize(pageSize).Search(search).Url(url).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ProvidersApi.ProvidersScimList``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ProvidersScimList`: PaginatedSCIMProviderList
    fmt.Fprintf(os.Stdout, "Response from `ProvidersApi.ProvidersScimList`: %v\n", resp)
}

Path Parameters

Other Parameters

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

Name Type Description Notes
excludeUsersServiceAccount bool
filterGroup string
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.
url string

Return type

PaginatedSCIMProviderList

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]

ProvidersScimPartialUpdate

SCIMProvider ProvidersScimPartialUpdate(ctx, id).PatchedSCIMProviderRequest(patchedSCIMProviderRequest).Execute()

Example

package main

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

func main() {
    id := int32(56) // int32 | A unique integer value identifying this SCIM Provider.
    patchedSCIMProviderRequest := *openapiclient.NewPatchedSCIMProviderRequest() // PatchedSCIMProviderRequest |  (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ProvidersApi.ProvidersScimPartialUpdate(context.Background(), id).PatchedSCIMProviderRequest(patchedSCIMProviderRequest).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ProvidersApi.ProvidersScimPartialUpdate``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ProvidersScimPartialUpdate`: SCIMProvider
    fmt.Fprintf(os.Stdout, "Response from `ProvidersApi.ProvidersScimPartialUpdate`: %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 SCIM Provider.

Other Parameters

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

Name Type Description Notes

patchedSCIMProviderRequest | PatchedSCIMProviderRequest | |

Return type

SCIMProvider

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]

ProvidersScimRetrieve

SCIMProvider ProvidersScimRetrieve(ctx, id).Execute()

Example

package main

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

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

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ProvidersApi.ProvidersScimRetrieve(context.Background(), id).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ProvidersApi.ProvidersScimRetrieve``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ProvidersScimRetrieve`: SCIMProvider
    fmt.Fprintf(os.Stdout, "Response from `ProvidersApi.ProvidersScimRetrieve`: %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 SCIM Provider.

Other Parameters

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

Name Type Description Notes

Return type

SCIMProvider

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]

ProvidersScimSyncObjectCreate

SyncObjectResult ProvidersScimSyncObjectCreate(ctx, id).SyncObjectRequest(syncObjectRequest).Execute()

Example

package main

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

func main() {
    id := int32(56) // int32 | A unique integer value identifying this SCIM Provider.
    syncObjectRequest := *openapiclient.NewSyncObjectRequest(openapiclient.SyncObjectModelEnum("authentik.core.models.User"), "SyncObjectId_example") // SyncObjectRequest | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ProvidersApi.ProvidersScimSyncObjectCreate(context.Background(), id).SyncObjectRequest(syncObjectRequest).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ProvidersApi.ProvidersScimSyncObjectCreate``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ProvidersScimSyncObjectCreate`: SyncObjectResult
    fmt.Fprintf(os.Stdout, "Response from `ProvidersApi.ProvidersScimSyncObjectCreate`: %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 SCIM Provider.

Other Parameters

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

Name Type Description Notes

syncObjectRequest | SyncObjectRequest | |

Return type

SyncObjectResult

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]

ProvidersScimSyncStatusRetrieve

SyncStatus ProvidersScimSyncStatusRetrieve(ctx, id).Execute()

Example

package main

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

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

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ProvidersApi.ProvidersScimSyncStatusRetrieve(context.Background(), id).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ProvidersApi.ProvidersScimSyncStatusRetrieve``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ProvidersScimSyncStatusRetrieve`: SyncStatus
    fmt.Fprintf(os.Stdout, "Response from `ProvidersApi.ProvidersScimSyncStatusRetrieve`: %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 SCIM Provider.

Other Parameters

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

Name Type Description Notes

Return type

SyncStatus

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]

ProvidersScimUpdate

SCIMProvider ProvidersScimUpdate(ctx, id).SCIMProviderRequest(sCIMProviderRequest).Execute()

Example

package main

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

func main() {
    id := int32(56) // int32 | A unique integer value identifying this SCIM Provider.
    sCIMProviderRequest := *openapiclient.NewSCIMProviderRequest("Name_example", "Url_example", "Token_example") // SCIMProviderRequest | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ProvidersApi.ProvidersScimUpdate(context.Background(), id).SCIMProviderRequest(sCIMProviderRequest).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ProvidersApi.ProvidersScimUpdate``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ProvidersScimUpdate`: SCIMProvider
    fmt.Fprintf(os.Stdout, "Response from `ProvidersApi.ProvidersScimUpdate`: %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 SCIM Provider.

Other Parameters

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

Name Type Description Notes

sCIMProviderRequest | SCIMProviderRequest | |

Return type

SCIMProvider

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]

ProvidersScimUsedByList

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

Example

package main

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

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

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ProvidersApi.ProvidersScimUsedByList(context.Background(), id).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ProvidersApi.ProvidersScimUsedByList``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ProvidersScimUsedByList`: []UsedBy
    fmt.Fprintf(os.Stdout, "Response from `ProvidersApi.ProvidersScimUsedByList`: %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 SCIM Provider.

Other Parameters

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

ProvidersScimUsersCreate

SCIMProviderUser ProvidersScimUsersCreate(ctx).SCIMProviderUserRequest(sCIMProviderUserRequest).Execute()

Example

package main

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

func main() {
    sCIMProviderUserRequest := *openapiclient.NewSCIMProviderUserRequest("ScimId_example", int32(123), int32(123)) // SCIMProviderUserRequest | 

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

Path Parameters

Other Parameters

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

Name Type Description Notes
sCIMProviderUserRequest SCIMProviderUserRequest

Return type

SCIMProviderUser

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]

ProvidersScimUsersDestroy

ProvidersScimUsersDestroy(ctx, id).Execute()

Example

package main

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

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

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

Other Parameters

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

ProvidersScimUsersList

PaginatedSCIMProviderUserList ProvidersScimUsersList(ctx).Ordering(ordering).Page(page).PageSize(pageSize).ProviderId(providerId).Search(search).UserId(userId).UserUsername(userUsername).Execute()

Example

package main

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

func main() {
    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)
    providerId := int32(56) // int32 |  (optional)
    search := "search_example" // string | A search term. (optional)
    userId := int32(56) // int32 |  (optional)
    userUsername := "userUsername_example" // string |  (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ProvidersApi.ProvidersScimUsersList(context.Background()).Ordering(ordering).Page(page).PageSize(pageSize).ProviderId(providerId).Search(search).UserId(userId).UserUsername(userUsername).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ProvidersApi.ProvidersScimUsersList``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ProvidersScimUsersList`: PaginatedSCIMProviderUserList
    fmt.Fprintf(os.Stdout, "Response from `ProvidersApi.ProvidersScimUsersList`: %v\n", resp)
}

Path Parameters

Other Parameters

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

Name Type Description Notes
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.
providerId int32
search string A search term.
userId int32
userUsername string

Return type

PaginatedSCIMProviderUserList

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]

ProvidersScimUsersRetrieve

SCIMProviderUser ProvidersScimUsersRetrieve(ctx, id).Execute()

Example

package main

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

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

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string A UUID string identifying this scim provider user.

Other Parameters

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

Name Type Description Notes

Return type

SCIMProviderUser

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]

ProvidersScimUsersUsedByList

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

Example

package main

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

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

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string A UUID string identifying this scim provider user.

Other Parameters

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

ProvidersSsfCreate

SSFProvider ProvidersSsfCreate(ctx).SSFProviderRequest(sSFProviderRequest).Execute()

Example

package main

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

func main() {
    sSFProviderRequest := *openapiclient.NewSSFProviderRequest("Name_example", "SigningKey_example") // SSFProviderRequest | 

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

Path Parameters

Other Parameters

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

Name Type Description Notes
sSFProviderRequest SSFProviderRequest

Return type

SSFProvider

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]

ProvidersSsfDestroy

ProvidersSsfDestroy(ctx, id).Execute()

Example

package main

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

func main() {
    id := int32(56) // int32 | A unique integer value identifying this Shared Signals Framework Provider.

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ProvidersApi.ProvidersSsfDestroy(context.Background(), id).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ProvidersApi.ProvidersSsfDestroy``: %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 Shared Signals Framework Provider.

Other Parameters

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

ProvidersSsfList

PaginatedSSFProviderList ProvidersSsfList(ctx).ApplicationIsnull(applicationIsnull).NameIexact(nameIexact).Ordering(ordering).Page(page).PageSize(pageSize).Search(search).Execute()

Example

package main

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

func main() {
    applicationIsnull := true // bool |  (optional)
    nameIexact := "nameIexact_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.ProvidersApi.ProvidersSsfList(context.Background()).ApplicationIsnull(applicationIsnull).NameIexact(nameIexact).Ordering(ordering).Page(page).PageSize(pageSize).Search(search).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ProvidersApi.ProvidersSsfList``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ProvidersSsfList`: PaginatedSSFProviderList
    fmt.Fprintf(os.Stdout, "Response from `ProvidersApi.ProvidersSsfList`: %v\n", resp)
}

Path Parameters

Other Parameters

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

Name Type Description Notes
applicationIsnull bool
nameIexact 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

PaginatedSSFProviderList

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]

ProvidersSsfPartialUpdate

SSFProvider ProvidersSsfPartialUpdate(ctx, id).PatchedSSFProviderRequest(patchedSSFProviderRequest).Execute()

Example

package main

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

func main() {
    id := int32(56) // int32 | A unique integer value identifying this Shared Signals Framework Provider.
    patchedSSFProviderRequest := *openapiclient.NewPatchedSSFProviderRequest() // PatchedSSFProviderRequest |  (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ProvidersApi.ProvidersSsfPartialUpdate(context.Background(), id).PatchedSSFProviderRequest(patchedSSFProviderRequest).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ProvidersApi.ProvidersSsfPartialUpdate``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ProvidersSsfPartialUpdate`: SSFProvider
    fmt.Fprintf(os.Stdout, "Response from `ProvidersApi.ProvidersSsfPartialUpdate`: %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 Shared Signals Framework Provider.

Other Parameters

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

Name Type Description Notes

patchedSSFProviderRequest | PatchedSSFProviderRequest | |

Return type

SSFProvider

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]

ProvidersSsfRetrieve

SSFProvider ProvidersSsfRetrieve(ctx, id).Execute()

Example

package main

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

func main() {
    id := int32(56) // int32 | A unique integer value identifying this Shared Signals Framework Provider.

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ProvidersApi.ProvidersSsfRetrieve(context.Background(), id).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ProvidersApi.ProvidersSsfRetrieve``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ProvidersSsfRetrieve`: SSFProvider
    fmt.Fprintf(os.Stdout, "Response from `ProvidersApi.ProvidersSsfRetrieve`: %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 Shared Signals Framework Provider.

Other Parameters

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

Name Type Description Notes

Return type

SSFProvider

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]

ProvidersSsfUpdate

SSFProvider ProvidersSsfUpdate(ctx, id).SSFProviderRequest(sSFProviderRequest).Execute()

Example

package main

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

func main() {
    id := int32(56) // int32 | A unique integer value identifying this Shared Signals Framework Provider.
    sSFProviderRequest := *openapiclient.NewSSFProviderRequest("Name_example", "SigningKey_example") // SSFProviderRequest | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ProvidersApi.ProvidersSsfUpdate(context.Background(), id).SSFProviderRequest(sSFProviderRequest).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ProvidersApi.ProvidersSsfUpdate``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ProvidersSsfUpdate`: SSFProvider
    fmt.Fprintf(os.Stdout, "Response from `ProvidersApi.ProvidersSsfUpdate`: %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 Shared Signals Framework Provider.

Other Parameters

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

Name Type Description Notes

sSFProviderRequest | SSFProviderRequest | |

Return type

SSFProvider

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]

ProvidersSsfUsedByList

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

Example

package main

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

func main() {
    id := int32(56) // int32 | A unique integer value identifying this Shared Signals Framework Provider.

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ProvidersApi.ProvidersSsfUsedByList(context.Background(), id).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ProvidersApi.ProvidersSsfUsedByList``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ProvidersSsfUsedByList`: []UsedBy
    fmt.Fprintf(os.Stdout, "Response from `ProvidersApi.ProvidersSsfUsedByList`: %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 Shared Signals Framework Provider.

Other Parameters

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