From bdc08a0fbae255615e7b7052bf1cdb7a1732bf62 Mon Sep 17 00:00:00 2001 From: Daniel Hougaard Date: Tue, 24 Sep 2024 00:28:32 +0400 Subject: [PATCH] Update README.md --- README.md | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) diff --git a/README.md b/README.md index 48b29ae..05d63d6 100644 --- a/README.md +++ b/README.md @@ -51,6 +51,37 @@ await client.auth().universalAuth.login({ }); ``` +**Parameters:** +- `options` (object): + - `clientId` (string): The client ID of your Machine Identity. + - `clientSecret` (string): The client secret of your Machine Identity. + + +#### Plain Access Token +```typescript +client.auth().accessToken("") +``` + +**Parameters:** +- `accessToken` (string): The access token to be used for authentication. _This should not include "Bearer"._ + + +#### AWS IAM +```typescript +await client.auth().awsIamAuth.login({ + identityId: "" +}) +``` + +**Parameters:** +- `options` (object): + - `identityId` (string): The ID of your identity + - `clientSecret` (string): The client secret of your Machine Identity. + + +> [!NOTE] +> AWS IAM auth only works when the SDK is being used from within an AWS service, such as Lambda, EC2, etc. + ### `secrets`