| D toc |
|---|
| D s ed | ||||
|---|---|---|---|---|
|
| Excerpt | ||||
|---|---|---|---|---|
This section provides some task information for how to use API access tokens as part of your API projects in
|
Notes:
- An access token is linked to its creator and can be generated by submitting a username/password combination or another valid token from the same user.
- If a token is created for userA, userB can be provided the token to impersonate userA.
- You cannot create access tokens for users without their authentication credentials.
- Changes to passwords do not affect tokens.
- After a token has been created, it cannot be modified or extended.
- You can create an unlimited number of tokens.
- Access tokens can be used for authentication with any supported version of the APIs.
Enable
Access to the APIs must be enabled by the project owner for the project.
Enable individual access
When access tokens are enabled, by default only administrators are permitted to generate tokens. Optionally, project administrators can enable individual users in the workspace to generate and use their own API access tokens. For more information, see Dataprep Project Settings Page.
Generate New Token
API access tokens must be created.
| Info |
|---|
NOTE: Access tokens are issued per project. Your product edition and available endpoints may vary between projects. |
Via UI
Tokens can be generated from the web application.
Steps:
- Login to the
.D s webapp - From the left nav bar, select User menu > Preferences > Access Tokens.
- Click Generate New Token.
Specify the number of days for how long the token should live.
Tip Tip: Depending on how your environment is configured, you may be able to enter
-1to create a non-expiring token.- Add a user-friendly description if desired.
- Click Generate.
| Info |
|---|
NOTE: Copy the value of the token to the clipboard and store it in a secure location for use with your scripts. For security reasons, the token value itself cannot be retrieved from the application after it has been created. |
For more information, see Access Tokens Page.
Use Token
After a token has been acquired, it must be included in each request to the server, for as long as it is valid.
| Info |
|---|
NOTE: After a token has been created, it cannot be extended or modified. |
| Info | |
|---|---|
NOTE: API access tokens are not used by users through the
|
After you have acquired the token, you submit it with each API request to the platform.
Example - cURL:
The following example returns a JSON version of the list of available REST API endpoints for your environment:
| Code Block | ||
|---|---|---|
| ||
curl https://www.api.clouddataprep.com/v4/open-api-spec -X GET -H "Authorization: Bearer (tokenValue)" |
(tokenValue)is the value returned for the token when it was created.
Example - REST client:
If you are submitting your API calls through a REST client, the Authorization header must be specified as follows:
| Code Block |
|---|
Authorization: Bearer (tokenValue) |
Renew Token
New tokens can be acquired at any time.
| Info |
|---|
NOTE: It is the responsibility of the user to acquire a new API token before the current one expires. If a token is permitted to expire, a request for a new token must include userId and password information. |
- See Access Tokens Page.
Delete Token
- Via UI: In the Access Tokens page, select Delete Token... from the context menu for the token listing. See Access Tokens Page.
| D s also | ||
|---|---|---|
|
