Skip to content

Latest commit

 

History

History
2270 lines (1449 loc) · 70.9 KB

ProfileAPI.md

File metadata and controls

2270 lines (1449 loc) · 70.9 KB

\ProfileAPI

All URIs are relative to https://api.linode.com

Method HTTP request Description
DeletePersonalAccessToken Delete /{apiVersion}/profile/tokens/{tokenId} Revoke a personal access token
DeleteProfileApp Delete /{apiVersion}/profile/apps/{appId} Revoke app access
DeleteProfilePhoneNumber Delete /{apiVersion}/profile/phone-number Delete a phone number
DeleteSshKey Delete /{apiVersion}/profile/sshkeys/{sshKeyId} Delete an SSH key
DeleteTrustedDevice Delete /{apiVersion}/profile/devices/{deviceId} Revoke a trusted device
GetDevices Get /{apiVersion}/profile/devices List trusted devices
GetPersonalAccessToken Get /{apiVersion}/profile/tokens/{tokenId} Get a personal access token
GetPersonalAccessTokens Get /{apiVersion}/profile/tokens List personal access tokens
GetProfile Get /{apiVersion}/profile Get a profile
GetProfileApp Get /{apiVersion}/profile/apps/{appId} Get an authorized app
GetProfileApps Get /{apiVersion}/profile/apps List authorized apps
GetProfileGrants Get /{apiVersion}/profile/grants List grants
GetProfileLogin Get /{apiVersion}/profile/logins/{loginId} Get a profile's login
GetProfileLogins Get /{apiVersion}/profile/logins List logins
GetSecurityQuestions Get /{apiVersion}/profile/security-questions List security questions
GetSshKey Get /{apiVersion}/profile/sshkeys/{sshKeyId} Get an SSH key
GetSshKeys Get /{apiVersion}/profile/sshkeys List SSH keys
GetTrustedDevice Get /{apiVersion}/profile/devices/{deviceId} Get a trusted device
GetUserPreferences Get /{apiVersion}/profile/preferences Get user preferences
PostAddSshKey Post /{apiVersion}/profile/sshkeys Add an SSH key
PostPersonalAccessToken Post /{apiVersion}/profile/tokens Create a personal access token
PostProfilePhoneNumber Post /{apiVersion}/profile/phone-number Send a phone number verification code
PostProfilePhoneNumberVerify Post /{apiVersion}/profile/phone-number/verify Verify a phone number
PostSecurityQuestions Post /{apiVersion}/profile/security-questions Answer security questions
PostTfaConfirm Post /{apiVersion}/profile/tfa-enable-confirm Enable two factor authentication
PostTfaDisable Post /{apiVersion}/profile/tfa-disable Disable two factor authentication
PostTfaEnable Post /{apiVersion}/profile/tfa-enable Create a two factor secret
PutPersonalAccessToken Put /{apiVersion}/profile/tokens/{tokenId} Update a personal access token
PutProfile Put /{apiVersion}/profile Update a profile
PutSshKey Put /{apiVersion}/profile/sshkeys/{sshKeyId} Update an SSH key
PutUserPreferences Put /{apiVersion}/profile/preferences Update a user's preferences

DeletePersonalAccessToken

map[string]interface{} DeletePersonalAccessToken(ctx, apiVersion, tokenId).Execute()

Revoke a personal access token

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	apiVersion := "apiVersion_example" // string | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. (default to "v4")
	tokenId := int32(56) // int32 | The ID of the token to access.

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
apiVersion string Enum Call either the `v4` URL, or `v4beta` for operations still in Beta. [default to "v4"]
tokenId int32 The ID of the token to access.

Other Parameters

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

Name Type Description Notes

Return type

map[string]interface{}

Authorization

personalAccessToken, oauth

HTTP request headers

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

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

DeleteProfileApp

map[string]interface{} DeleteProfileApp(ctx, apiVersion, appId).Execute()

Revoke app access

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	apiVersion := "apiVersion_example" // string | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. (default to "v4")
	appId := int32(56) // int32 | The authorized app ID to manage.

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
apiVersion string Enum Call either the `v4` URL, or `v4beta` for operations still in Beta. [default to "v4"]
appId int32 The authorized app ID to manage.

