Credentials are the entry point for authentication and authorization to access Momentus API endpoints. They are managed on the API page in Momentus Connect. You can access the page via the header menu (APIs > API Keys) or the API card in the Marketplace (click More information). Once on the API page, go to the Credentials tab.
In this article:
- Add a New Credential
- Manage Endpoint Access
- Edit a Credential
- Deactivate a Credential
- Delete a Credential
Add a New Credential
To add a new credential:
- On the Momentus APIs page > Credentials tab, click Add Credentials. The Add API Credentials drawer opens.
- Add a unique title.
- Add a description to identify the credential's purpose.
- Choose the Authentication Method:
- OAuth: Enterprise only
- API Token: Elite or Enterprise
- If you chose OAuth, add an email and create a unique password. You can use your email or a dedicated API email.
- Click Save. The credentials display. Click the copy icon to copy the token to your clipboard.
- OAuth:
- Access Token and expiration date.
- Refresh Token and expiration date.
- API Token:
- API Token. This token does not have an expiration date.
- OAuth:
Manage Endpoint Access
By default, all credentials have access to all endpoints. You are able choose specific endpoints a credential has access to. This is useful when sharing credentials with development partners: you can grant access only to the data they need, without allowing them access to sensitive endpoints.
To restrict a credential's access to specific endpoints only:
- In the API page Credentials tab, click the three dot icon on the right of the credential's row and select Edit Endpoints. The Edit Allowed Endpoints drawer opens.
- In the Available tab, click the + by an endpoint to add it to the Selected tab and allow the credential access to it. You can search for specific endpoints.
- Enterprise credentials show both OData and standard Enterprise endpoints.
- Elite credentials show Elite endpoints only.
- Click Save.
Edit a Credential
You are able to edit a credential's title and description; no other information can be updated once the credential is created.
- In the API page Credentials tab, click the three dot icon on the right of the credential's row and select Edit Credential. The Edit API Credential drawer opens.
- Make any necessary updates.
- Click Save.
Deactivate a Credential
You are able to deactivate an API credential to make it temporarily unusable.
- In the API page Credentials tab, click the three dot icon on the right of the credential's row and select Edit Credential. The Edit API Credential drawer opens.
- Uncheck Active.
- Click Save.
Delete a Credential
If a credential is no longer needed, it can be deleted.
- In the API page Credentials tab, click the three dot icon on the right of the credential's row and select Delete Credential. A confirmation pop-up displays.
- Click Yes, Delete.