Skip to content

Commit

Permalink
docs: link to APM privs for API keys (#20911)
Browse files Browse the repository at this point in the history
  • Loading branch information
bmorelli25 authored Sep 17, 2020
1 parent 568fbff commit 6c47e5b
Showing 1 changed file with 6 additions and 17 deletions.
23 changes: 6 additions & 17 deletions libbeat/docs/command-reference.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -156,18 +156,7 @@ Create an API Key with the specified privilege(s). No required flags.
+
The user requesting to create an API Key needs to have APM privileges used by the APM Server.
A superuser, by default, has these privileges. For other users,
you can create them. Create a role that is then assigned to the user:
+
["source","sh",subs="attributes"]
----
PUT /_security/role/apm-privileges {
"applications": [{
"application": "apm",
"privileges": ["sourcemap:write", "event:write", "config_agent:read"],
"resources": ["*"]
}]
}
----
you can create them. See <<privileges-api-key,create an API key user>> for required privileges.

*`info`*::
Query API Key(s). `--id` or `--name` required.
Expand Down Expand Up @@ -252,7 +241,7 @@ the credentials required by your cloud service provider.
----

*`FUNCTION_NAME`*::
Specifies the name of the function to deploy.
Specifies the name of the function to deploy.

*FLAGS*

Expand Down Expand Up @@ -498,7 +487,7 @@ ifeval::["{beatname_lc}"=="functionbeat"]
[[package-command]]
==== `package` command

{package-command-short-desc}.
{package-command-short-desc}.

*SYNOPSIS*

Expand All @@ -513,7 +502,7 @@ ifeval::["{beatname_lc}"=="functionbeat"]
Shows help for the `package` command.

*`-o, --output`*::
Specifies the full path pattern to use when creating the packages.
Specifies the full path pattern to use when creating the packages.

{global-flags}

Expand All @@ -538,7 +527,7 @@ the credentials required by your cloud service provider.
----

*`FUNCTION_NAME`*::
Specifies the name of the function to remove.
Specifies the name of the function to remove.

*FLAGS*

Expand Down Expand Up @@ -941,7 +930,7 @@ the credentials required by your cloud service provider.
----

*`FUNCTION_NAME`*::
Specifies the name of the function to update.
Specifies the name of the function to update.

*FLAGS*

Expand Down

0 comments on commit 6c47e5b

Please sign in to comment.