userFactor.go

/*
* Copyright 2018 - Present Okta, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
*      http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
 */

// Code generated by okta openapi generator. DO NOT EDIT.

package okta

import (
	"context"
	"fmt"
	"time"

	"github.com/okta/okta-sdk-golang/v2/okta/query"
)

type Factor interface {
	IsUserFactorInstance() bool
}

type UserFactorResource resource

type UserFactor struct {
	Embedded    interface{}          `json:"_embedded,omitempty"`
	Links       interface{}          `json:"_links,omitempty"`
	Created     *time.Time           `json:"created,omitempty"`
	FactorType  string               `json:"factorType,omitempty"`
	Id          string               `json:"id,omitempty"`
	LastUpdated *time.Time           `json:"lastUpdated,omitempty"`
	Provider    string               `json:"provider,omitempty"`
	Status      string               `json:"status,omitempty"`
	Verify      *VerifyFactorRequest `json:"verify,omitempty"`
}

func NewUserFactor() *UserFactor {
	return &UserFactor{}
}

func (a *UserFactor) IsUserFactorInstance() bool {
	return true
}

// Unenrolls an existing factor for the specified user, allowing the user to enroll a new factor.
func (m *UserFactorResource) DeleteFactor(ctx context.Context, userId string, factorId string) (*Response, error) {
	url := fmt.Sprintf("/api/v1/users/%v/factors/%v", userId, factorId)

	req, err := m.client.requestExecutor.WithAccept("application/json").WithContentType("application/json").NewRequest("DELETE", url, nil)
	if err != nil {
		return nil, err
	}

	resp, err := m.client.requestExecutor.Do(ctx, req, nil)
	if err != nil {
		return resp, err
	}

	return resp, nil
}

// Enumerates all the enrolled factors for the specified user
func (m *UserFactorResource) ListFactors(ctx context.Context, userId string) ([]Factor, *Response, error) {
	url := fmt.Sprintf("/api/v1/users/%v/factors", userId)

	req, err := m.client.requestExecutor.WithAccept("application/json").WithContentType("application/json").NewRequest("GET", url, nil)
	if err != nil {
		return nil, nil, err
	}

	var userFactor []UserFactor

	resp, err := m.client.requestExecutor.Do(ctx, req, &userFactor)
	if err != nil {
		return nil, resp, err
	}

	factors := make([]Factor, len(userFactor))
	for i := range userFactor {
		factors[i] = &userFactor[i]
	}
	return factors, resp, nil

}

// Enrolls a user with a supported factor.
func (m *UserFactorResource) EnrollFactor(ctx context.Context, userId string, body Factor, qp *query.Params) (Factor, *Response, error) {
	url := fmt.Sprintf("/api/v1/users/%v/factors", userId)
	if qp != nil {
		url = url + qp.String()
	}

	req, err := m.client.requestExecutor.WithAccept("application/json").WithContentType("application/json").NewRequest("POST", url, body)
	if err != nil {
		return nil, nil, err
	}

	var userFactor *UserFactor

	resp, err := m.client.requestExecutor.Do(ctx, req, &userFactor)
	if err != nil {
		return nil, resp, err
	}

	return userFactor, resp, nil
}

// Enumerates all the supported factors that can be enrolled for the specified user
func (m *UserFactorResource) ListSupportedFactors(ctx context.Context, userId string) ([]Factor, *Response, error) {
	url := fmt.Sprintf("/api/v1/users/%v/factors/catalog", userId)

	req, err := m.client.requestExecutor.WithAccept("application/json").WithContentType("application/json").NewRequest("GET", url, nil)
	if err != nil {
		return nil, nil, err
	}

	var userFactor []UserFactor

	resp, err := m.client.requestExecutor.Do(ctx, req, &userFactor)
	if err != nil {
		return nil, resp, err
	}

	factors := make([]Factor, len(userFactor))
	for i := range userFactor {
		factors[i] = &userFactor[i]
	}
	return factors, resp, nil

}

