Skip to content

Commit 48e7aee

Browse files
revise text for service account
1 parent 0ef95ba commit 48e7aee

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

docs/Service-Account.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,17 +7,19 @@ 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+
***Access Key ID*** - username of the object-storage user account - eg: *energy_user_1*
1111

12-
***Accesskeysecret:** The associated secret key for the service account.
12+
***Secret Access Key*** - secret or password for the object-storage user account - eg: *f6jGUSrmd9gdQg6*
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-
***x-amz-bucket:*** The name of the bucket being accessed by the service account.
18+
***bucket*** (*x-amz-bucket*) - Name/ID of the object-storage bucket - eg: *abcdef*
1919

20-
***x-amz-endpoint:*** The endpoint to which the request is directed.
20+
***endpoint*** (*x-amz-endpoint*) Object Storage Service Endpoint - object-storage service url - eg: *https://nrs.objectstore.gov.bc.ca/*
21+
22+
The endpoint to which the request is directed.
2123

2224
### Security Considerations
2325

0 commit comments

Comments
 (0)