Skip to content

Commit 9457725

Browse files
authored
Merge pull request #774 from jetstack/docs-links-updates
Update links to non-broken page
2 parents 2120312 + dca15a8 commit 9457725

1 file changed

Lines changed: 4 additions & 2 deletions

File tree

internal/cyberark/identity/identity.go

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ var (
5252
)
5353

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

@@ -358,6 +359,7 @@ func (c *Client) doStartAuthentication(ctx context.Context, username string) (ad
358359

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

0 commit comments

Comments
 (0)