Class ApiKeyDefinition


  • @Metadata(label="rest,security,configuration")
    public class ApiKeyDefinition
    extends RestSecurityDefinition
    Rest security basic auth definition
    • Constructor Detail

      • ApiKeyDefinition

        public ApiKeyDefinition()
    • Method Detail

      • getName

        public String getName()
      • setName

        public void setName​(String name)
        The name of the header or query parameter to be used.
      • getInHeader

        public String getInHeader()
      • setInHeader

        public void setInHeader​(String inHeader)
        To use header as the location of the API key.
      • getInQuery

        public String getInQuery()
      • setInQuery

        public void setInQuery​(String inQuery)
        To use query parameter as the location of the API key.
      • getInCookie

        public String getInCookie()
      • setInCookie

        public void setInCookie​(String inCookie)
        To use a cookie as the location of the API key.