Skip to content
This repository was archived by the owner on Sep 2, 2025. It is now read-only.

Commit 6871815

Browse files
create token changes part 1
1 parent b4d9bb5 commit 6871815

File tree

1 file changed

+53
-31
lines changed

1 file changed

+53
-31
lines changed

admin/authentication/authentication-tokens/org-tokens.rst

Lines changed: 53 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -74,10 +74,10 @@ To manage your access (org) tokens:
7474
#. To update the token, select :guilabel:`Update`.
7575

7676

77-
View and copy access tokens
78-
==============================
77+
View and copy access token secrets
78+
====================================
7979

80-
To view the value of an access token, select the token name and then select :guilabel:`Show Token`.
80+
To view the token secret, select the token name and then select :guilabel:`Show Token`.
8181

8282
To copy the token value, select :guilabel:`Copy`. You don't need to be an administrator to view or copy an access token.
8383

@@ -87,53 +87,66 @@ To copy the token value, select :guilabel:`Copy`. You don't need to be an admini
8787
Create an access token
8888
==========================
8989

90+
To create an access token, complete
91+
9092
.. note::
9193

92-
To do the following tasks, you must be an organization administrator.
94+
You must be an organization administrator to create access tokens.
9395

94-
To create an access token:
96+
#. Name the token and select the authorization scope
97+
-------------------------------------------------------------------------
98+
99+
To get started with creating the token, enter a name and scope for the token. Complete the following steps:
95100

96101
#. Open the Splunk Observability Cloud main menu.
97102
#. Select :menuselection:`Settings` and select :menuselection:`Access Tokens`.
98-
#. Select :guilabel:`New Token`. If your organization has a long list of access tokens, you might need to scroll down to the bottom of the list to access this button.
103+
#. Select :guilabel:`New Token`.
99104
#. Enter a unique token name. If you enter a token name that is already in use, even if the token is inactive, Splunk Observability Cloud doesn't accept the name.
100-
#. Select an authorization scope for the token from 1 of the following values:
101-
102-
.. note:: Assign only 1 authorization scope to each token. Applying both the :strong:`API` and :strong:`Ingest` authorization scopes to the same token might raise a security concern.
105+
#. Select an authorization scope. See the following table for information about the authorization scopes:
103106

104-
- :strong:`RUM Token`: Select this authorization scope to use the token to authenticate with RUM ingest endpoints. These endpoints use the following base URL: :code:`https://rum-ingest.<REALM>.signalfx.com/v1/rum`.
105-
106-
.. caution::
107-
RUM displays the RUM token in URIs that are visible in a browser. To preserve security, you can't assign the :strong:`Ingest` or :strong:`API` authorization scope to a RUM token.
107+
.. list-table::
108+
:header-rows: 1
108109

109-
- :strong:`Ingest Token`: Select this authorization scope to use the token to authenticate with data ingestion endpoints. These endpoints use the following base URLs:
110+
* - Authorization scope
111+
- Description
112+
* - RUM token
113+
- Use this scope to authenticate with RUM ingest endpoints. These endpoints use the following base URL: ``https://rum-ingest.<REALM>.signalfx.com/v1/rum``.
114+
* - Ingest token
115+
- Use this scope to authenticate with data ingestion endpoints and when using the Splunk Distribution of OpenTelemetry Collector. These endpoints use the following base URLs:
110116

111-
- POST :code:`https://ingest.<REALM>.signalfx.com/v2/datapoint`
112-
- POST :code:`https://ingest.<REALM>.signalfx.com/v2/datapoint/otlp`
113-
- POST :code:`https://ingest.<REALM>.signalfx.com/v2/event`
114-
- POST :code:`https://ingest.<REALM>.signalfx.com/v1/trace`
117+
* POST :code:`https://ingest.<REALM>.signalfx.com/v2/datapoint`
118+
* POST :code:`https://ingest.<REALM>.signalfx.com/v2/datapoint/otlp`
119+
* POST :code:`https://ingest.<REALM>.signalfx.com/v2/event`
120+
* POST :code:`https://ingest.<REALM>.signalfx.com/v1/trace`
115121

