Skip to content

Update user management docs for cookie-based auth #332

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

Open
mintlify wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update user management docs for cookie-based auth #332

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
48 changes: 24 additions & 24 deletions getting-started/user-management.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,32 +16,32 @@ OpenOps doesn't currently provide a UI for creating user accounts; instead, you

The first API call is to sign in the admin user:

```shell
curl -X POST http://your-openops-installation/api/v1/authentication/sign-in \
-H "Content-Type: application/json" \
-c cookies.txt \
-d '{
"email": "your-admin-email",
"password": "your-admin-password"
}'
```
POST http://your-openops-installation/api/v1/authentication/sign-in
Content-Type: application/json

{
"email": "your-admin-email",
"password": "your-admin-password"
}
```

This call will return a JSON object that contains a property called `token`. Copy the value of this property and use it in the authorization header in the next call. This next call actually creates a new user account. Before making the call, in the body, don't forget to specify actual values for the four properties that are left empty in the sample below:

```
POST http://your-openops-installation/api/v1/authentication/sign-up
Authorization: Bearer your-admin-token
Content-Type: application/json

{
"password": "",
"email": "",
"firstName": "",
"lastName": "",
"trackEvents": false,
"newsLetter": false
}

The authentication token is returned as an HTTP-only cookie (not in the response body). Use the `-c` flag to save cookies to a file, then pass them with `-b` in subsequent requests.

The next call creates a new user account. Specify values for the four empty properties in the body:

```shell
curl -X POST http://your-openops-installation/api/v1/authentication/sign-up \
-H "Content-Type: application/json" \
-b cookies.txt \
-d '{
"password": "",
"email": "",
"firstName": "",
"lastName": "",
"trackEvents": false,
"newsLetter": false
}'
```

The user account that you create this way will be able to perform all operations in OpenOps except for creating new user accounts. Every time you do that, you'll still need an admin token.