Skip to content
Merged
Show file tree
Hide file tree
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
29 changes: 29 additions & 0 deletions docs/useCases.md
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