com.checkmarx.sdk.service

Interface CxAuthClient

All Known Implementing Classes:

CxAuthService

public interface CxAuthClient

Class used to orchestrate submitting scans and retrieving results

Method Summary

Modifier and Type	Method and Description
org.springframework.http.HttpHeaders	createAuthHeaders() Create REST API Headers for Authentication (JWT/OIDC)
String	getAuthToken(String username, String password, String clientId, String clientSecret, String scope) Authenictate with Checkmarx and Creates a JWT/OIDC access token for Checkmarx REST based resource
String	getCurrentSoapToken()
String	getCurrentToken()
String	getLegacySession()
String	getSoapAuthToken(String username, String password) Authenictate with Checkmarx and Creates a JWT/OIDC for access token for Checkmarx SOAP based resource (9.0 onward)
String	legacyLogin(String username, String password) Authenictate with Checkmarx and Creates a session to access Checkmarx Legacy SOAP based resource

Method Detail

getAuthToken

String getAuthToken(String username,
                    String password,
                    String clientId,
                    String clientSecret,
                    String scope)
             throws InvalidCredentialsException

Authenictate with Checkmarx and Creates a JWT/OIDC access token for Checkmarx REST based resource

Parameters:

username -

password -

clientId -

clientSecret -

Returns:

Throws:

InvalidCredentialsException

getSoapAuthToken

String getSoapAuthToken(String username,
                        String password)
                 throws InvalidCredentialsException

Authenictate with Checkmarx and Creates a JWT/OIDC for access token for Checkmarx SOAP based resource (9.0 onward)

Parameters:

username -

password -

Returns:

Throws:

InvalidCredentialsException

legacyLogin

String legacyLogin(String username,
                   String password)
            throws InvalidCredentialsException

Authenictate with Checkmarx and Creates a session to access Checkmarx Legacy SOAP based resource

Parameters:

username -

password -

Returns:

Throws:

InvalidCredentialsException

createAuthHeaders

org.springframework.http.HttpHeaders createAuthHeaders()

Create REST API Headers for Authentication (JWT/OIDC)

Returns:

getCurrentToken

String getCurrentToken()

getCurrentSoapToken

String getCurrentSoapToken()

getLegacySession

String getLegacySession()