The Shipa Developer Hub

Welcome to the Shipa developer hub. You'll find comprehensive guides and documentation to help you start working with Shipa as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    Changelog

Authentication

Listing Users

The command below lists all users in Shipa. Administrators may also filter users by user email or role name with context value.

$ shipa user-list [--user/-u useremail] [--role/-r role [-c/--context-value value]]

Available flags:

Flag

Description

-r, --role

(= "") Filter user by role

-u, --user

(= "") Filter user by user email

Creating Users

The command below creates a user within Shipa;s remote server. It will prompt for the password before it issues the request:

$ shipa user-create <email>

Adding Members to Teams

In order to add members to teams created in Shipa, users will need to leverage the role-assign command, as follows:

$ shipa role-assign <role> <[email protected]> <team>

Removing Users

The command below removes users from a remote Shipa server.

Since orphan teams cannot exist, Shipa may refuse to remove a user that is the last member of a team. If this is the case, make sure the team is removed by using the command team-remove before removing the user:

$ shipa user-remove [email]

User Information

When needed, the command below displays information about a specific current user:

$ shipa user-info

Login

Login initiates a new session for a user. If using Shipa's native authentication scheme, Shipa will ask for the email and the password. If using OAuth, a web browser will be opened for the user to complete the login.

Once completed, the token generated by the Shipa server will be stored in ${HOME}/.shipa/token.

All Shipa actions require the user to be authenticated (except shipa login and shipa version).

$ shipa login [email]

Logout

The logout command terminates the session with the Shipa server.

$ shipa logout

Changing Passwords

The command below changes the password of the logged in user. Shipa will ask for the current password, the new and confirmation:

$ shipa change-password

Resetting Password

$ shipa reset-password <email> [--token|-t <token>]

Resets the user password.

This process executes two steps:

  • Generate a new token
  • Reset the password using the token

In order to generate the token, users should run this command without the --token flag. The token will be mailed to the user.

With the token in hand, the user can finally reset the password using the --token flag. The new password will also be mailed to the user.

Updated about a year ago

Authentication


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.