{ "opencollection": "1.0.0", "info": { "name": "Kong Enterprise Admin ACLs Auth Settings API", "version": "3.14.0" }, "request": { "auth": { "type": "apikey", "key": "Kong-Admin-Token", "value": "{{Kong-Admin-Token}}", "placement": "header" } }, "items": [ { "info": { "name": "Auth Settings", "type": "folder" }, "items": [ { "info": { "name": "Get Auth Settings", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}:{port}{path}/v3/authentication-settings" }, "docs": "Returns authentication configuration, which determines how users 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/authentication-settings", "body": { "type": "json", "data": "{}" } }, "docs": "Updates authentication configuration." }, { "info": { "name": "Get the IdP Configuration", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}:{port}{path}/v3/identity-provider" }, "docs": "Fetch the IdP configuration." }, { "info": { "name": "Update IdP Configuration", "type": "http" }, "http": { "method": "PATCH", "url": "{protocol}://{hostname}:{port}{path}/v3/identity-provider", "body": { "type": "json", "data": "{}" } }, "docs": "Update the IdP configuration." }, { "info": { "name": "Get a Team Group Mappings", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}:{port}{path}/v3/identity-provider/team-group-mappings", "params": [ { "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": "Retrieves the mappings between Konnect Teams and Identity Provider Groups.\nReturns a 400 error if an Identity Provider has not yet been configured." }, { "info": { "name": "Patch Mappings by Team ID", "type": "http" }, "http": { "method": "PATCH", "url": "{protocol}://{hostname}:{port}{path}/v3/identity-provider/team-group-mappings", "body": { "type": "json", "data": "{}" } }, "docs": "Allows partial updates to the mappings between Konnect Teams and Identity Provider Groups.\nThe request body must be keyed on team ID. For a given team ID, the given group list is a\ncomplete replacement. To remove all mappings for a given team, provide an empty group list.\n\nReturns a 400 error if an Identity Provider has not yet been configured, or if a team ID in\nthe request body is not found or is not a UUID." }, { "info": { "name": "Get a Team Mapping", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}:{port}{path}/v3/identity-provider/team-mappings", "params": [ { "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": "Fetch the IdP group to Konnect team mapping." }, { "info": { "name": "Update Team Mappings", "type": "http" }, "http": { "method": "PUT", "url": "{protocol}://{hostname}:{port}{path}/v3/identity-provider/team-mappings", "body": { "type": "json", "data": "{}" } }, "docs": "Updates the IdP group to Konnect team mapping." }, { "info": { "name": "List Identity Providers", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}:{port}{path}/v3/identity-providers", "params": [ { "name": "filter", "value": "", "type": "query", "description": "Filter identity providers returned in the response." } ] }, "docs": "Retrieves the identity providers available within the organization. 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/identity-providers", "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/identity-providers/:id", "params": [ { "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/identity-providers/:id", "params": [ { "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/identity-providers/:id", "params": [ { "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 organization.\n" }, { "info": { "name": "List Team Group Mappings", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}:{port}{path}/v3/identity-providers/:idpId/team-group-mappings", "params": [ { "name": "idpId", "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.\nMappings define the relationship between identity provider groups and Konnect teams.\n" }, { "info": { "name": "Create Team Group Mapping", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}:{port}{path}/v3/identity-providers/:idpId/team-group-mappings", "params": [ { "name": "idpId", "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.\nA mapping associates an identity provider group with a Konnect team.\n" }, { "info": { "name": "Get Team Group Mapping", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}:{port}{path}/v3/identity-providers/:idpId/team-group-mappings/:id", "params": [ { "name": "idpId", "value": "", "type": "path", "description": "ID of the identity provider." }, { "name": "id", "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/identity-providers/:idpId/team-group-mappings/:id", "params": [ { "name": "idpId", "value": "", "type": "path", "description": "ID of the identity provider." }, { "name": "id", "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 }