Skip to content

Latest commit

 

History

History

principal

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 

Users

Users API is for demonstration purpose. For managing users, we highly recommend using SSO or SCIM to provision user instead of using API.

API: https://api.bytebase.com/#tag/authservice/POST/v1/users

## Create
curl --request POST ${bytebase_url}/v1/users \
  --header 'Authorization: Bearer '${bytebase_token} \
  --data @user.json
## Update
curl --request PATCH "${bytebase_url}/v1/users/103" \
  --header 'Authorization: Bearer '${bytebase_token} \
  --data '{
    "email":"[email protected]",
    "title": "User updated",
    "phone": "+14082121234"
  }'
## Deactivate
curl --request DELETE "${bytebase_url}/v1/users/111" \
  --header 'Authorization: Bearer '${bytebase_token}
## Activate
curl --request POST "${bytebase_url}/v1/users/111:undelete" \
  --header 'Authorization: Bearer '${bytebase_token}

We don't provide example to configure users as we recommend using SSO.

Another challenge for configuring users is you need to specify the password, which is not desirable.

Groups

You can skip this if you have SCIM to provision users and groups in an organization.

API: https://api.bytebase.com/#tag/groupservice

You must be the Group Owner to create/update the group.

## Create
curl --request POST "${bytebase_url}/v1/[email protected]" \
  --header 'Authorization: Bearer '${bytebase_token} \
  --data @group.json
## Upsert
curl --request PATCH "${bytebase_url}/v1/groups/[email protected]?allow_missing=true" \
  --header 'Authorization: Bearer '${bytebase_token} \
  --data @group.json
## Delete
curl --request DELETE "${bytebase_url}/v1/groups/[email protected]" \
  --header 'Authorization: Bearer '${bytebase_token}