authenticationmethod

package
v0.20241126.1723 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Nov 26, 2024 License: MPL-2.0 Imports: 10 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/microsoft-graph/me/stable/authenticationmethod Documentation

The authenticationmethod SDK allows for interaction with Microsoft Graph me (API Version stable).

This readme covers example usages, but further information on using this SDK can be found in the project root.

Import Path

import "github.com/hashicorp/go-azure-sdk/microsoft-graph/me/stable/authenticationmethod"

Client Initialization

client := authenticationmethod.NewAuthenticationMethodClientWithBaseURI("https://graph.microsoft.com")
client.Client.Authorizer = authorizer

Example Usage: AuthenticationMethodClient.CreateAuthenticationMethod

ctx := context.TODO()

payload := authenticationmethod.AuthenticationMethod{
	// ...
}


read, err := client.CreateAuthenticationMethod(ctx, payload, authenticationmethod.DefaultCreateAuthenticationMethodOperationOptions())
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: AuthenticationMethodClient.GetAuthenticationMethod

ctx := context.TODO()
id := authenticationmethod.NewMeAuthenticationMethodID("authenticationMethodId")

read, err := client.GetAuthenticationMethod(ctx, id, authenticationmethod.DefaultGetAuthenticationMethodOperationOptions())
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: AuthenticationMethodClient.GetAuthenticationMethodsCount

ctx := context.TODO()


read, err := client.GetAuthenticationMethodsCount(ctx, authenticationmethod.DefaultGetAuthenticationMethodsCountOperationOptions())
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: AuthenticationMethodClient.ListAuthenticationMethods

ctx := context.TODO()


// alternatively `client.ListAuthenticationMethods(ctx, authenticationmethod.DefaultListAuthenticationMethodsOperationOptions())` can be used to do batched pagination
items, err := client.ListAuthenticationMethodsComplete(ctx, authenticationmethod.DefaultListAuthenticationMethodsOperationOptions())
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Example Usage: AuthenticationMethodClient.ResetAuthenticationMethodPassword

ctx := context.TODO()
id := authenticationmethod.NewMeAuthenticationMethodID("authenticationMethodId")

payload := authenticationmethod.ResetAuthenticationMethodPasswordRequest{
	// ...
}


read, err := client.ResetAuthenticationMethodPassword(ctx, id, payload, authenticationmethod.DefaultResetAuthenticationMethodPasswordOperationOptions())
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: AuthenticationMethodClient.UpdateAuthenticationMethod

ctx := context.TODO()
id := authenticationmethod.NewMeAuthenticationMethodID("authenticationMethodId")

payload := authenticationmethod.AuthenticationMethod{
	// ...
}


read, err := client.UpdateAuthenticationMethod(ctx, id, payload, authenticationmethod.DefaultUpdateAuthenticationMethodOperationOptions())
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AuthenticationMethodClient 

type AuthenticationMethodClient struct {
	Client *msgraph.Client
}

func NewAuthenticationMethodClientWithBaseURI 

func NewAuthenticationMethodClientWithBaseURI(sdkApi sdkEnv.Api) (*AuthenticationMethodClient, error)

func (AuthenticationMethodClient) CreateAuthenticationMethod 

func (c AuthenticationMethodClient) CreateAuthenticationMethod(ctx context.Context, input stable.AuthenticationMethod, options CreateAuthenticationMethodOperationOptions) (result CreateAuthenticationMethodOperationResponse, err error)

CreateAuthenticationMethod - Create new navigation property to methods for me

func (AuthenticationMethodClient) GetAuthenticationMethod 

func (c AuthenticationMethodClient) GetAuthenticationMethod(ctx context.Context, id stable.MeAuthenticationMethodId, options GetAuthenticationMethodOperationOptions) (result GetAuthenticationMethodOperationResponse, err error)

GetAuthenticationMethod - Get authenticationMethod. Retrieve the properties and relationships of an authenticationMethod object.

func (AuthenticationMethodClient) GetAuthenticationMethodsCount 

func (c AuthenticationMethodClient) GetAuthenticationMethodsCount(ctx context.Context, options GetAuthenticationMethodsCountOperationOptions) (result GetAuthenticationMethodsCountOperationResponse, err error)

GetAuthenticationMethodsCount - Get the number of the resource

func (AuthenticationMethodClient) ListAuthenticationMethods 

func (c AuthenticationMethodClient) ListAuthenticationMethods(ctx context.Context, options ListAuthenticationMethodsOperationOptions) (result ListAuthenticationMethodsOperationResponse, err error)

ListAuthenticationMethods - List methods. Retrieve a list of authentication methods registered to a user. The authentication methods are defined by the types derived from the authenticationMethod resource type, and only the methods supported on this API version. See Microsoft Entra authentication methods API overview for a list of currently supported methods. We don't recommend using the authentication methods APIs for scenarios where you need to iterate over your entire user population for auditing or security check purposes. For these types of scenarios, we recommend using the authentication method registration and usage reporting APIs (available on the beta endpoint only).

