{ "opencollection": "1.0.0", "info": { "name": "Kong Enterprise Admin ACLs Portal Auth Settings API", "version": "3.14.0" }, "request": { "auth": { "type": "apikey", "key": "Kong-Admin-Token", "value": "{{Kong-Admin-Token}}", "placement": "header" } }, "items": [ { "info": { "name": "Portal Auth Settings", "type": "folder" }, "items": [ { "info": { "name": "Get Auth Settings", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}:{port}{path}/v3/portals/:portalId/authentication-settings", "params": [ { "name": "portalId", "value": "", "type": "path", "description": "ID of the portal." } ] }, "docs": "Returns the developer authentication configuration for a portal, which determines how developers can log in and how they are assigned to teams." }, { "info": { "name": "Update Auth Settings", "type": "http" }, "http": { "method": "PATCH", "url": "{protocol}://{hostname}:{port}{path}/v3/portals/:portalId/authentication-settings", "params": [ { "name": "portalId", "value": "", "type": "path", "description": "ID of the portal." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the developer authentication configuration for a portal. Developers can be allowed to login using basic auth (email & password) or use Single-Sign-On through an Identity Provider. Developers can be automatically assigned to teams by mapping claims from their IdP account." }, { "info": { "name": "List Team Group Mappings", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}:{port}{path}/v3/portals/:portalId/identity-provider/team-group-mappings", "params": [ { "name": "portalId", "value": "", "type": "path", "description": "ID of the portal." }, { "name": "page[size]", "value": "", "type": "query", "description": "The maximum number of items to include per page. The last page of a collection may include fewer items." }, { "name": "page[number]", "value": "", "type": "query", "description": "Determines which page of the entities to retrieve." } ] }, "docs": "**Pre-release Endpoint**\nThis endpoint is currently in beta and is subject to change.\n\nLists mappings between Konnect portal teams and Identity Provider (IdP) groups. Returns a 400 error if an IdP has not yet been configured." }, { "info": { "name": "Update Team Group Mappings", "type": "http" }, "http": { "method": "PATCH", "url": "{protocol}://{hostname}:{port}{path}/v3/portals/:portalId/identity-provider/team-group-mappings", "params": [ { "name": "portalId", "value": "", "type": "path", "description": "ID of the portal." } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Pre-release Endpoint**\nThis endpoint is currently in beta and is subject to change.\n\nAllows partial updates to the mappings between Konnect portal teams and Identity Provider (IdP) groups. The request body must be keyed on team ID. For a given team ID, the given group list is a complete replacement. To remove all mappings for a given team, provide an empty group list.\nReturns a 400 error if an IdP has not yet been configured, or if a team ID in the request body is not found or is not a UUID." }, { "info": { "name": "List Identity Providers", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}:{port}{path}/v3/portals/:portalId/identity-providers", "params": [ { "name": "portalId", "value": "", "type": "path", "description": "ID of the portal." }, { "name": "filter", "value": "", "type": "query", "description": "Filter identity providers returned in the response." } ] }, "docs": "Retrieves the identity providers available within the portal. This operation provides information about\nvarious identity providers for SAML or OIDC authentication integrations.\n" }, { "info": { "name": "Create Identity Provider", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}:{port}{path}/v3/portals/:portalId/identity-providers", "params": [ { "name": "portalId", "value": "", "type": "path", "description": "ID of the portal." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new identity provider. This operation allows the creation of a new identity provider for\nauthentication purposes.\n" }, { "info": { "name": "Get Identity Provider", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}:{port}{path}/v3/portals/:portalId/identity-providers/:id", "params": [ { "name": "portalId", "value": "", "type": "path", "description": "ID of the portal." }, { "name": "id", "value": "", "type": "path", "description": "ID of the identity provider." } ] }, "docs": "Retrieves the configuration of a single identity provider. This operation returns information about a\nspecific identity provider's settings and authentication integration details.\n" }, { "info": { "name": "Update Identity Provider", "type": "http" }, "http": { "method": "PATCH", "url": "{protocol}://{hostname}:{port}{path}/v3/portals/:portalId/identity-providers/:id", "params": [ { "name": "portalId", "value": "", "type": "path", "description": "ID of the portal." }, { "name": "id", "value": "", "type": "path", "description": "ID of the identity provider." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the configuration of an existing identity provider. This operation allows modifications to be made\nto an existing identity provider's configuration.\n" }, { "info": { "name": "Delete Identity Provider", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}:{port}{path}/v3/portals/:portalId/identity-providers/:id", "params": [ { "name": "portalId", "value": "", "type": "path", "description": "ID of the portal." }, { "name": "id", "value": "", "type": "path", "description": "ID of the identity provider." } ] }, "docs": "Deletes an existing identity provider configuration. This operation removes a specific identity provider\nfrom the portal.\n" }, { "info": { "name": "List Team Group Mappings", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}:{port}{path}/v3/portals/:portalId/identity-providers/:id/team-group-mappings", "params": [ { "name": "portalId", "value": "", "type": "path", "description": "ID of the portal." }, { "name": "id", "value": "", "type": "path", "description": "ID of the identity provider." }, { "name": "page[size]", "value": "", "type": "query", "description": "The maximum number of items to include per page. The last page of a collection may include fewer items." }, { "name": "page[after]", "value": "", "type": "query", "description": "Request the next page of data, starting with the item after this parameter." }, { "name": "page[before]", "value": "", "type": "query", "description": "Request the next page of data, starting with the item before this parameter." }, { "name": "filter", "value": "", "type": "query", "description": "Filter mappings by team ID or group name." } ] }, "docs": "Returns a paginated list of team group mappings for the specified identity provider.\n" }, { "info": { "name": "Create Team Group Mapping", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}:{port}{path}/v3/portals/:portalId/identity-providers/:id/team-group-mappings", "params": [ { "name": "portalId", "value": "", "type": "path", "description": "ID of the portal." }, { "name": "id", "value": "", "type": "path", "description": "ID of the identity provider." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new team group mapping for the specified identity provider.\n" }, { "info": { "name": "Get Team Group Mapping", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}:{port}{path}/v3/portals/:portalId/identity-providers/:id/team-group-mappings/:mappingId", "params": [ { "name": "portalId", "value": "", "type": "path", "description": "ID of the portal." }, { "name": "id", "value": "", "type": "path", "description": "ID of the identity provider." }, { "name": "mappingId", "value": "", "type": "path", "description": "ID of the team group mapping." } ] }, "docs": "Returns the team group mapping for the specified ID." }, { "info": { "name": "Delete Team Group Mapping", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}:{port}{path}/v3/portals/:portalId/identity-providers/:id/team-group-mappings/:mappingId", "params": [ { "name": "portalId", "value": "", "type": "path", "description": "ID of the portal." }, { "name": "id", "value": "", "type": "path", "description": "ID of the identity provider." }, { "name": "mappingId", "value": "", "type": "path", "description": "ID of the team group mapping." } ] }, "docs": "Deletes a team group mapping by ID.\nReturns 204 if the mapping was deleted, or 404 if the mapping was not found.\n" } ] } ], "bundled": true }