Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Code Block
{ 
  "apiKey": 50,
  "type": "request",
  "name": "DescribeScramUsersRequest",
  "validVersions": "0",
  "flexibleVersions": "0+",
  "fields": [
    { "name": "Users", "type": "[]UserName", "versions": "0+", "nullableVersions": "0+",
      "about": "The users to describe, or null to describe all users.", "fields": [
      { "name": "Name", "type": "string", "versions": "0+",
        "about": "The user name." }
    ]},
  ]
}

{ 
  "apiKey": 50, 
  "type": "response",
  "name": "DescribeScramUsersResponse", 
  "validVersions": "0", 
  "flexibleVersions": "0+", 
  "fields": [ 
    { "name": "ErrorThrottleTimeMs", "type": "int16int32", "versions": "0+",
      "about": "The message-level error code time spent waiting for quota." },
    { "name": "ErrorMessageError", "type": "stringint16", "versions": "0+", "nullableVersions": "0+",
      "about": "The message-level error messagecode." },
    { "name": "UsersErrorMessage", "type": "[]ScramUserstring", "versions": "0+", "nullableVersions": "0+",
      "about": "The SCRAM usersmessage-level error message.", "fields": [ },
      { "name": "NameUsers", "type": "string[]ScramUser", "versions": "0+",
        "about": "The userSCRAM nameusers." },, "fields": [
      { "name": "MechanismInfosName", "type": "ScramUserMechanismInfostring", "versions": "0+",
        "about": "The user name." },
        { "name": "MechanismMechanismInfos", "type": "int8[]ScramUserMechanismInfo", "versions": "0+",
          "about": "The SCRAM mechanism mechanisms associated with the user." },
   "fields": [
        { "name": "IterationsMechanism", "type": "int32int8", "versions": "0+",
          "about": "The number of iterations used in the SCRAM mechanism." },
        }
    ]}
  ]
}

 { "name": "Iterations", "type": "int32", "versions": "0+",
          "about": "The number of iterations used in the SCRAM mechanism." }
      }
    ]}
  ]
}

It will require ALTER permissions on the CLUSTER resource.  It will return CLUSTER_AUTHORIZATION_FAILED if the user has insufficient permissions.

...

Code Block
languagejava
{ 
  "apiKey": 51, 
  "type": "request",
  "name": "AlterScramUsersRequest",
  "validVersions": "0", 
  "flexibleVersions": "0+", 
  "fields": [ 
    { "name": "Alterations", "type": "[]ScramUserAlteration", "versions": "0+",
      "about": "The SCRAM users to create or alter.", "fields": [
      { "name": "Name", "type": "string", "versions": "0+",
        "about": "The user name." }
      { "name": "Deletions", "type": "[]ScramCredentialDeletion", "versions": "0+",
        "about": "The credentials to delete.", "fields": [
        { "name": "Mechanism", "type": "int8", "versions": "0+",
          "about": "The SCRAM mechanism." }
      ]},
      { "name": "Additions", "type": "[]ScramCredentialAddition", "versions": "0+",
        "about": "The SCRAM credentials to add." }
        { "name": "Mechanism", "type": "int8", "versions": "0+",
          "about": "The SCRAM mechanism." },
        { "name": "Iterations", "type": "int32", "versions": "0+",
          "about": "The number of iterations, or -1 to use the server default." },
        { "name": "Salt", "type": "bytes", "versions": "0+", ",
          "about": "A random salt generated by the client." },
        { "name": "SaltedPassword", "type": "bytes", "versions": "0+", ",
          "about": "The salted password." }
      ]}
    ]}
  ]
}

{ 
  "apiKey": 51, 
  "type": "response",
  "name": "AlterScramUsersResponse",
  "validVersions": "0", 
  "flexibleVersions": "0+", 
  "fields": [ 
    { "name": "ThrottleTimeMs", "type": "int32", "versions": "0+",
      "about": "The time spent waiting for quota." }, 
    { "name": "Results", "type": "[]AlterScramUsersResult", "versions": "0+",
      "about": "The results for alterations, in the same order as the request.", "fields": [
        { "name": "User", "type": "string", "versions": "0+",
          "about": "The user name." },
        { "name": "ErrorCode", "type": "int8", "versions": "0+",
          "about": "The error code." },
        { "name": "ErrorString", "type": "string", "versions": "0+", "nullableVersions": "0+",
          "about": "The error message, if any." }
    ]}  
  ]       
}   

...