Other Parameters

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

Name Type Description Notes

Return type

map[string]interface{}

Authorization

personalAccessToken, oauth

HTTP request headers

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

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

DeleteProfilePhoneNumber

map[string]interface{} DeleteProfilePhoneNumber(ctx, apiVersion).Execute()

Delete a phone number

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	apiVersion := "apiVersion_example" // string | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. (default to "v4")

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
apiVersion string Enum Call either the `v4` URL, or `v4beta` for operations still in Beta. [default to "v4"]

Other Parameters

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

Name Type Description Notes

Return type

map[string]interface{}

Authorization

personalAccessToken, oauth

HTTP request headers

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

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

DeleteSshKey

map[string]interface{} DeleteSshKey(ctx, apiVersion, sshKeyId).Execute()

Delete an SSH key

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	apiVersion := "apiVersion_example" // string | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. (default to "v4")
	sshKeyId := int32(56) // int32 | The ID of the SSHKey.

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
apiVersion string Enum Call either the `v4` URL, or `v4beta` for operations still in Beta. [default to "v4"]
sshKeyId int32 The ID of the SSHKey.

Other Parameters

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

Name Type Description Notes

Return type

map[string]interface{}

Authorization

personalAccessToken, oauth

HTTP request headers

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

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

DeleteTrustedDevice

map[string]interface{} DeleteTrustedDevice(ctx, apiVersion, deviceId).Execute()

Revoke a trusted device

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	apiVersion := "apiVersion_example" // string | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. (default to "v4")
	deviceId := int32(56) // int32 | The ID of the TrustedDevice.

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
apiVersion string Enum Call either the `v4` URL, or `v4beta` for operations still in Beta. [default to "v4"]
deviceId int32 The ID of the TrustedDevice.

Other Parameters

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

Name Type Description Notes

Return type

map[string]interface{}

Authorization

personalAccessToken, oauth

HTTP request headers

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

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

GetDevices

GetDevices200Response GetDevices(ctx, apiVersion).Execute()

List trusted devices

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	apiVersion := "apiVersion_example" // string | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. (default to "v4")

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
apiVersion string Enum Call either the `v4` URL, or `v4beta` for operations still in Beta. [default to "v4"]

Other Parameters

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

Name Type Description Notes

Return type

GetDevices200Response

Authorization

personalAccessToken, oauth

HTTP request headers

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

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

GetPersonalAccessToken

GetPersonalAccessTokens200ResponseDataInner GetPersonalAccessToken(ctx, apiVersion, tokenId).Execute()

Get a personal access token

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	apiVersion := "apiVersion_example" // string | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. (default to "v4")
	tokenId := int32(56) // int32 | The ID of the token to access.

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
apiVersion string Enum Call either the `v4` URL, or `v4beta` for operations still in Beta. [default to "v4"]
tokenId int32 The ID of the token to access.

Other Parameters

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

Name Type Description Notes

Return type

GetPersonalAccessTokens200ResponseDataInner

Authorization

personalAccessToken, oauth

HTTP request headers

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

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

GetPersonalAccessTokens

GetPersonalAccessTokens200Response GetPersonalAccessTokens(ctx, apiVersion).Execute()

List personal access tokens

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	apiVersion := "apiVersion_example" // string | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. (default to "v4")

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
apiVersion string Enum Call either the `v4` URL, or `v4beta` for operations still in Beta. [default to "v4"]

Other Parameters

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

Name Type Description Notes

Return type

GetPersonalAccessTokens200Response

Authorization

personalAccessToken, oauth

HTTP request headers

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

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

GetProfile

GetProfile200Response GetProfile(ctx, apiVersion).Execute()

Get a profile

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	apiVersion := "apiVersion_example" // string | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. (default to "v4")

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
apiVersion string Enum Call either the `v4` URL, or `v4beta` for operations still in Beta. [default to "v4"]

Other Parameters

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

Name Type Description Notes

Return type

GetProfile200Response

Authorization

personalAccessToken, oauth

