Skip to content

AuthAPI.md

Latest commit

 

History

History
529 lines (331 loc) · 13.9 KB

AuthAPI.md

File metadata and controls

529 lines (331 loc) · 13.9 KB
Raw

\AuthAPI

All URIs are relative to http://localhost:5055/api/v1

Method HTTP request Description
CreateAuthJellyfin Post /auth/jellyfin Sign in using a Jellyfin username and password
CreateAuthJellyfinQuickconnectAuthenticate Post /auth/jellyfin/quickconnect/authenticate Authenticate with Quick Connect
CreateAuthJellyfinQuickconnectInitiate Post /auth/jellyfin/quickconnect/initiate Initiate Jellyfin Quick Connect
CreateAuthLocal Post /auth/local Sign in using a local account
CreateAuthLogout Post /auth/logout Sign out and clear session cookie
CreateAuthPlex Post /auth/plex Sign in using a Plex token
GetAuthJellyfinQuickconnectCheck Get /auth/jellyfin/quickconnect/check Check Quick Connect authorization status
GetAuthMe Get /auth/me Get logged-in user

CreateAuthJellyfin

User CreateAuthJellyfin(ctx).CreateAuthJellyfinRequest(createAuthJellyfinRequest).Execute()

Sign in using a Jellyfin username and password

Example

package main

import (
	"context"
	"fmt"
	"os"
	seerrClient "github.com/devopsarr/seerr-go/seerr"
)

func main() {
	createAuthJellyfinRequest := *seerrClient.NewCreateAuthJellyfinRequest("Username_example", "Password_example") // CreateAuthJellyfinRequest | 

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

Path Parameters

Other Parameters

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

Name Type Description Notes
createAuthJellyfinRequest CreateAuthJellyfinRequest

Return type

User

Authorization

No authorization required

HTTP request headers

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

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

CreateAuthJellyfinQuickconnectAuthenticate

User CreateAuthJellyfinQuickconnectAuthenticate(ctx).CreateAuthJellyfinQuickconnectAuthenticateRequest(createAuthJellyfinQuickconnectAuthenticateRequest).Execute()

Authenticate with Quick Connect

Example

package main

import (
	"context"
	"fmt"
	"os"
	seerrClient "github.com/devopsarr/seerr-go/seerr"
)

func main() {
	createAuthJellyfinQuickconnectAuthenticateRequest := *seerrClient.NewCreateAuthJellyfinQuickconnectAuthenticateRequest("Secret_example") // CreateAuthJellyfinQuickconnectAuthenticateRequest | 

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

Path Parameters

Other Parameters

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

Name Type Description Notes
createAuthJellyfinQuickconnectAuthenticateRequest CreateAuthJellyfinQuickconnectAuthenticateRequest

Return type

User

Authorization

No authorization required

HTTP request headers

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

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

CreateAuthJellyfinQuickconnectInitiate

CreateAuthJellyfinQuickconnectInitiate2XXResponse CreateAuthJellyfinQuickconnectInitiate(ctx).Execute()

Initiate Jellyfin Quick Connect

Example

package main

import (
	"context"
	"fmt"
	"os"
	seerrClient "github.com/devopsarr/seerr-go/seerr"
)

func main() {

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

Path Parameters

This endpoint does not need any parameter.

Other Parameters

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

Return type

CreateAuthJellyfinQuickconnectInitiate2XXResponse

Authorization

No authorization required

HTTP request headers

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

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

CreateAuthLocal

User CreateAuthLocal(ctx).CreateAuthLocalRequest(createAuthLocalRequest).Execute()

Sign in using a local account

Example

package main

import (
	"context"
	"fmt"
	"os"
	seerrClient "github.com/devopsarr/seerr-go/seerr"
)

func main() {
	createAuthLocalRequest := *seerrClient.NewCreateAuthLocalRequest("Email_example", "Password_example") // CreateAuthLocalRequest | 

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

Path Parameters

Other Parameters

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

Name Type Description Notes
createAuthLocalRequest CreateAuthLocalRequest

Return type

User

Authorization

No authorization required

HTTP request headers

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

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

CreateAuthLogout

CreateAuthLogout2XXResponse CreateAuthLogout(ctx).Execute()

Sign out and clear session cookie

Example

package main

import (
	"context"
	"fmt"
	"os"
	seerrClient "github.com/devopsarr/seerr-go/seerr"
)

func main() {

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

Path Parameters

This endpoint does not need any parameter.

Other Parameters

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

Return type

CreateAuthLogout2XXResponse

Authorization

apiKey, cookieAuth

HTTP request headers

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

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

CreateAuthPlex

User CreateAuthPlex(ctx).CreateAuthPlexRequest(createAuthPlexRequest).Execute()

Sign in using a Plex token

Example

package main

import (
	"context"
	"fmt"
	"os"
	seerrClient "github.com/devopsarr/seerr-go/seerr"
)

func main() {
	createAuthPlexRequest := *seerrClient.NewCreateAuthPlexRequest("AuthToken_example") // CreateAuthPlexRequest | 

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

Path Parameters

Other Parameters

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

Name Type Description Notes
createAuthPlexRequest CreateAuthPlexRequest

Return type

User

Authorization

No authorization required

HTTP request headers

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

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

GetAuthJellyfinQuickconnectCheck

GetAuthJellyfinQuickconnectCheck2XXResponse GetAuthJellyfinQuickconnectCheck(ctx).Secret(secret).Execute()

Check Quick Connect authorization status

Example

package main

import (
	"context"
	"fmt"
	"os"
	seerrClient "github.com/devopsarr/seerr-go/seerr"
)

func main() {
	secret := "secret_example" // string | The secret returned from the initiate endpoint

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

Path Parameters

Other Parameters

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

Name Type Description Notes
secret string The secret returned from the initiate endpoint

Return type

GetAuthJellyfinQuickconnectCheck2XXResponse

Authorization

No authorization required

HTTP request headers

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

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

GetAuthMe

User GetAuthMe(ctx).Execute()

Get logged-in user

Example

package main

import (
	"context"
	"fmt"
	"os"
	seerrClient "github.com/devopsarr/seerr-go/seerr"
)

func main() {

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

Path Parameters

This endpoint does not need any parameter.

Other Parameters

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

Return type

User

Authorization

apiKey, cookieAuth

HTTP request headers

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

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