Skip to content

Commit

Permalink
API key update (#1666)
Browse files Browse the repository at this point in the history
* ci: updated labels (#1661)

* docs: api-key changes

* Refactor/restructure cluster & app profiles sections (#1551)

* Add  index pgs, folders, json files post migration

* Added two index pages

* Added two more index pages

* Added a diagram

* Clarify two sentences.

* Applied new link format

* Added cluster profile-related docs

* Copied byoos files to this branch.

* Build out app profile folder

* Added diagram that removes "Core" label

* Copied cluster doc drafts from google doc

* Copied app profile drafts from google doc

* Added links in top-level cluster profile docs

* Refined wording, formatting, added links in 3 docs

* Updated clone cluster and app docs

* Updated versioning for cluster and app profiles

* Added diagram, refined import/export

* Refined steps in export/import

* Fixed one diagram, added a second diagram

* Added a diagram and refined import/export steps

* Refined byo-os docs, drafted delete howtos

* Add correct permissions for import/export

* Fix URLs and add meta descriptions

* Small fixes

* Refined cluster profiles, focus on cluster update

* Final changes to most cluster docs

* Fine tune app profiles, delete system profiles

* Tune app profiles docs

* Tune app profiles docs

* Edit Update Pack Version

* Touched up cluster profiles

* Touch up app profile docs

* Fix several links pointing to new docs

* Fix links, add missing section to add-on profile

* Add info on reusing same layer twice in profile

* Move cluster bkup and system profiles to deprecated

* Fix four more links pointing to these docs

* Add a heading

* Create two new folders: create, modify clusters

* Move BYOOS to top level, add icon, add content

* Add new doc for dup packs in profile, move byoos up

* Fix some  links due to restructure

* Fix three more links

* Fix last two links

* Add redirects, remove sys profile from glossary

* Restructure App Profiles

* Move docs from devx to App Profiles

* Minor fix

* Restructure App Profiles, tags

* Add sub-structure to Cluster Profiles for Add-ons

* Draft create add-on profs with helm and manifest

* Fix link

* Fix links after restructure

* Revised helm & manifest app profiles docs

* Draft Helm, manifest cluster profiles

* Draft container profile, add images

* Proof edits: infra, add-ons

* Move content to new page, rename file, small fixes

* Move services folder up one level in devx

* Fix links after moving Services up one layer

* Edit export/import, clone, delete, other edits

* Edit clone, delete, output vars app profiles docs

* Edit Create App Profiles docs

* Edit Modify App Profiles docs

* Revise enablement headings

* Review meta descs

* Move app profiles from pde folder to deprecated

* docs: removed deprecated content

* Fix links

* Fix Vale finds

* Optimised images with calibre/image-actions

* Input review comments

---------

Co-authored-by: Karl Cardenas <karl@spectrocloud.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

* docs: refactored api documentation PEM-3441 PEM-3373

* Apply suggestions from code review

Co-authored-by: Rita Watson <117382432+ritawatson@users.noreply.github.com>

* Apply suggestions from code review

---------

Co-authored-by: Rita Watson <117382432+ritawatson@users.noreply.github.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
  • Loading branch information
3 people authored Oct 17, 2023
1 parent 6ef626b commit 954d50b
Show file tree
Hide file tree
Showing 23 changed files with 939 additions and 134 deletions.
31 changes: 20 additions & 11 deletions docs/api-content/api-docs/1-introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,21 +16,30 @@ Palette offers a range of capabilities you can access through the REST APIs. The
Every API's URI has the prefix of the version and the Palette resource, such as: `v1/spectroclusters/...`

## Authentication
Palette supports two types of user authentication methods:
Palette supports two types of API authentication methods that can be used to authenticate API requests:

### Using Authorization Token
* All requests must be authenticated with an API token that is passed using the HTTP request header `Authorization`.
* Activated users can use the `/auth/authenticate` API to authenticate and obtain the Authorization token.
* Every authorization token is valid for 15 min.
* To refresh the token use [this GET call](https://docs.spectrocloud.com/api/v1/auth/): `GET /v1/auth/refresh/{token}`
- [Authorization Token](#using-authorization-token)

- [API Key](#using-the-api-key)

### Authorization Token

You can acquire authorization tokens from Palette that have a 15-minute lifetime. The authorization token is passed as part of the HTTP request header. You can use the authorization token to authenticate and authorize the request. The header name is `Authorization`, and the token is the header value. Refer to the [Authorization Token](/user-management/authentication/authorization-token) section to learn more about the authorization token.

### Using the API Key
### API Key

You can use API keys to authenticate with the Palette API. API keys allow you to interact with Palette APIs without requiring user credentials such as username and password. The API key must be present in each API request to authenticate and authorize the request. The API Key is passed as part of the HTTP request header. The header name is `apiKey`, and the API key is the header value.

Palette uses API keys to provide secure API authentication and authorization. This enables the usage of Palette APIs without requiring user credentials such as username and password. The API key must be present in individual API requests in order to authenticate and authorize the request. The API Key is passed as part of the HTTP request header and in the following format:
* Key: ApiKey
* Value: API key copied from the Palette Console. E.g. QMOI1ZVKVIoW6LM6uXqSWFPsjmt0juvl
The following example shows how to pass the API key in the HTTP request header:

```shell hideClipboard
curl --location "https://api.spectrocloud.com/v1/spectroclusters/123456789?ProjectUid=12345678" \
--header 'Accept: application/json' \
--header "apiKey: 123456789"
```

[Read More...](/user-management/user-authentication/#usingapikey)
Refer to the [API Key](/user-management/authentication/api-key/) section to learn how to create and manage API keys.

## Requests

All requests are in the `JSON` format. In general, the request payload has three sections: *metadata, spec and status*.
Expand Down
Loading

0 comments on commit 954d50b

Please sign in to comment.