Skip to content

Update Service account docs #8

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 8, 2025
Merged

Update Service account docs #8

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions docs/Config.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,9 +72,10 @@ Basic Auth can also be used where machine-to-machine API access is required. Thi

```sh
"basicAuth": {
"enabled": “true", # note: to disable, delete this environment variable
"enabled": "true", # note: to disable, delete this environment variable

"s3AccessMode": "true",

"password": "<custom Basic Auth Password.",
"username": "<custom Basic Auth Username>"
},
Expand All @@ -83,8 +84,8 @@ Basic Auth can also be used where machine-to-machine API access is required. Thi
In this case, storage credentials provided by the optimization teams are used to grant access. The following are used as user and password:

```sh
accesskeyid
accesskeysecret
Accesskeyid
Accesskeysecret
```

Additional request params: bucket and endpoint must be provided in the request headers using the following key-value pairs:
Expand Down
12 changes: 5 additions & 7 deletions docs/Service-Account.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
## Service Account API access**
## Service Account API access

Service account feature for COMS can be enabled by setting s3AccessMode enabled in configuration, it allows automated systems or services to securely interact with the COMS environment using access keys for authentication. Below are the steps for configuring and utilizing s3AccessMode.

Expand All @@ -7,22 +7,20 @@ Service account feature for COMS can be enabled by setting s3AccessMode enabled
For M2M API access, the storage credentials are used to authenticate API requests. These credentials consist of an Access Key ID and Access Key Secret, which are essential for machine-to-machine communication.

#### Service Account Credentials:
**accesskeyid:*** The unique identifier for the service account.
***Accesskeyid:*** The unique identifier for the service account.

**accesskeysecret:** The associated secret key for the service account.
***Accesskeysecret:** The associated secret key for the service account.

#### Set Request Headers and Parameters

With s3AccessMode enabled, the M2M communication requires specific headers to authenticate and provide access correctly.

**Headers to Include**:

***x-amz-bucket:*** The name of the bucket being accessed by the service account.

***x-amz-endpoint:*** The endpoint to which the request is directed.

### Security Considerations

* **Store Credentials Securely**: Ensure the accesskeyid and accesskeysecret are stored securely, such as in environment variables or a secure credential vault, to prevent unauthorized access.
***Store Credentials Securely***: Ensure the accesskeyid and accesskeysecret are stored securely, such as in environment variables or a secure credential vault, to prevent unauthorized access.

* **Use HTTPS**: Make sure that all API requests are made over HTTPS to protect sensitive data during transmission.
***Use HTTPS***: Make sure that all API requests are made over HTTPS to protect sensitive data during transmission.