Class CodelessConnectorPollingAuthProperties

java.lang.Object
com.azure.resourcemanager.securityinsights.models.CodelessConnectorPollingAuthProperties

public final class CodelessConnectorPollingAuthProperties extends Object
Describe the authentication properties needed to successfully authenticate with the server.
  • Constructor Details

    • CodelessConnectorPollingAuthProperties

      public CodelessConnectorPollingAuthProperties()
  • Method Details

    • authType

      public String authType()
      Get the authType property: The authentication type.
      Returns:
      the authType value.
    • withAuthType

      public CodelessConnectorPollingAuthProperties withAuthType(String authType)
      Set the authType property: The authentication type.
      Parameters:
      authType - the authType value to set.
      Returns:
      the CodelessConnectorPollingAuthProperties object itself.
    • apiKeyName

      public String apiKeyName()
      Get the apiKeyName property: The header name which the token is sent with.
      Returns:
      the apiKeyName value.
    • withApiKeyName

      public CodelessConnectorPollingAuthProperties withApiKeyName(String apiKeyName)
      Set the apiKeyName property: The header name which the token is sent with.
      Parameters:
      apiKeyName - the apiKeyName value to set.
      Returns:
      the CodelessConnectorPollingAuthProperties object itself.
    • apiKeyIdentifier

      public String apiKeyIdentifier()
      Get the apiKeyIdentifier property: A prefix send in the header before the actual token.
      Returns:
      the apiKeyIdentifier value.
    • withApiKeyIdentifier

      public CodelessConnectorPollingAuthProperties withApiKeyIdentifier(String apiKeyIdentifier)
      Set the apiKeyIdentifier property: A prefix send in the header before the actual token.
      Parameters:
      apiKeyIdentifier - the apiKeyIdentifier value to set.
      Returns:
      the CodelessConnectorPollingAuthProperties object itself.
    • isApiKeyInPostPayload

      public String isApiKeyInPostPayload()
      Get the isApiKeyInPostPayload property: Marks if the key should sent in header.
      Returns:
      the isApiKeyInPostPayload value.
    • withIsApiKeyInPostPayload

      public CodelessConnectorPollingAuthProperties withIsApiKeyInPostPayload(String isApiKeyInPostPayload)
      Set the isApiKeyInPostPayload property: Marks if the key should sent in header.
      Parameters:
      isApiKeyInPostPayload - the isApiKeyInPostPayload value to set.
      Returns:
      the CodelessConnectorPollingAuthProperties object itself.
    • flowName

      public String flowName()
      Get the flowName property: Describes the flow name, for example 'AuthCode' for Oauth 2.0.
      Returns:
      the flowName value.
    • withFlowName

      public CodelessConnectorPollingAuthProperties withFlowName(String flowName)
      Set the flowName property: Describes the flow name, for example 'AuthCode' for Oauth 2.0.
      Parameters:
      flowName - the flowName value to set.
      Returns:
      the CodelessConnectorPollingAuthProperties object itself.
    • tokenEndpoint

      public String tokenEndpoint()
      Get the tokenEndpoint property: The endpoint used to issue a token, used in Oauth 2.0 flow.
      Returns:
      the tokenEndpoint value.
    • withTokenEndpoint

      public CodelessConnectorPollingAuthProperties withTokenEndpoint(String tokenEndpoint)
      Set the tokenEndpoint property: The endpoint used to issue a token, used in Oauth 2.0 flow.
      Parameters:
      tokenEndpoint - the tokenEndpoint value to set.
      Returns:
      the CodelessConnectorPollingAuthProperties object itself.
    • authorizationEndpoint

      public String authorizationEndpoint()
      Get the authorizationEndpoint property: The endpoint used to authorize the user, used in Oauth 2.0 flow.
      Returns:
      the authorizationEndpoint value.
    • withAuthorizationEndpoint

      public CodelessConnectorPollingAuthProperties withAuthorizationEndpoint(String authorizationEndpoint)
      Set the authorizationEndpoint property: The endpoint used to authorize the user, used in Oauth 2.0 flow.
      Parameters:
      authorizationEndpoint - the authorizationEndpoint value to set.
      Returns:
      the CodelessConnectorPollingAuthProperties object itself.
    • authorizationEndpointQueryParameters

      public Object authorizationEndpointQueryParameters()
      Get the authorizationEndpointQueryParameters property: The query parameters used in authorization request, used in Oauth 2.0 flow.
      Returns:
      the authorizationEndpointQueryParameters value.
    • withAuthorizationEndpointQueryParameters

      public CodelessConnectorPollingAuthProperties withAuthorizationEndpointQueryParameters(Object authorizationEndpointQueryParameters)
      Set the authorizationEndpointQueryParameters property: The query parameters used in authorization request, used in Oauth 2.0 flow.
      Parameters:
      authorizationEndpointQueryParameters - the authorizationEndpointQueryParameters value to set.
      Returns:
      the CodelessConnectorPollingAuthProperties object itself.
    • redirectionEndpoint

      public String redirectionEndpoint()
      Get the redirectionEndpoint property: The redirect endpoint where we will get the authorization code, used in Oauth 2.0 flow.
      Returns:
      the redirectionEndpoint value.
    • withRedirectionEndpoint

      public CodelessConnectorPollingAuthProperties withRedirectionEndpoint(String redirectionEndpoint)
      Set the redirectionEndpoint property: The redirect endpoint where we will get the authorization code, used in Oauth 2.0 flow.
      Parameters:
      redirectionEndpoint - the redirectionEndpoint value to set.
      Returns:
      the CodelessConnectorPollingAuthProperties object itself.
    • tokenEndpointHeaders

      public Object tokenEndpointHeaders()
      Get the tokenEndpointHeaders property: The query headers used in token request, used in Oauth 2.0 flow.
      Returns:
      the tokenEndpointHeaders value.
    • withTokenEndpointHeaders

      public CodelessConnectorPollingAuthProperties withTokenEndpointHeaders(Object tokenEndpointHeaders)
      Set the tokenEndpointHeaders property: The query headers used in token request, used in Oauth 2.0 flow.
      Parameters:
      tokenEndpointHeaders - the tokenEndpointHeaders value to set.
      Returns:
      the CodelessConnectorPollingAuthProperties object itself.
    • tokenEndpointQueryParameters

      public Object tokenEndpointQueryParameters()
      Get the tokenEndpointQueryParameters property: The query parameters used in token request, used in Oauth 2.0 flow.
      Returns:
      the tokenEndpointQueryParameters value.
    • withTokenEndpointQueryParameters

      public CodelessConnectorPollingAuthProperties withTokenEndpointQueryParameters(Object tokenEndpointQueryParameters)
      Set the tokenEndpointQueryParameters property: The query parameters used in token request, used in Oauth 2.0 flow.
      Parameters:
      tokenEndpointQueryParameters - the tokenEndpointQueryParameters value to set.
      Returns:
      the CodelessConnectorPollingAuthProperties object itself.
    • isClientSecretInHeader

      public Boolean isClientSecretInHeader()
      Get the isClientSecretInHeader property: Marks if we should send the client secret in header or payload, used in Oauth 2.0 flow.
      Returns:
      the isClientSecretInHeader value.
    • withIsClientSecretInHeader

      public CodelessConnectorPollingAuthProperties withIsClientSecretInHeader(Boolean isClientSecretInHeader)
      Set the isClientSecretInHeader property: Marks if we should send the client secret in header or payload, used in Oauth 2.0 flow.
      Parameters:
      isClientSecretInHeader - the isClientSecretInHeader value to set.
      Returns:
      the CodelessConnectorPollingAuthProperties object itself.
    • scope

      public String scope()
      Get the scope property: The OAuth token scope.
      Returns:
      the scope value.
    • withScope

      Set the scope property: The OAuth token scope.
      Parameters:
      scope - the scope value to set.
      Returns:
      the CodelessConnectorPollingAuthProperties object itself.
    • validate

      public void validate()
      Validates the instance.
      Throws:
      IllegalArgumentException - thrown if the instance is not valid.