After registering your Developer App, you can add user accounts either programmatically via the API, or manually through the Orcabase UI. This process provides the credentials needed to authenticate and authorize API requests on behalf of your registered users.
API Account Registration
To programmatically add user accounts, send a POST request to the /register-account endpoint to create Orcabase end user accounts for your users.
- When you first set up Orcabase, you can use this endpoint to create end user accounts for all of your existing users.
- You can also use this endpoint to trigger Orcabase user registration as part of your own sign in flow, so that going forward all of your users will also be registered in Orcabase.
Prerequisites
- An Orcabase API Key is required to authenticate API requests.
Manual Account Registration
To manually create Orcabase end user accounts for your users, go to Register Account in the Orcabase UI. Provide the following details for each account:
- Account ID: A globally unique identifier for the user account (e.g.,
example-user-account). Use the same unique user ID as in your existing systems for consistency. - Account Name: The display name for the user account (e.g.,
Example User Account). - Timezone: The IANA time zone identifier for the user's location.
- Currency: The ISO 4217 currency code for the user's preferred currency.
