Skip to content

Commit 0ef95ba

Browse files
Merge pull request #8 from bcgov/service_account
Update Service account docs
2 parents e7c9f99 + c4b48e4 commit 0ef95ba

File tree

2 files changed

+10
-11
lines changed

2 files changed

+10
-11
lines changed

docs/Config.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -72,9 +72,10 @@ Basic Auth can also be used where machine-to-machine API access is required. Thi
7272
7373
```sh
7474
"basicAuth": {
75-
"enabled": “true", # note: to disable, delete this environment variable
75+
"enabled": "true", # note: to disable, delete this environment variable
76+
7677
"s3AccessMode": "true",
77-
78+
7879
"password": "<custom Basic Auth Password.",
7980
"username": "<custom Basic Auth Username>"
8081
},
@@ -83,8 +84,8 @@ Basic Auth can also be used where machine-to-machine API access is required. Thi
8384
In this case, storage credentials provided by the optimization teams are used to grant access. The following are used as user and password:
8485
8586
```sh
86-
accesskeyid
87-
accesskeysecret
87+
Accesskeyid
88+
Accesskeysecret
8889
```
8990
9091
Additional request params: bucket and endpoint must be provided in the request headers using the following key-value pairs:

docs/Service-Account.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
## Service Account API access**
1+
## Service Account API access
22

33
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.
44

@@ -7,22 +7,20 @@ Service account feature for COMS can be enabled by setting s3AccessMode enabled
77
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.
88

99
#### Service Account Credentials:
10-
**accesskeyid:*** The unique identifier for the service account.
10+
***Accesskeyid:*** The unique identifier for the service account.
1111

12-
**accesskeysecret:** The associated secret key for the service account.
12+
***Accesskeysecret:** The associated secret key for the service account.
1313

1414
#### Set Request Headers and Parameters
1515

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

18-
**Headers to Include**:
19-
2018
***x-amz-bucket:*** The name of the bucket being accessed by the service account.
2119

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

2422
### Security Considerations
2523

26-
* **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.
24+
***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.
2725

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

0 commit comments

Comments
 (0)