okta

Documentation

Index

• type Attribute
• type Auth
• type Client
  • func NewClient(host, sessionCookie string) (*Client, error)
  • func (c *Client) Get(path string) (reader io.Reader, err error)
  • func (c *Client) Post(path string, payload []byte) (reader io.Reader, err error)
• type Factor
• type SAMLResponse
  • func Login(conf *config.Config, p input.Prompter, sessionCookie, password string) (*SAMLResponse, string, error)

Types

type Attribute

type Attribute struct {
	Name   string   `xml:"Name,attr"`
	Values []string `xml:"AttributeValue"`
}

Attribute contains SAML attributes.

type Auth

type Auth struct {
	StateToken   string `json:"stateToken"`
	Status       string `json:"status"`
	SessionToken string `json:"sessionToken"`
	Embedded     struct {
		Factors []*Factor `json:"factors"`
	} `json:"_embedded"`
}

Auth represents the authentication response from Okta.

type Client

type Client struct {
	// contains filtered or unexported fields
}

Client contains the necessary information needed to communicate with the Okta API.

func NewClient

func NewClient(host, sessionCookie string) (*Client, error)

NewClient returns a newly configured Client with the given host and possible Okta session cookie. If the session cookie is empty, there was no session previously saved.

func (*Client) Get

func (c *Client) Get(path string) (reader io.Reader, err error)

Get makes an HTTP GET request and returns the response as a string.

func (*Client) Post

func (c *Client) Post(path string, payload []byte) (reader io.Reader, err error)

Post makes an HTTP POST request and returns the response as a string.

type Factor

type Factor struct {
	FactorType string `json:"factorType"`
	Profile    struct {
		CredentialID string `json:"credentialId"`
		PhoneNumber  string `json:"phoneNumber"`
	} `json:"profile"`
	Links struct {
		Verify struct {
			Href string `json:"href"`
		} `json:"verify"`
	} `json:"_links"`
}

Factor contains information about a specific MFA factor.

type SAMLResponse

type SAMLResponse struct {
	XMLName    xml.Name    `xml:"Response"`
	Attributes []Attribute `xml:"Assertion>AttributeStatement>Attribute"`
	Raw        string
}

SAMLResponse contains the parsed SAML assertion, along with the raw base64 encoded response.

func Login

func Login(conf *config.Config, p input.Prompter, sessionCookie, password string) (*SAMLResponse, string, error)

Login to Okta with the given username and password.