This tutorial shows how to create a security scheme for authentication and authorization.
Synatic uses the term security scheme for authentication and authorization schemes. All security schemes used by the API must be defined in the Security Schemes tab.
To create a new Security Scheme, click highlighted plus button adjacent to the Security Schemes tab as shown in the above image.
Provide a Security Scheme Name where it is outlined in red in the image and select the appropriate Authentication Type to use for protecting the API.
The Authentication Types options are the following:
Basic: Basic authentication is a simple scheme using a username and password.
User Groups: Users Groups apply authentication via the Synatic User Groups.
Bearer: Bearer authentication involves security tokens called bearer tokens.
API key: An API key is a token that a client provides when making API calls.
JWT: JSON Web Token defines compact and self-contained authentication.
JWKS: JSON Web Key Set containing the public keys that should be used to verify any JWT that is issued by an authorization server and signed using the RSA or ECDSA algorithms.
The link below is how you can set up Auth0 to generate tokens and Synatic can verify those tokens by setting up the JWKS configuration:
In this tutorial, the API Key Authentication Type is used. Click the Regenerate Key button to get the API Key. Copy the key and save the key to keep it in a safe place by clicking on the highlighted icon as shown in the image below.
Useful Tutorials
Revisit the Getting Started page for a refresher.
Read more about the API Builder here.