116-
For information about these endpoints, see :new-page:`Sending data points <https://dev.splunk.com/observability/docs/datamodel/ingest/>`.
122+
For information about these endpoints, see :new-page:`Sending data points <https://dev.splunk.com/observability/docs/datamodel/ingest/>`.
123+
* - API token
124+
- Use this scope to authenticate with Splunk Observability Cloud API endpoints. These endpoints use the following base URLs:
117125

118-
.. note:: Use the ingest autorization scope for the Splunk Distribution of the OpenTelemetry Collector. See :ref:`otel-intro`.
119-
- :strong:`API Token`: Select this authorization scope to use the token to authenticate with Splunk Observability Cloud endpoints. Example use cases are Terraform, programmatic usage of the API for business objects, and so on. These endpoints use the following base URLs:
120-
121-
- :code:`https://api.<REALM>.signalfx.com`
122-
- :code:`wss://stream.<REALM>.signalfx.com`
126+
* :code:`https://api.<REALM>.signalfx.com`
127+
* :code:`wss://stream.<REALM>.signalfx.com`
123128

124-
When you create an access token with API authentication scope, select at least one Splunk Observability Cloud role to associate with the token. You can select from ``power``, ``usage``, or ``read_only``. To learn more about Splunk Observability Cloud roles, see :ref:`roles-and-capabilities`.
129+
When you create an access token with API authentication scope, select at least one Splunk Observability Cloud role to associate with the token. You can select from ``power``, ``usage``, or ``read_only``. To learn more about Splunk Observability Cloud roles, see :ref:`roles-and-capabilities`.
125130

126-
For information about these endpoints, see :new-page:`Summary of Splunk Observability Cloud API Endpoints <https://dev.splunk.com/observability/docs/apibasics/api_list/>`.
131+
For information about these endpoints, see :new-page:`Summary of Splunk Observability Cloud API Endpoints <https://dev.splunk.com/observability/docs/apibasics/api_list/>`.
127132

128-
#. Edit the visibility permissions:
133+
#. (Optional) Add a description for the token.
134+
#. Select :guilabel:`Next` to continue to the next step.
129135

130-
#. To display the available permissions, select the right arrow in the :guilabel:`Access Token Permissions` box. The following
131-
permission options appear:
136+
#. Determine who can view and use the token
137+
--------------------------------------------------------
138+
139+
Next, configure token permissions so your organization's users and teams can use the token. Complete the following steps:
140+
141+
#. Edit the visibility permissions. To display the available permissions, select the :guilabel:`Access Token Permissions` box. The following
142+
permission options appear:
132143

133144
* :menuselection:`Only Admins can Read`: Only admin users can view or read the new token. The token isn't visible to other users.
134145
* :menuselection:`Admins and Select Users or Teams can Read`: Admin users and users or teams you select can view or read the new token. The token isn't visible to anyone else.
135146
* :menuselection:`Everyone can Read`: Every user and team in the organization can view and read the token.
136-
#. To add permissions, select the arrow below :guilabel:`Access Token Permissions`.
147+
148+
To add permissions, select the arrow below :guilabel:`Access Token Permissions`.
149+
137150
#. If you selected :guilabel:`Admins and Select Users or Teams can Read`, select the users or teams to whom you want to give access:
138151

139152
#. Select :guilabel:`Add Team or User`. Splunk Observability Cloud displays a list of teams and users in your organization.
@@ -150,8 +163,17 @@ To create an access token:
150163
This message means that all users are able to join the team and then view or read the access token.
151164

152165
#. To remove a team or user, select the delete icon (:strong:`X`) next to the team or username.
153-
#. To create the new token, select :guilabel:`Create`.
154166

167+
#. Select :guilabel:`Next` to continue to the final step.
168+
169+
#. Configure an expiration date
170+
-----------------------------------------------
171+
172+
To finish creating the token, select an expiration date for the token.
173+
174+
#. In the :guilabel:`Expiration date` box, select a date at which the token will expire. The date can't be over 5 years from the token creation date.
175+
176+
#. To create the new token, select :guilabel:`Create`.
155177

156178
.. _access-token-rotate:
157179

0 commit comments

Comments
 (0)