func (AuthenticationMethodClient) ListAuthenticationMethodsComplete 

func (c AuthenticationMethodClient) ListAuthenticationMethodsComplete(ctx context.Context, options ListAuthenticationMethodsOperationOptions) (ListAuthenticationMethodsCompleteResult, error)

ListAuthenticationMethodsComplete retrieves all the results into a single object

func (AuthenticationMethodClient) ListAuthenticationMethodsCompleteMatchingPredicate 

func (c AuthenticationMethodClient) ListAuthenticationMethodsCompleteMatchingPredicate(ctx context.Context, options ListAuthenticationMethodsOperationOptions, predicate AuthenticationMethodOperationPredicate) (result ListAuthenticationMethodsCompleteResult, err error)

ListAuthenticationMethodsCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (AuthenticationMethodClient) ResetAuthenticationMethodPassword 

func (c AuthenticationMethodClient) ResetAuthenticationMethodPassword(ctx context.Context, id stable.MeAuthenticationMethodId, input ResetAuthenticationMethodPasswordRequest, options ResetAuthenticationMethodPasswordOperationOptions) (result ResetAuthenticationMethodPasswordOperationResponse, err error)

ResetAuthenticationMethodPassword - Invoke action resetPassword. Reset a user's password, represented by a password authentication method object. This can only be done by an administrator with appropriate permissions and can't be performed on a user's own account. To reset a user's password in Azure AD B2C, use the Update user API operation and update the passwordProfile > forceChangePasswordNextSignIn object. This flow writes the new password to Microsoft Entra ID and pushes it to on-premises Active Directory if configured using password writeback. The admin can either provide a new password or have the system generate one. The user is prompted to change their password on their next sign in. This reset is a long-running operation and returns a Location header with a link where the caller can periodically check for the status of the reset operation.

func (AuthenticationMethodClient) UpdateAuthenticationMethod 

func (c AuthenticationMethodClient) UpdateAuthenticationMethod(ctx context.Context, id stable.MeAuthenticationMethodId, input stable.AuthenticationMethod, options UpdateAuthenticationMethodOperationOptions) (result UpdateAuthenticationMethodOperationResponse, err error)

UpdateAuthenticationMethod - Update the navigation property methods in me

type AuthenticationMethodOperationPredicate 

type AuthenticationMethodOperationPredicate struct {
}

func (AuthenticationMethodOperationPredicate) Matches 

func (p AuthenticationMethodOperationPredicate) Matches(input stable.AuthenticationMethod) bool

type CreateAuthenticationMethodOperationOptions 

type CreateAuthenticationMethodOperationOptions struct {
	Metadata  *odata.Metadata
	RetryFunc client.RequestRetryFunc
}

func DefaultCreateAuthenticationMethodOperationOptions 

func DefaultCreateAuthenticationMethodOperationOptions() CreateAuthenticationMethodOperationOptions

func (CreateAuthenticationMethodOperationOptions) ToHeaders 

func (o CreateAuthenticationMethodOperationOptions) ToHeaders() *client.Headers

func (CreateAuthenticationMethodOperationOptions) ToOData 

func (o CreateAuthenticationMethodOperationOptions) ToOData() *odata.Query

func (CreateAuthenticationMethodOperationOptions) ToQuery 

func (o CreateAuthenticationMethodOperationOptions) ToQuery() *client.QueryParams

type CreateAuthenticationMethodOperationResponse 

type CreateAuthenticationMethodOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        stable.AuthenticationMethod
}

type GetAuthenticationMethodOperationOptions 

type GetAuthenticationMethodOperationOptions struct {
	Expand    *odata.Expand
	Metadata  *odata.Metadata
	RetryFunc client.RequestRetryFunc
	Select    *[]string
}

func DefaultGetAuthenticationMethodOperationOptions 

func DefaultGetAuthenticationMethodOperationOptions() GetAuthenticationMethodOperationOptions

func (GetAuthenticationMethodOperationOptions) ToHeaders 

func (o GetAuthenticationMethodOperationOptions) ToHeaders() *client.Headers

func (GetAuthenticationMethodOperationOptions) ToOData 

func (o GetAuthenticationMethodOperationOptions) ToOData() *odata.Query

func (GetAuthenticationMethodOperationOptions) ToQuery 

func (o GetAuthenticationMethodOperationOptions) ToQuery() *client.QueryParams

type GetAuthenticationMethodOperationResponse 

type GetAuthenticationMethodOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        stable.AuthenticationMethod
}

type GetAuthenticationMethodsCountOperationOptions 

