Skip to content

Update links to non-broken page #774

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
SgtCoDFish wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update links to non-broken page #774

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions internal/cyberark/identity/identity.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ var (
)

// startAuthenticationRequestBody is the body sent to the StartAuthentication endpoint in CyberArk Identity;
// see https://api-docs.cyberark.com/docs/identity-api-reference/authentication-and-authorization/operations/create-a-security-start-authentication
// see https://api-docs.cyberark.com/identity-docs-api/docs/security-api#/Login/start-authentication
type startAuthenticationRequestBody struct {
// TenantID is the internal ID of the tenant containing the user attempting to log in. In testing,
// it seems that the subdomain works in this field.
Expand Down Expand Up @@ -135,6 +135,7 @@ type startAuthenticationMechanism struct {
// advanceAuthenticationRequestBody is a request body for the AdvanceAuthentication call to CyberArk Identity,
// which should usually be obtained by making requests to StartAuthentication first.
// WARNING: This struct can hold secret data (a user's password)
// See: https://api-docs.cyberark.com/identity-docs-api/docs/security-api#/Login/advance-authentication
type advanceAuthenticationRequestBody struct {
// Action is a string identifying how we're intending to log in; for username/password, this is
// set to "Answer" to indicate that the password is held in the Answer field
Expand Down Expand Up @@ -227,7 +228,7 @@ func (c *Client) LoginUsernamePassword(ctx context.Context, username string, pas
// It returns a partially initialized advanceAuthenticationRequestBody ready to send to the server to complete
// the login. As this function doesn't have access to the password, it must be added to the returned request body
// by the caller before being used as a request to AdvanceAuthentication.
// See https://api-docs.cyberark.com/docs/identity-api-reference/authentication-and-authorization/operations/create-a-security-start-authentication
// See https://api-docs.cyberark.com/identity-docs-api/docs/security-api#/Login/start-authentication
func (c *Client) doStartAuthentication(ctx context.Context, username string) (advanceAuthenticationRequestBody, error) {
response := advanceAuthenticationRequestBody{}

Expand Down Expand Up @@ -342,6 +343,7 @@ func (c *Client) doStartAuthentication(ctx context.Context, username string) (ad

// doAdvanceAuthentication performs the second step of the login process, sending the password to the server
// and receiving a token in response.
// See: https://api-docs.cyberark.com/identity-docs-api/docs/security-api#/Login/advance-authentication
func (c *Client) doAdvanceAuthentication(ctx context.Context, username string, password *[]byte, requestBody advanceAuthenticationRequestBody) error {
if password == nil {
return fmt.Errorf("password must not be nil; this is a programming error")
Expand Down
Loading