Skip to content
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

Add OIDC Bearer Token Auth mechanism based on the PoC design #224

Open
wants to merge 8 commits into
base: develop
Choose a base branch
from
Open

Add OIDC Bearer Token Auth mechanism based on the PoC design #224

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
6d28f1f
feat: add bearer token mechanism
g-saracca Nov 22, 2024
43fae70
test: add bearer token mechanism test
g-saracca Nov 25, 2024
3bdd0c6
test: add withCredentials false to all api key configs
g-saracca Nov 25, 2024
045ca23
test: add withCredentials: false to all expected requests configs non…
g-saracca Nov 25, 2024
99d9d78
feat: add register user use case
g-saracca Nov 29, 2024
b18ebf4
chore: add commas to object properties in doc
g-saracca Nov 29, 2024
a5634ad
test: add unit test
g-saracca Nov 29, 2024
5f50318
feat: remove default withCredentials false as it is the default
g-saracca Dec 3, 2024
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
29 changes: 29 additions & 0 deletions docs/useCases.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,7 @@ The different use cases currently available in the package are classified below,
- [Users write use cases](#users-write-use-cases)
- [Delete Current API Token](#delete-current-api-token)
- [Recreate Current API Token](#recreate-current-api-token)
- [Register User](#register-user)
- [Info](#Info)
- [Get Dataverse Backend Version](#get-dataverse-backend-version)
- [Get Maximum Embargo Duration In Months](#get-maximum-embargo-duration-in-months)
Expand Down Expand Up @@ -1269,6 +1270,34 @@ recreateCurrentApiToken.execute().then((apiTokenInfo: ApiTokenInfo) => {

_See [use case](../src/users/domain/useCases/RecreateCurrentApiToken.ts) implementation_.

### Register User

Register a new user, given a [UserDTO](../src/users/domain/dtos/UserDTO.ts)

##### Example call:

```typescript
import { registerUser } from '@iqss/dataverse-client-javascript'

/* ... */

const userDTO: UserDTO = {
username: 'johndoe',
firstName: 'John',
lastName: 'Doe',
emailAddress: '[email protected]',
position: '',
affiliation: '',
termsAccepted: true
}

registerUser.execute(userDTO)

/* ... */
```

_See [use case](../src/users/domain/useCases/RegisterUser.ts) implementation_.

## Info

#### Get Dataverse Backend Version
Expand Down
Loading
Loading