List Granted Scopes
Lists the granted scopes for this application registration. This is the list of scopes that will be sent to the API when making requests.
Path Parameters
ID of the portal.
Contains a unique identifier used for this resource.
Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
Contains a unique identifier used for this resource.
Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
Response
application/json
Response
A list of granted scopes for an application registration.
ListGrantedScopesResponse
Authentication
Path Parameters
Portal Products
APIs related to API Products Published to Konnect Developer Portals.
List Portal Products
Lists the API products that are published to this developer portal. An API product packages together multiple versions of each API, displaying each version with its set of operations and documentation. Developers can browse API Products to learn about and register for them. API Products access can be limited to certain developers using RBAC and developer teams.
Query Parameters
The maximum number of items to include per page. The last page of a collection may include fewer items.
Example:10
Determines which page of the entities to retrieve.
Example:1
Sorts a collection of Portal Products. Supported sort attributes are:
- created_at
- name
- description
Filters a collection of Portal Products.
Show Child Parameters
Path Parameters
ID of the portal.
Response
application/json
Response
A paginated list of API products published to a portal.
ListPortalProductsResponse
A paginated list of API products published to a portal.
returns the pagination information
Show Child Parameters
Example:{"id":"7cdcba18-5bdf-4936-81de-d76da02cb99b","name":"Excellent API","description":"Excellent for serving","created_at":"2022-05-24T18:40:35.500Z","updated_at":"2022-05-24T18:40:35.500Z","portal_ids":["83f1733c-862c-43e5-a005-acfb0addfcfb"],"labels":{"department":"marketing"},"version_count":4}
Show Child Parameters
Authentication
Path Parameters
Query Parameters
Portal Auth Settings
APIs related to Konnect Developer Portal Authentication Settings.
Get Auth Settings
Returns the developer authentication configuration for a portal, which determines how developers can log in and how they are assigned to teams.
Path Parameters
ID of the portal.
Response
application/json
Response
Details about a portal’s authentication settings.
PortalAuthenticationSettingsResponse
The developer authentication settings for a portal.
The portal has basic auth enabled or disabled.
Example:true
The portal has OIDC enabled or disabled.
Example:false
The portal has SAML enabled or disabled.
Example:false
IdP groups determine the Portal Teams a developer has.
Example:true
IdP groups determine the Portal Teams a developer has. This will soon replace oidc_team_mapping_enabled.
Example:true
A Konnect Identity Admin assigns teams to a developer.
Example:false
Configuration properties for an OpenID Connect Identity Provider.
Example:{"issuer":"https://identity.example.com/v2","client_id":"x7id0o42lklas0blidl2","scopes":["email","openid","profile"],"claim_mappings":{"name":"name","email":"email","groups":"custom-group-claim"}}