Skip to content

revise text for service account #10

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.

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 11, 2025
Merged
Changes from all commits
Commits
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
8 changes: 4 additions & 4 deletions docs/Service-Account.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,17 +7,17 @@ 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:
Access Key ID - username of the object-storage user account - eg: `energy_user_1`
***Access Key ID*** - username of the object-storage user account - eg: *energy_user_1*

Secret Access Key - secret or password for the object-storage user account - eg: `f6jGUSrmd9gdQg6`
***Secret Access Key*** - secret or password for the object-storage user account - eg: *f6jGUSrmd9gdQg6*

#### Set Request Headers and Parameters

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

bucket (*x-amz-bucket*) - Name/ID of the object-storage bucket - eg: `abcdef`
***bucket*** (*x-amz-bucket*) - Name/ID of the object-storage bucket - eg: *abcdef*

endpoint (*x-amz-endpoint*) Object Storage Service Endpoint - object-storage service url - eg: `https://nrs.objectstore.gov.bc.ca/`
***endpoint*** (*x-amz-endpoint*) Object Storage Service Endpoint - object-storage service url - eg: *https://nrs.objectstore.gov.bc.ca/*

The endpoint to which the request is directed.

Expand Down
You are viewing a condensed version of this merge commit. You can view the full changes here.