HTTP request headers

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

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

GetProfileApp

GetProfileApps200ResponseDataInner GetProfileApp(ctx, apiVersion, appId).Execute()

Get an authorized app

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	apiVersion := "apiVersion_example" // string | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. (default to "v4")
	appId := int32(56) // int32 | The authorized app ID to manage.

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
apiVersion string Enum Call either the `v4` URL, or `v4beta` for operations still in Beta. [default to "v4"]
appId int32 The authorized app ID to manage.

Other Parameters

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

Name Type Description Notes

Return type

GetProfileApps200ResponseDataInner

Authorization

personalAccessToken, oauth

HTTP request headers

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

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

GetProfileApps

GetProfileApps200Response GetProfileApps(ctx, apiVersion).Page(page).PageSize(pageSize).Execute()

List authorized apps

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	apiVersion := "apiVersion_example" // string | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. (default to "v4")
	page := int32(56) // int32 | The page of a collection to return. (optional) (default to 1)
	pageSize := int32(56) // int32 | The number of items to return per page. (optional) (default to 100)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ProfileAPI.GetProfileApps(context.Background(), apiVersion).Page(page).PageSize(pageSize).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ProfileAPI.GetProfileApps``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetProfileApps`: GetProfileApps200Response
	fmt.Fprintf(os.Stdout, "Response from `ProfileAPI.GetProfileApps`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
apiVersion string Enum Call either the `v4` URL, or `v4beta` for operations still in Beta. [default to "v4"]

Other Parameters

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

Name Type Description Notes

page | int32 | The page of a collection to return. | [default to 1] pageSize | int32 | The number of items to return per page. | [default to 100]

Return type

GetProfileApps200Response

Authorization

personalAccessToken, oauth

HTTP request headers

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

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

GetProfileGrants

GetUserGrants200Response GetProfileGrants(ctx, apiVersion).Execute()

List grants

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	apiVersion := "apiVersion_example" // string | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. (default to "v4")

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
apiVersion string Enum Call either the `v4` URL, or `v4beta` for operations still in Beta. [default to "v4"]

Other Parameters

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

Name Type Description Notes

Return type

GetUserGrants200Response

Authorization

personalAccessToken, oauth

HTTP request headers

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

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

GetProfileLogin

GetAccountLogins200ResponseDataInner GetProfileLogin(ctx, apiVersion, loginId).Execute()

Get a profile's login

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	apiVersion := "apiVersion_example" // string | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. (default to "v4")
	loginId := int32(56) // int32 | The ID of the login object to access.

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
apiVersion string Enum Call either the `v4` URL, or `v4beta` for operations still in Beta. [default to "v4"]
loginId int32 The ID of the login object to access.

Other Parameters

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

Name Type Description Notes

Return type

GetAccountLogins200ResponseDataInner

Authorization

personalAccessToken, oauth

HTTP request headers

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

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

GetProfileLogins

GetAccountLogins200Response GetProfileLogins(ctx, apiVersion).Execute()

List logins

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	apiVersion := "apiVersion_example" // string | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. (default to "v4")

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
apiVersion string Enum Call either the `v4` URL, or `v4beta` for operations still in Beta. [default to "v4"]

Other Parameters

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

Name Type Description Notes

Return type

GetAccountLogins200Response

Authorization

personalAccessToken, oauth

HTTP request headers

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

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

GetSecurityQuestions

GetSecurityQuestions200Response GetSecurityQuestions(ctx, apiVersion).Execute()

List security questions

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	apiVersion := "apiVersion_example" // string | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. (default to "v4")

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
apiVersion string Enum Call either the `v4` URL, or `v4beta` for operations still in Beta. [default to "v4"]

Other Parameters

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

Name Type Description Notes

Return type

GetSecurityQuestions200Response

Authorization

personalAccessToken, oauth

HTTP request headers

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

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

GetSshKey

GetSshKeys200ResponseDataInner GetSshKey(ctx, apiVersion, sshKeyId).Execute()

Get an SSH key

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	apiVersion := "apiVersion_example" // string | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. (default to "v4")
	sshKeyId := int32(56) // int32 | The ID of the SSHKey.

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
apiVersion string Enum Call either the `v4` URL, or `v4beta` for operations still in Beta. [default to "v4"]
sshKeyId int32 The ID of the SSHKey.

Other Parameters

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

Name Type Description Notes

Return type

GetSshKeys200ResponseDataInner

Authorization

personalAccessToken, oauth

HTTP request headers

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

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

GetSshKeys

GetSshKeys200Response GetSshKeys(ctx, apiVersion).Page(page).PageSize(pageSize).Execute()

List SSH keys

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	apiVersion := "apiVersion_example" // string | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. (default to "v4")
	page := int32(56) // int32 | The page of a collection to return. (optional) (default to 1)
	pageSize := int32(56) // int32 | The number of items to return per page. (optional) (default to 100)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ProfileAPI.GetSshKeys(context.Background(), apiVersion).Page(page).PageSize(pageSize).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ProfileAPI.GetSshKeys``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetSshKeys`: GetSshKeys200Response
	fmt.Fprintf(os.Stdout, "Response from `ProfileAPI.GetSshKeys`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
apiVersion string Enum Call either the `v4` URL, or `v4beta` for operations still in Beta. [default to "v4"]

Other Parameters

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

Name Type Description Notes

page | int32 | The page of a collection to return. | [default to 1] pageSize | int32 | The number of items to return per page. | [default to 100]

Return type

GetSshKeys200Response

Authorization

personalAccessToken, oauth

HTTP request headers

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

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

GetTrustedDevice

GetDevices200ResponseDataInner GetTrustedDevice(ctx, apiVersion, deviceId).Execute()

Get a trusted device

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	apiVersion := "apiVersion_example" // string | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. (default to "v4")
	deviceId := int32(56) // int32 | The ID of the TrustedDevice.

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
apiVersion string Enum Call either the `v4` URL, or `v4beta` for operations still in Beta. [default to "v4"]
deviceId int32 The ID of the TrustedDevice.

Other Parameters

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

Name Type Description Notes

Return type

GetDevices200ResponseDataInner

Authorization

personalAccessToken, oauth

HTTP request headers

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

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

GetUserPreferences

map[string]interface{} GetUserPreferences(ctx, apiVersion).Execute()

Get user preferences

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	apiVersion := "apiVersion_example" // string | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. (default to "v4")

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
apiVersion string Enum Call either the `v4` URL, or `v4beta` for operations still in Beta. [default to "v4"]

Other Parameters

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

Name Type Description Notes

Return type

map[string]interface{}

Authorization

personalAccessToken, oauth

HTTP request headers

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

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

PostAddSshKey

GetSshKeys200ResponseDataInner PostAddSshKey(ctx, apiVersion).GetSshKeys200ResponseDataInner(getSshKeys200ResponseDataInner).Execute()

Add an SSH key

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	apiVersion := "apiVersion_example" // string | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. (default to "v4")
	getSshKeys200ResponseDataInner := *openapiclient.NewGetSshKeys200ResponseDataInner() // GetSshKeys200ResponseDataInner | Add SSH Key. (optional)

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
apiVersion string Enum Call either the `v4` URL, or `v4beta` for operations still in Beta. [default to "v4"]

Other Parameters

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

Name Type Description Notes

getSshKeys200ResponseDataInner | GetSshKeys200ResponseDataInner | Add SSH Key. |

Return type

GetSshKeys200ResponseDataInner

Authorization

personalAccessToken, oauth

HTTP request headers

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

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

PostPersonalAccessToken

GetPersonalAccessTokens200ResponseDataInner PostPersonalAccessToken(ctx, apiVersion).PostPersonalAccessTokenRequest(postPersonalAccessTokenRequest).Execute()

Create a personal access token

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	apiVersion := "apiVersion_example" // string | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. (default to "v4")
	postPersonalAccessTokenRequest := *openapiclient.NewPostPersonalAccessTokenRequest() // PostPersonalAccessTokenRequest | Information about the requested token.

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
apiVersion string Enum Call either the `v4` URL, or `v4beta` for operations still in Beta. [default to "v4"]

Other Parameters

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

Name Type Description Notes

postPersonalAccessTokenRequest | PostPersonalAccessTokenRequest | Information about the requested token. |

Return type

GetPersonalAccessTokens200ResponseDataInner

Authorization

personalAccessToken, oauth

HTTP request headers

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

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

PostProfilePhoneNumber

map[string]interface{} PostProfilePhoneNumber(ctx, apiVersion).PostProfilePhoneNumberRequest(postProfilePhoneNumberRequest).Execute()

Send a phone number verification code

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	apiVersion := "apiVersion_example" // string | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. (default to "v4")
	postProfilePhoneNumberRequest := *openapiclient.NewPostProfilePhoneNumberRequest("US", "555-555-5555") // PostProfilePhoneNumberRequest | Enter a phone number and country code for verification. (optional)

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
apiVersion string Enum Call either the `v4` URL, or `v4beta` for operations still in Beta. [default to "v4"]

Other Parameters

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

Name Type Description Notes

postProfilePhoneNumberRequest | PostProfilePhoneNumberRequest | Enter a phone number and country code for verification. |

Return type

map[string]interface{}

Authorization

personalAccessToken, oauth

HTTP request headers

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

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

PostProfilePhoneNumberVerify

map[string]interface{} PostProfilePhoneNumberVerify(ctx, apiVersion).PostProfilePhoneNumberVerifyRequest(postProfilePhoneNumberVerifyRequest).Execute()

Verify a phone number

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	apiVersion := "apiVersion_example" // string | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. (default to "v4")
	postProfilePhoneNumberVerifyRequest := *openapiclient.NewPostProfilePhoneNumberVerifyRequest("US") // PostProfilePhoneNumberVerifyRequest | Enter a phone verification code for confirmation. (optional)

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
apiVersion string Enum Call either the `v4` URL, or `v4beta` for operations still in Beta. [default to "v4"]

Other Parameters

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

Name Type Description Notes

postProfilePhoneNumberVerifyRequest | PostProfilePhoneNumberVerifyRequest | Enter a phone verification code for confirmation. |

Return type

map[string]interface{}

Authorization

personalAccessToken, oauth

HTTP request headers

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

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

PostSecurityQuestions

PostSecurityQuestionsRequest PostSecurityQuestions(ctx, apiVersion).PostSecurityQuestionsRequest(postSecurityQuestionsRequest).Execute()

Answer security questions

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	apiVersion := "apiVersion_example" // string | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. (default to "v4")
	postSecurityQuestionsRequest := *openapiclient.NewPostSecurityQuestionsRequest() // PostSecurityQuestionsRequest | Answer Security Questions. (optional)

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
apiVersion string Enum Call either the `v4` URL, or `v4beta` for operations still in Beta. [default to "v4"]

Other Parameters

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

Name Type Description Notes

postSecurityQuestionsRequest | PostSecurityQuestionsRequest | Answer Security Questions. |

Return type

PostSecurityQuestionsRequest

Authorization

personalAccessToken, oauth

HTTP request headers

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

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

PostTfaConfirm

PostTfaConfirm200Response PostTfaConfirm(ctx, apiVersion).PostTfaConfirmRequest(postTfaConfirmRequest).Execute()

Enable two factor authentication

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	apiVersion := "apiVersion_example" // string | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. (default to "v4")
	postTfaConfirmRequest := *openapiclient.NewPostTfaConfirmRequest() // PostTfaConfirmRequest | The Two Factor code you generated with your Two Factor secret.

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
apiVersion string Enum Call either the `v4` URL, or `v4beta` for operations still in Beta. [default to "v4"]

Other Parameters

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

Name Type Description Notes

postTfaConfirmRequest | PostTfaConfirmRequest | The Two Factor code you generated with your Two Factor secret. |

Return type

PostTfaConfirm200Response

Authorization

personalAccessToken, oauth

HTTP request headers

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

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

PostTfaDisable

map[string]interface{} PostTfaDisable(ctx, apiVersion).Execute()

Disable two factor authentication

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	apiVersion := "apiVersion_example" // string | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. (default to "v4")

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
apiVersion string Enum Call either the `v4` URL, or `v4beta` for operations still in Beta. [default to "v4"]

Other Parameters

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

Name Type Description Notes

Return type

map[string]interface{}

Authorization

personalAccessToken, oauth

HTTP request headers

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

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

PostTfaEnable

PostTfaEnable200Response PostTfaEnable(ctx, apiVersion).Execute()

Create a two factor secret

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	apiVersion := "apiVersion_example" // string | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. (default to "v4")

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
apiVersion string Enum Call either the `v4` URL, or `v4beta` for operations still in Beta. [default to "v4"]

Other Parameters

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

Name Type Description Notes

Return type

PostTfaEnable200Response

Authorization

personalAccessToken, oauth

HTTP request headers

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

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

PutPersonalAccessToken

GetPersonalAccessTokens200ResponseDataInner PutPersonalAccessToken(ctx, apiVersion, tokenId).GetPersonalAccessTokens200ResponseDataInner(getPersonalAccessTokens200ResponseDataInner).Execute()

Update a personal access token

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	apiVersion := "apiVersion_example" // string | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. (default to "v4")
	tokenId := int32(56) // int32 | The ID of the token to access.
	getPersonalAccessTokens200ResponseDataInner := *openapiclient.NewGetPersonalAccessTokens200ResponseDataInner() // GetPersonalAccessTokens200ResponseDataInner | The fields to update.

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
apiVersion string Enum Call either the `v4` URL, or `v4beta` for operations still in Beta. [default to "v4"]
tokenId int32 The ID of the token to access.

Other Parameters

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

Name Type Description Notes

getPersonalAccessTokens200ResponseDataInner | GetPersonalAccessTokens200ResponseDataInner | The fields to update. |

Return type

GetPersonalAccessTokens200ResponseDataInner

Authorization

personalAccessToken, oauth

HTTP request headers

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

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

PutProfile

GetProfile200Response PutProfile(ctx, apiVersion).GetProfile200Response(getProfile200Response).Execute()

Update a profile

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	apiVersion := "apiVersion_example" // string | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. (default to "v4")
	getProfile200Response := *openapiclient.NewGetProfile200Response() // GetProfile200Response | The fields to update.

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
apiVersion string Enum Call either the `v4` URL, or `v4beta` for operations still in Beta. [default to "v4"]

Other Parameters

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

Name Type Description Notes

getProfile200Response | GetProfile200Response | The fields to update. |

Return type

GetProfile200Response

Authorization

personalAccessToken, oauth

HTTP request headers

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

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

PutSshKey

GetSshKeys200ResponseDataInner PutSshKey(ctx, apiVersion, sshKeyId).PutSshKeyRequest(putSshKeyRequest).Execute()

Update an SSH key

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	apiVersion := "apiVersion_example" // string | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. (default to "v4")
	sshKeyId := int32(56) // int32 | The ID of the SSHKey.
	putSshKeyRequest := *openapiclient.NewPutSshKeyRequest() // PutSshKeyRequest | The fields to update.

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
apiVersion string Enum Call either the `v4` URL, or `v4beta` for operations still in Beta. [default to "v4"]
sshKeyId int32 The ID of the SSHKey.

Other Parameters

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

Name Type Description Notes

putSshKeyRequest | PutSshKeyRequest | The fields to update. |

Return type

GetSshKeys200ResponseDataInner

Authorization

personalAccessToken, oauth

HTTP request headers

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

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

PutUserPreferences

map[string]interface{} PutUserPreferences(ctx, apiVersion).Body(body).Execute()

Update a user's preferences

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	apiVersion := "apiVersion_example" // string | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. (default to "v4")
	body := map[string]interface{}{ ... } // map[string]interface{} | The user preferences to update or store.

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
apiVersion string Enum Call either the `v4` URL, or `v4beta` for operations still in Beta. [default to "v4"]

Other Parameters

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

Name Type Description Notes

body | map[string]interface{} | The user preferences to update or store. |

Return type

map[string]interface{}

Authorization

personalAccessToken, oauth

HTTP request headers

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

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