// Enumerates all available security questions for a user's `question` factor
func (m *UserFactorResource) ListSupportedSecurityQuestions(ctx context.Context, userId string) ([]*SecurityQuestion, *Response, error) {
	url := fmt.Sprintf("/api/v1/users/%v/factors/questions", userId)

	req, err := m.client.requestExecutor.WithAccept("application/json").WithContentType("application/json").NewRequest("GET", url, nil)
	if err != nil {
		return nil, nil, err
	}

	var securityQuestion []*SecurityQuestion

	resp, err := m.client.requestExecutor.Do(ctx, req, &securityQuestion)
	if err != nil {
		return nil, resp, err
	}

	return securityQuestion, resp, nil
}

// Fetches a factor for the specified user
func (m *UserFactorResource) GetFactor(ctx context.Context, userId string, factorId string, factorInstance Factor) (Factor, *Response, error) {
	url := fmt.Sprintf("/api/v1/users/%v/factors/%v", userId, factorId)

	req, err := m.client.requestExecutor.WithAccept("application/json").WithContentType("application/json").NewRequest("GET", url, nil)
	if err != nil {
		return nil, nil, err
	}

	var userFactor *UserFactor

	resp, err := m.client.requestExecutor.Do(ctx, req, &userFactor)
	if err != nil {
		return nil, resp, err
	}

	return userFactor, resp, nil
}

// The `sms` and `token:software:totp` factor types require activation to complete the enrollment process.
func (m *UserFactorResource) ActivateFactor(ctx context.Context, userId string, factorId string, body ActivateFactorRequest, factorInstance Factor) (Factor, *Response, error) {
	url := fmt.Sprintf("/api/v1/users/%v/factors/%v/lifecycle/activate", userId, factorId)

	req, err := m.client.requestExecutor.WithAccept("application/json").WithContentType("application/json").NewRequest("POST", url, body)
	if err != nil {
		return nil, nil, err
	}

	var userFactor *UserFactor

	resp, err := m.client.requestExecutor.Do(ctx, req, &userFactor)
	if err != nil {
		return nil, resp, err
	}

	return userFactor, resp, nil
}

// Polls factors verification transaction for status.
func (m *UserFactorResource) GetFactorTransactionStatus(ctx context.Context, userId string, factorId string, transactionId string) (*VerifyUserFactorResponse, *Response, error) {
	url := fmt.Sprintf("/api/v1/users/%v/factors/%v/transactions/%v", userId, factorId, transactionId)

	req, err := m.client.requestExecutor.WithAccept("application/json").WithContentType("application/json").NewRequest("GET", url, nil)
	if err != nil {
		return nil, nil, err
	}

	var verifyUserFactorResponse *VerifyUserFactorResponse

	resp, err := m.client.requestExecutor.Do(ctx, req, &verifyUserFactorResponse)
	if err != nil {
		return nil, resp, err
	}

	return verifyUserFactorResponse, resp, nil
}

// Verifies an OTP for a `token` or `token:hardware` factor
func (m *UserFactorResource) VerifyFactor(ctx context.Context, userId string, factorId string, body VerifyFactorRequest, factorInstance Factor, qp *query.Params) (*VerifyUserFactorResponse, *Response, error) {
	url := fmt.Sprintf("/api/v1/users/%v/factors/%v/verify", userId, factorId)
	if qp != nil {
		url = url + qp.String()
	}

	req, err := m.client.requestExecutor.WithAccept("application/json").WithContentType("application/json").NewRequest("POST", url, body)
	if err != nil {
		return nil, nil, err
	}

	var verifyUserFactorResponse *VerifyUserFactorResponse

	resp, err := m.client.requestExecutor.Do(ctx, req, &verifyUserFactorResponse)
	if err != nil {
		return nil, resp, err
	}

	return verifyUserFactorResponse, resp, nil
}