rest-api-spec.api.security.put_role.json Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of rest-api-spec Show documentation

Elasticsearch subproject :rest-api-spec

There is a newer version: 8.16.0

{
  "security.put_role":{
    "documentation":{
      "url":"https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-put-role.html",
      "description":"Adds and updates roles in the native realm."
    },
    "stability":"stable",
    "visibility":"public",
    "headers":{
      "accept": [ "application/json"],
      "content_type": ["application/json"]
    },
    "url":{
      "paths":[
        {
          "path":"/_security/role/{name}",
          "methods":[
            "PUT",
            "POST"
          ],
          "parts":{
            "name":{
              "type":"string",
              "description":"Role name"
            }
          }
        }
      ]
    },
    "params":{
      "refresh":{
        "type":"enum",
        "options":[
          "true",
          "false",
          "wait_for"
        ],
        "description":"If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes."
      }
    },
    "body":{
      "description":"The role to add",
      "required":true
    }
  }
}