type GetAuthenticationMethodsCountOperationOptions struct {
	Filter    *string
	Metadata  *odata.Metadata
	RetryFunc client.RequestRetryFunc
	Search    *string
}

func DefaultGetAuthenticationMethodsCountOperationOptions 

func DefaultGetAuthenticationMethodsCountOperationOptions() GetAuthenticationMethodsCountOperationOptions

func (GetAuthenticationMethodsCountOperationOptions) ToHeaders 

func (o GetAuthenticationMethodsCountOperationOptions) ToHeaders() *client.Headers

func (GetAuthenticationMethodsCountOperationOptions) ToOData 

func (o GetAuthenticationMethodsCountOperationOptions) ToOData() *odata.Query

func (GetAuthenticationMethodsCountOperationOptions) ToQuery 

func (o GetAuthenticationMethodsCountOperationOptions) ToQuery() *client.QueryParams

type GetAuthenticationMethodsCountOperationResponse 

type GetAuthenticationMethodsCountOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]byte
}

type ListAuthenticationMethodsCompleteResult 

type ListAuthenticationMethodsCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []stable.AuthenticationMethod
}

type ListAuthenticationMethodsCustomPager 

type ListAuthenticationMethodsCustomPager struct {
	NextLink *odata.Link `json:"@odata.nextLink"`
}
func (p *ListAuthenticationMethodsCustomPager) NextPageLink() *odata.Link

type ListAuthenticationMethodsOperationOptions 

type ListAuthenticationMethodsOperationOptions struct {
	Count     *bool
	Expand    *odata.Expand
	Filter    *string
	Metadata  *odata.Metadata
	OrderBy   *odata.OrderBy
	RetryFunc client.RequestRetryFunc
	Search    *string
	Select    *[]string
	Skip      *int64
	Top       *int64
}

func DefaultListAuthenticationMethodsOperationOptions 

func DefaultListAuthenticationMethodsOperationOptions() ListAuthenticationMethodsOperationOptions

func (ListAuthenticationMethodsOperationOptions) ToHeaders 

func (o ListAuthenticationMethodsOperationOptions) ToHeaders() *client.Headers

func (ListAuthenticationMethodsOperationOptions) ToOData 

func (o ListAuthenticationMethodsOperationOptions) ToOData() *odata.Query

func (ListAuthenticationMethodsOperationOptions) ToQuery 

func (o ListAuthenticationMethodsOperationOptions) ToQuery() *client.QueryParams

type ListAuthenticationMethodsOperationResponse 

type ListAuthenticationMethodsOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]stable.AuthenticationMethod
}

type ResetAuthenticationMethodPasswordOperationOptions 

type ResetAuthenticationMethodPasswordOperationOptions struct {
	Metadata  *odata.Metadata
	RetryFunc client.RequestRetryFunc
}

func DefaultResetAuthenticationMethodPasswordOperationOptions 

func DefaultResetAuthenticationMethodPasswordOperationOptions() ResetAuthenticationMethodPasswordOperationOptions

func (ResetAuthenticationMethodPasswordOperationOptions) ToHeaders 

func (o ResetAuthenticationMethodPasswordOperationOptions) ToHeaders() *client.Headers

func (ResetAuthenticationMethodPasswordOperationOptions) ToOData 

func (o ResetAuthenticationMethodPasswordOperationOptions) ToOData() *odata.Query

func (ResetAuthenticationMethodPasswordOperationOptions) ToQuery 

func (o ResetAuthenticationMethodPasswordOperationOptions) ToQuery() *client.QueryParams

type ResetAuthenticationMethodPasswordOperationResponse 

type ResetAuthenticationMethodPasswordOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *stable.PasswordResetResponse
}

type ResetAuthenticationMethodPasswordRequest 

type ResetAuthenticationMethodPasswordRequest struct {
	NewPassword nullable.Type[string] `json:"newPassword,omitempty"`
}

type UpdateAuthenticationMethodOperationOptions 

type UpdateAuthenticationMethodOperationOptions struct {
	Metadata  *odata.Metadata
	RetryFunc client.RequestRetryFunc
}

func DefaultUpdateAuthenticationMethodOperationOptions 

func DefaultUpdateAuthenticationMethodOperationOptions() UpdateAuthenticationMethodOperationOptions

func (UpdateAuthenticationMethodOperationOptions) ToHeaders 

func (o UpdateAuthenticationMethodOperationOptions) ToHeaders() *client.Headers

func (UpdateAuthenticationMethodOperationOptions) ToOData 

func (o UpdateAuthenticationMethodOperationOptions) ToOData() *odata.Query

func (UpdateAuthenticationMethodOperationOptions) ToQuery 

func (o UpdateAuthenticationMethodOperationOptions) ToQuery() *client.QueryParams

type UpdateAuthenticationMethodOperationResponse 

type UpdateAuthenticationMethodOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.