Login 24/7 Support Community tyk.io

Portal OAuth Clients

From Tyk Dashboard v1.8, you can now create and manage OAuth clients from the Developer Portal.

Prerequisites

  1. An API created in your Dashboard using Tyk’s ability to act as a OAuth provider. You need to have OAuth 2.0 selected as the Authentication mode. See Create an API for more details.
  2. A Policy created in your Dashboard with the API created above selected in the Access Rights > Add access rule drop-down. See Create a Security Policy for more details.
  3. A Portal Catalogue entry for the API created above with the Policy you created selected from the Available policies drop-down. See Create a Portal Entry for more details.
  4. A developer account created in your Developer Portal.

Create the OAuth Client from the Portal

  1. Login to your Portal:

Developer Portal Home Screen

  1. Select OAuth Clients from the top menu
  2. If this is the first OAuth Client you are creating, the screen will be as below:

Developer OAuth Home Screen

  1. Click Create first OAuth Client
  2. Hover over the API you added to the Catalogue with OAuth Authentication mode from the drop-down list:

Select API Screen

  1. Click Select API
  2. Then click Save and continue:

Save

  1. You can now add details about your application, and set the redirect URL to the application. If you want to use this client for more than one application, you can add other redirect URLs as necessary.
  2. Click Create

Create

  1. You need to copy and save the displayed Client Secret, as you will not be able to view it from the Portal again. The secret is stored on the Dashboard and are listed for each developer under the Portal Management > Developers menu.

secret

Revoke OAuth Client Tokens

See Revoke OAuth Tokens for more details.