---
title: "Konnect Identity"
url: "https://nov18-dev.movespot.fyi/apis/konnect-identity-dev-3/versions/e16cd3f9-9a13-4d32-bf43-02e155aab685"
---

# Konnect Identity

OpenAPI specification document.

```json
{"openapi":"3.0.2","info":{"title":"Konnect Identity","version":"3.0.2","description":"The management API for Kong Konnect Identity resources.","contact":{"name":"Kong","url":"https://konghq.com"}},"servers":[{"url":"https://global.api.konghq.com/v3","description":"Global Base URL"}],"paths":{"/internal/auth0/users/mfa-settings":{"post":{"operationId":"post-auth0-user-mfa-settings-internal","summary":"Get Auth0 User MFA Settings (Internal)","description":"Returns whether Multi-Factor Authentication (MFA) is enabled for an Auth0 user. A user's MFA status is determined from their Konnect organization's settings. If the user is associated with multiple organizations, MFA is considered enabled if any of their organizations have MFA enabled. Although a user is generally uniquely identified by their email address, this endpoint requires the user's Auth0 ID to manage cases where the user logs in with multiple authentication providers but chooses not to link their accounts (in which case a single email address may correspond to multiple Auth0 user IDs).\nNote: The email address is not a part of the URL path to avoid PII data in request logs/traces.","requestBody":{"$ref":"#/components/requestBodies/GetMFASettingsRequest"},"responses":{"200":{"$ref":"#/components/responses/GetMFASettingsResponse"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/responses-Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Auth0"]}},"/identity-providers/{idpId}/team-group-mappings":{"parameters":[{"name":"idpId","in":"path","description":"ID of the identity provider.","required":true,"schema":{"type":"string","format":"uuid","example":"d32d905a-ed33-46a3-a093-d8f536af9a8a"}}],"get":{"operationId":"list-idp-team-group-mappings","summary":"List Team Group Mappings","description":"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","parameters":[{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageAfter"},{"$ref":"#/components/parameters/PageBefore"},{"name":"filter","in":"query","description":"Filter mappings by team ID or group name.","required":false,"schema":{"type":"object","properties":{"team_id":{"$ref":"#/components/schemas/StringFieldEqualsFilter"},"group":{"$ref":"#/components/schemas/StringFieldEqualsFilter"}}},"style":"deepObject"}],"responses":{"200":{"$ref":"#/components/responses/IdpTeamGroupMappingsCollection"},"400":{"$ref":"#/components/responses/IdentityBadRequest"},"401":{"$ref":"#/components/responses/IdentityUnauthenticated"},"403":{"$ref":"#/components/responses/IdentityPermissionDenied"},"404":{"$ref":"#/components/responses/IdentityNotFound"}},"tags":["Auth Settings"]},"post":{"operationId":"create-idp-team-group-mapping","summary":"Create Team Group Mapping","description":"Creates a new team group mapping for the specified identity provider.\nA mapping associates an identity provider group with a Konnect team.\n","requestBody":{"$ref":"#/components/requestBodies/CreateIdpTeamGroupMappingRequest"},"responses":{"201":{"$ref":"#/components/responses/IdpTeamGroupMapping"},"400":{"$ref":"#/components/responses/IdentityBadRequest"},"401":{"$ref":"#/components/responses/IdentityUnauthenticated"},"403":{"$ref":"#/components/responses/IdentityPermissionDenied"},"404":{"$ref":"#/components/responses/IdentityNotFound"},"409":{"$ref":"#/components/responses/Conflict"}},"tags":["Auth Settings"]}},"/identity-providers/{idpId}/team-group-mappings/{id}":{"parameters":[{"name":"idpId","in":"path","description":"ID of the identity provider.","required":true,"schema":{"type":"string","format":"uuid","example":"d32d905a-ed33-46a3-a093-d8f536af9a8a"}},{"name":"id","in":"path","description":"ID of the team group mapping.","required":true,"schema":{"type":"string","format":"uuid","example":"7f9fd312-a987-4628-b4c5-bb4f4fddd5f7"}}],"get":{"operationId":"get-idp-team-group-mapping","summary":"Get Team Group Mapping","description":"Returns the team group mapping for the specified ID.","responses":{"200":{"$ref":"#/components/responses/IdpTeamGroupMapping"},"400":{"$ref":"#/components/responses/IdentityBadRequest"},"401":{"$ref":"#/components/responses/IdentityUnauthenticated"},"403":{"$ref":"#/components/responses/IdentityPermissionDenied"},"404":{"$ref":"#/components/responses/IdentityNotFound"}},"tags":["Auth Settings"]},"delete":{"operationId":"delete-idp-team-group-mapping","summary":"Delete Team Group Mapping","description":"Deletes a team group mapping by ID.\nReturns 204 if the mapping was deleted, or 404 if the mapping was not found.\n","responses":{"204":{"description":"No Content"},"400":{"$ref":"#/components/responses/IdentityBadRequest"},"401":{"$ref":"#/components/responses/IdentityUnauthenticated"},"403":{"$ref":"#/components/responses/IdentityPermissionDenied"},"404":{"$ref":"#/components/responses/IdentityNotFound"}},"tags":["Auth Settings"]}},"/roles":{"get":{"operationId":"get-predefined-roles","summary":"Get Predefined Roles","description":"Retrieves the predefined, or system managed, roles.","responses":{"200":{"$ref":"#/components/responses/Roles"},"400":{"$ref":"#/components/responses/IdentityBadRequest"},"401":{"$ref":"#/components/responses/IdentityUnauthenticated"}},"tags":["Roles"]}},"/organizations/me":{"get":{"operationId":"get-organizations-me","summary":"Get My Organization","description":"Returns the organization of the user identified in the token of the request.","responses":{"200":{"$ref":"#/components/responses/MeOrganization"},"401":{"$ref":"#/components/responses/IdentityUnauthenticated"}},"tags":["Me"]},"patch":{"operationId":"update-organizations-me","summary":"Update My Organization","description":"Updates the current user's organization. When updating the owner, the new owner\nmust be an organization admin.\n","requestBody":{"$ref":"#/components/requestBodies/UpdateOrganization"},"responses":{"200":{"$ref":"#/components/responses/MeOrganization"},"400":{"$ref":"#/components/responses/IdentityBadRequest"},"401":{"$ref":"#/components/responses/IdentityUnauthenticated"},"403":{"$ref":"#/components/responses/IdentityPermissionDenied"},"404":{"$ref":"#/components/responses/IdentityNotFound"}},"tags":["Me"]}},"/users/{userId}/mfa":{"parameters":[{"$ref":"#/components/parameters/userId"}],"delete":{"operationId":"delete-user-mfas","summary":"Delete User MFA","description":"Deletes all secondary factors for multi-factor authentication (MFA), of the user.","responses":{"204":{"description":"No Content"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/responses-Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/SSOUserConflict"}},"security":[{"personalAccessToken":[]},{"konnectAccessToken":[]}],"tags":["Users"]}}},"components":{"parameters":{"PageAfter":{"name":"page[after]","description":"Request the next page of data, starting with the item after this parameter.","required":false,"in":"query","allowEmptyValue":true,"schema":{"type":"string","example":"ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ"}},"PageBefore":{"name":"page[before]","description":"Request the next page of data, starting with the item before this parameter.","required":false,"in":"query","allowEmptyValue":true,"schema":{"type":"string","example":"ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ"}},"PageSize":{"name":"page[size]","description":"The maximum number of items to include per page. The last page of a collection may include fewer items.","required":false,"in":"query","allowEmptyValue":true,"schema":{"type":"integer","example":10}},"userId":{"name":"userId","in":"path","required":true,"description":"ID of the user.","x-go-name":"userIdParam","schema":{"$ref":"#/components/schemas/UUID"}}},"schemas":{"IdpTeamGroupMapping":{"description":"A mapping between a Konnect team and an identity provider group.","type":"object","properties":{"id":{"$ref":"#/components/schemas/UUID"},"team_id":{"description":"The Konnect team ID.","type":"string","format":"uuid","example":"6801e673-cc10-498a-94cd-4271de07a0d3"},"group":{"description":"The identity provider group name. Group names are case sensitive.","type":"string","example":"Tech Leads"},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"}},"required":["id","team_id","group","created_at","updated_at"],"title":"IdpTeamGroupMapping"},"PortalsRoles":{"type":"object","properties":{"name":{"type":"string","enum":["Portals"]},"roles":{"type":"object","properties":{"admin":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string","enum":["Admin"]},"description":{"type":"string","example":"This role grants full write access to portal configurations and entities.","enum":["This role grants full write access to portal configurations and entities."]}},"required":["name","description"]},"maintainer":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string","enum":["Maintainer"]},"description":{"type":"string","example":"This role grants the ability to manage developers, applications, and product versions in portals.","enum":["This role grants the ability to manage developers, applications, and product versions in portals."]}},"required":["name","description"]},"creator":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string","enum":["Creator"]},"description":{"type":"string","example":"This role grants access to create new portals.","enum":["This role grants access to create new portals."]}},"required":["name","description"]},"viewer":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string","enum":["Viewer"]},"description":{"type":"string","example":"This role grants access to read-only permissions to portals and their entities.","enum":["This role grants access to read-only permissions to portals and their entities."]}},"required":["name","description"]}}}},"additionalProperties":false,"required":["name","roles"],"title":"Portals Roles"},"ApplicationAuthStrategiesRoles":{"type":"object","properties":{"name":{"type":"string","enum":["Application Auth Strategies"]},"roles":{"type":"object","properties":{"maintainer":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string","enum":["Maintainer"]},"description":{"type":"string","example":"This role grants access to manage and delete application auth strategies.","enum":["This role grants access to manage and delete application auth strategies."]}},"required":["name","description"]},"creator":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string","enum":["Creator"]},"description":{"type":"string","example":"This role grants access to create new application auth strategies.","enum":["This role grants access to create new application auth strategies."]}},"required":["name","description"]},"viewer":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string","enum":["Viewer"]},"description":{"type":"string","example":"This role grants access to read-only permissions to application auth strategies.","enum":["This role grants access to read-only permissions to application auth strategies."]}},"required":["name","description"]}}}},"additionalProperties":false,"required":["name","roles"],"title":"Application Auth Strategies Roles"},"DCRProvidersRoles":{"type":"object","properties":{"name":{"type":"string","enum":["DCR Providers"]},"roles":{"type":"object","properties":{"maintainer":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string","enum":["Maintainer"]},"description":{"type":"string","example":"This role grants access to manage and delete DCR providers.","enum":["This role grants access to manage and delete DCR providers."]}},"required":["name","description"]},"creator":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string","enum":["Creator"]},"description":{"type":"string","example":"This role grants access to create new DCR providers.","enum":["This role grants access to create new DCR providers."]}},"required":["name","description"]},"viewer":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string","enum":["Viewer"]},"description":{"type":"string","example":"This role grants access to read-only permissions to DCR providers.","enum":["This role grants access to read-only permissions to DCR providers."]}},"required":["name","description"]}}}},"additionalProperties":false,"required":["name","roles"],"title":"DCR Providers Roles"},"BaseError":{"description":"standard error","type":"object","properties":{"status":{"description":"The HTTP status code of the error. Useful when passing the response\nbody to child properties in a frontend UI. Must be returned as an integer.\n","type":"integer","readOnly":true},"title":{"description":"A short, human-readable summary of the problem. It should not\nchange between occurences of a problem, except for localization.\nShould be provided as \"Sentence case\" for direct use in the UI.\n","type":"string","readOnly":true},"type":{"description":"The error type.","type":"string","readOnly":true},"instance":{"description":"Used to return the correlation ID back to the user, in the format\nkong:trace:<correlation_id>. This helps us find the relevant logs\nwhen a customer reports an issue.\n","type":"string","readOnly":true},"detail":{"description":"A human readable explanation specific to this occurence of the problem.\nThis field may contain request/entity data to help the user understand\nwhat went wrong. Enclose variable values in square brackets. Should be\nprovided as \"Sentence case\" for direct use in the UI.\n","type":"string","readOnly":true}},"required":["status","title","instance","detail"],"title":"Error"},"InvalidRules":{"description":"invalid parameters rules","type":"string","enum":["required","is_array","is_base64","is_boolean","is_date_time","is_integer","is_null","is_number","is_object","is_string","is_uuid","is_fqdn","is_arn","unknown_property","missing_reference","is_label","matches_regex","invalid","is_supported_network_availability_zone_list","is_supported_network_cidr_block","is_supported_provider_region","type"],"nullable":true,"readOnly":true},"InvalidParameterStandard":{"type":"object","properties":{"field":{"type":"string","example":"name","readOnly":true},"rule":{"$ref":"#/components/schemas/InvalidRules"},"source":{"type":"string","example":"body"},"reason":{"type":"string","example":"is a required field","readOnly":true}},"additionalProperties":false,"required":["field","reason"]},"InvalidParameterMinimumLength":{"type":"object","properties":{"field":{"type":"string","example":"name","readOnly":true},"rule":{"description":"invalid parameters rules","type":"string","enum":["min_length","min_digits","min_lowercase","min_uppercase","min_symbols","min_items","min"],"nullable":false,"readOnly":true},"minimum":{"type":"integer","example":8},"source":{"type":"string","example":"body"},"reason":{"type":"string","example":"must have at least 8 characters","readOnly":true}},"additionalProperties":false,"required":["field","reason","rule","minimum"]},"InvalidParameterMaximumLength":{"type":"object","properties":{"field":{"type":"string","example":"name","readOnly":true},"rule":{"description":"invalid parameters rules","type":"string","enum":["max_length","max_items","max"],"nullable":false,"readOnly":true},"maximum":{"type":"integer","example":8},"source":{"type":"string","example":"body"},"reason":{"type":"string","example":"must not have more than 8 characters","readOnly":true}},"additionalProperties":false,"required":["field","reason","rule","maximum"]},"InvalidParameterChoiceItem":{"type":"object","properties":{"field":{"type":"string","example":"name","readOnly":true},"rule":{"description":"invalid parameters rules","type":"string","enum":["enum"],"nullable":false,"readOnly":true},"reason":{"type":"string","example":"is a required field","readOnly":true},"choices":{"type":"array","items":{},"minItems":1,"nullable":false,"readOnly":true,"uniqueItems":true},"source":{"type":"string","example":"body"}},"additionalProperties":false,"required":["field","reason","rule","choices"]},"InvalidParameterDependentItem":{"type":"object","properties":{"field":{"type":"string","example":"name","readOnly":true},"rule":{"description":"invalid parameters rules","type":"string","enum":["dependent_fields"],"nullable":true,"readOnly":true},"reason":{"type":"string","example":"is a required field","readOnly":true},"dependents":{"type":"array","items":{},"nullable":true,"readOnly":true,"uniqueItems":true},"source":{"type":"string","example":"body"}},"additionalProperties":false,"required":["field","rule","reason","dependents"]},"InvalidParameters":{"description":"invalid parameters","type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/InvalidParameterStandard"},{"$ref":"#/components/schemas/InvalidParameterMinimumLength"},{"$ref":"#/components/schemas/InvalidParameterMaximumLength"},{"$ref":"#/components/schemas/InvalidParameterChoiceItem"},{"$ref":"#/components/schemas/InvalidParameterDependentItem"}]},"minItems":1,"nullable":false,"uniqueItems":true},"BadRequestError":{"allOf":[{"$ref":"#/components/schemas/BaseError"},{"type":"object","required":["invalid_parameters"],"properties":{"invalid_parameters":{"$ref":"#/components/schemas/InvalidParameters"}}}]},"NotFoundError":{"allOf":[{"$ref":"#/components/schemas/BaseError"},{"type":"object","properties":{"status":{"example":404},"title":{"example":"Not Found"},"type":{"example":"https://httpstatuses.com/404"},"instance":{"example":"kong:trace:1234567890"},"detail":{"example":"Not found"}}}]},"UnauthorizedError":{"allOf":[{"$ref":"#/components/schemas/BaseError"},{"type":"object","properties":{"status":{"example":401},"title":{"example":"Unauthorized"},"type":{"example":"https://httpstatuses.com/401"},"instance":{"example":"kong:trace:1234567890"},"detail":{"example":"Invalid credentials"}}}]},"ConflictError":{"allOf":[{"$ref":"#/components/schemas/BaseError"},{"type":"object","properties":{"status":{"example":409},"title":{"example":"Conflict"},"type":{"example":"https://httpstatuses.com/409"},"instance":{"example":"kong:trace:1234567890"},"detail":{"example":"Conflict"}}}]},"StringFieldEqualsFilter":{"description":"Filters on the given string field value by exact match.","properties":{"eq":{"type":"string"}},"title":"StringFieldEqualsFilter","x-examples":{"example-1":"equals-some-value","example-2":{"eq":"some-value"}}},"UUID":{"description":"Contains a unique identifier used for this resource.","type":"string","format":"uuid","example":"5f9fd312-a987-4628-b4c5-bb4f4fddd5f7","readOnly":true},"CreatedAt":{"description":"An ISO-8601 timestamp representation of entity creation date.","type":"string","format":"date-time","example":"2022-11-04T20:10:06.927Z","readOnly":true},"UpdatedAt":{"description":"An ISO-8601 timestamp representation of entity update date.","type":"string","format":"date-time","example":"2022-11-04T20:10:06.927Z","readOnly":true},"ForbiddenError":{"allOf":[{"$ref":"#/components/schemas/BaseError"},{"type":"object","properties":{"status":{"example":403},"title":{"example":"Forbidden"},"type":{"example":"https://httpstatuses.com/403"},"instance":{"example":"kong:trace:1234567890"},"detail":{"example":"Forbidden"}}}]},"CursorMetaPage":{"type":"object","properties":{"first":{"description":"URI to the first page","type":"string","format":"path"},"last":{"description":"URI to the last page","type":"string","format":"path"},"next":{"description":"URI to the next page","type":"string","format":"path","nullable":true},"previous":{"description":"URI to the previous page","type":"string","format":"path","nullable":true},"size":{"description":"Requested page size","type":"number","example":10}},"required":["size","next","previous"]},"CursorMeta":{"description":"Pagination metadata.","type":"object","properties":{"page":{"$ref":"#/components/schemas/CursorMetaPage"}},"required":["page"]}},"examples":{"400-request-format-is-invalid":{"value":{"status":400,"title":"Bad Request","detail":"","instance":"konnect:trace:3674017986744198214","invalid_parameters":[{"field":"body","reason":"request format is invalid"}]}},"400-cannot-be-blank":{"value":{"status":400,"title":"Bad Request","detail":"","instance":"konnect:trace:6644808935508571943","invalid_parameters":[{"field":"name","reason":"cannot be blank"}]}},"400-invalid-id-format":{"value":{"status":400,"title":"Bad Request","detail":"","instance":"konnect:trace:8988732526256293040","invalid_parameters":[{"field":"teamID","reason":"invalid ID format"}]}},"400-valid-uuid":{"value":{"status":400,"title":"Bad Request","detail":"","instance":"konnect:trace:7680390984800447837","invalid_parameters":[{"field":"id","reason":"must be a valid UUID v4"}]}},"400-password-complexity":{"value":{"status":400,"title":"Bad Request","detail":"Password does not meet complexity requirements.","instance":"konnect:trace:1738820719742148545","invalid_parameters":[{"field":"new_password","reason":"is too short (minimum length: 8)","rule":"min_length","minimum":8},{"field":"new_password","reason":"must contain at least 1 digit","rule":"min_digits","minimum":1},{"field":"new_password","reason":"must contain at least 1 lower case character","rule":"min_lowercase","minimum":1},{"field":"new_password","reason":"must contain at least 1 upper case character","rule":"min_uppercase","minimum":1},{"field":"new_password","reason":"must contain at least 1 special character","rule":"min_symbols","minimum":1}]}},"400-systems-team-modified":{"value":{"status":400,"title":"Bad Request","detail":"","instance":"konnect:trace:1738820719742148545","invalid_parameters":[{"field":"teamID","reason":"system teams cannot be modified"}]}},"400-authentication-settings-cannot-be-all-disabled":{"value":{"status":400,"title":"Bad Request","instance":"konnect:trace:6644808935508571943","invalid_parameters":[{"field":"oidc_auth_enabled","reason":"cannot be disabled when both basic auth and SAML are also disabled"},{"field":"basic_auth_enabled","reason":"cannot be disabled when both OIDC and SAML are also disabled"},{"field":"saml_auth_enabled","reason":"cannot be disabled when both OIDC and basic auth are also disabled"}],"detail":"Atleast one of the authentication schemes from basic, oidc or saml needs to be enabled"}},"400-oidc-auth-enabled-needs-idp":{"value":{"status":400,"title":"Bad Request","detail":"","instance":"konnect:trace:6644808935508571943","invalid_parameters":[{"field":"oidc_auth_enabled","reason":"cannot be set before configuring an identity provider"}]}},"400-idp-config-is-required":{"value":{"status":400,"title":"Bad Request","detail":"An IdP configuration is required","instance":"konnect:trace:6644808935508571943","invalid_parameters":[{"field":"data","reason":"cannot be set before configuring an identity provider"}]}},"404-not-found":{"value":{"status":404,"title":"Not Found","instance":"konnect:trace:2287285207635123011","detail":"The requested team was not found"}},"403-permission-denied":{"value":{"status":403,"title":"Permission denied","instance":"konnect:trace:2822394689570210664","detail":"Only enterprise organizations can create teams"}},"403-invalid-permissions":{"value":{"status":403,"title":"Invalid Permissions","detail":"You must have the [administrator] role to perform this action","instance":"konnect:trace:6c1ef33ae5bce33634d7d7d695c7f203"}},"403-auth-invalid":{"value":{"type":"https://kongapi.info/konnect/invalid-permissions","status":403,"title":"Invalid Permissions","detail":"You must have the [administrator] role to perform this action","instance":"konnect:trace:6c1ef33ae5bce33634d7d7d695c7f203"}},"409-SSO-user-managed-by-provider":{"value":{"status":409,"title":"Resource Conflict","instance":"kong:trace:2723154947768991354","detail":"User is managed by the SSO provider and cannot be modified directly"}},"401-unauthenticated":{"value":{"status":401,"title":"Unauthenticated","instance":"konnect:trace:952172606039454040","detail":"A valid token is required"}},"Update-Organization":{"value":{"owner_id":"df120cb4-f60b-47bc-a2f8-6a28e6a3c63b","name":"Kong Inc"}},"IdpTeamGroupMappingExample":{"value":{"id":"7f9fd312-a987-4628-b4c5-bb4f4fddd5f7","team_id":"6801e673-cc10-498a-94cd-4271de07a0d3","group":"Tech Leads","created_at":"2024-01-15T10:30:00.000Z","updated_at":"2024-01-15T10:30:00.000Z"}},"IdpTeamGroupMappingsCollectionExample":{"value":{"meta":{"page":{"first":"/identity-providers/d32d905a-ed33-46a3-a093-d8f536af9a8a/team-group-mappings?page[size]=10","last":"/identity-providers/d32d905a-ed33-46a3-a093-d8f536af9a8a/team-group-mappings?page[size]=10&page[after]=ewogICJpZCI6ICJoZWysbyB3b3JsZCIKgZ","next":"/identity-providers/d32d905a-ed33-46a3-a093-d8f536af9a8a/team-group-mappings?page[size]=10&page[after]=ewogICJpZCI6ICJoZWysbyB3b3JsZCIKgZ","previous":null,"size":10}},"data":[{"id":"7f9fd312-a987-4628-b4c5-bb4f4fddd5f7","team_id":"6801e673-cc10-498a-94cd-4271de07a0d3","group":"Tech Leads","created_at":"2024-01-15T10:30:00.000Z","updated_at":"2024-01-15T10:30:00.000Z"},{"id":"8f9fd312-a987-4628-b4c5-bb4f4fddd5f8","team_id":"6801e673-cc10-498a-94cd-4271de07a0d3","group":"API Engineers","created_at":"2024-01-15T11:00:00.000Z","updated_at":"2024-01-15T11:00:00.000Z"}]}},"CreateIdpTeamGroupMappingExample":{"value":{"team_id":"6801e673-cc10-498a-94cd-4271de07a0d3","group":"Tech Leads"}},"GetMFASettingsResponse":{"value":{"enabled":true}},"UnauthorizedExample":{"value":{"status":401,"title":"Unauthorized","instance":"kong:trace:8347343766220159418","detail":"Unauthorized"}},"NotFoundExample":{"value":{"status":404,"title":"Not Found","instance":"kong:trace:6816496025408232265","detail":"Not Found"}},"ForbiddenExample":{"value":{"status":403,"title":"Forbidden","instance":"kong:trace:2723154947768991354","detail":"You do not have permission to perform this action"}}},"requestBodies":{"CreateIdpTeamGroupMappingRequest":{"description":"Request to create an IDP team group mapping.","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"team_id":{"description":"The Konnect team ID to associate with the identity provider group.","type":"string","format":"uuid","example":"6801e673-cc10-498a-94cd-4271de07a0d3"},"group":{"description":"The identity provider group name. Group names are case sensitive.","type":"string","example":"Tech Leads"}},"required":["team_id","group"]},"examples":{"CreateIdpTeamGroupMapping":{"$ref":"#/components/examples/CreateIdpTeamGroupMappingExample"}}}}},"UpdateOrganization":{"description":"The request schema to update an organization.","content":{"application/json":{"schema":{"type":"object","properties":{"owner_id":{"description":"The user id of the new owner of the organization. Must be a member of the Organization Admins team.","type":"string","format":"uuid","example":"d9c56d92-0339-4dfb-be0c-2253162edba9"},"name":{"description":"The new name of the organization.","type":"string","example":"Kong Inc"},"mfa_enabled":{"description":"Whether multi-factor authentication (MFA) is enabled for the organization.","type":"boolean","example":true}}},"examples":{"Example Request Body":{"$ref":"#/components/examples/Update-Organization"}}}}},"GetMFASettingsRequest":{"description":"Request body for getting Multi-Factor Authentication (MFA) settings.","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"email":{"description":"The email address of the user to get MFA settings for.","type":"string","format":"email","example":"user@example.com"},"auth0id":{"description":"The Auth0 ID of the user to get MFA settings for.","type":"string","example":"auth0|1234567890","minLength":1}},"additionalProperties":false,"required":["email","auth0id"]}}}}},"responses":{"IdpTeamGroupMapping":{"description":"A single team group mapping.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IdpTeamGroupMapping"},"examples":{"IdpTeamGroupMapping":{"$ref":"#/components/examples/IdpTeamGroupMappingExample"}}}}},"IdpTeamGroupMappingsCollection":{"description":"A paginated collection of IDP team group mappings.","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/CursorMeta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/IdpTeamGroupMapping"}}}},"examples":{"IdpTeamGroupMappingsCollection":{"$ref":"#/components/examples/IdpTeamGroupMappingsCollectionExample"}}}}},"IdentityBadRequest":{"description":"Bad Request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/BadRequestError"},"examples":{"Request Format is Invalid":{"$ref":"#/components/examples/400-request-format-is-invalid"},"Cannot be Blank":{"$ref":"#/components/examples/400-cannot-be-blank"},"Invalid ID format":{"$ref":"#/components/examples/400-invalid-id-format"},"Must be a valid UUID v4":{"$ref":"#/components/examples/400-valid-uuid"},"System teams cannot be modified":{"$ref":"#/components/examples/400-systems-team-modified"},"Password Complexity":{"$ref":"#/components/examples/400-password-complexity"},"Authentication Settings cannot be all Disabled":{"$ref":"#/components/examples/400-authentication-settings-cannot-be-all-disabled"},"OIDC needs an IdP configuration":{"$ref":"#/components/examples/400-oidc-auth-enabled-needs-idp"},"IdP configuration is required":{"$ref":"#/components/examples/400-idp-config-is-required"},"Unsupported filter operation":{"value":{"status":400,"title":"Bad Request","detail":"","instance":"konnect:trace:3674017986744198214","invalid_parameters":[{"field":"[filter][actions][contains]","reason":"[contains] is not a supported filter operation"}]}}}}}},"SSOUserConflict":{"description":"Conflict","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ConflictError"},"examples":{"SSO User Managed by Provider":{"$ref":"#/components/examples/409-SSO-user-managed-by-provider"}}}}},"IdentityPermissionDenied":{"description":"Permission denied","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"},"examples":{"Permission Denied":{"$ref":"#/components/examples/403-permission-denied"},"Invalid Permissions":{"$ref":"#/components/examples/403-invalid-permissions"},"Username or Password invalid":{"$ref":"#/components/examples/403-auth-invalid"}}}}},"IdentityUnauthenticated":{"description":"Unauthenticated","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"},"examples":{"Unauthorized":{"$ref":"#/components/examples/401-unauthenticated"}}}}},"IdentityNotFound":{"description":"Not Found","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/NotFoundError"},"examples":{"Not Found":{"$ref":"#/components/examples/404-not-found"}}}}},"Roles":{"description":"The predefined, or system managed, roles.","content":{"application/json":{"schema":{"type":"object","properties":{"control_planes":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string","enum":["Control Planes"]},"roles":{"type":"object","properties":{"admin":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string","enum":["Admin"]},"description":{"type":"string","example":"This role grants full write access to all entities within a control plane.","enum":["This role grants full write access to all entities within a control plane."]}},"required":["name","description"]},"certificate_admin":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string","enum":["Certificate Admin"]},"description":{"type":"string","example":"This role grants full write access to administer certificates.","enum":["This role grants full write access to administer certificates."]}},"required":["name","description"]},"consumer_admin":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string","enum":["Consumer Admin"]},"description":{"description":"This role grants full write access to administer Consumers. Can configure plugins and view plugin partials for Consumers they have access to. Cannot create or modify global plugins or plugins outside their scope.","type":"string","example":"This role grants full write access to administer consumers.","enum":["This role grants full write access to administer consumers."]}},"required":["name","description"]},"creator":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string","enum":["Creator"]},"description":{"type":"string","example":"Creates a new Control Plane in an organization. The creator becomes the owner of the Control Plane they create.","enum":["Creates a new Control Plane in an organization. The creator becomes the owner of the Control Plane they create."]}},"required":["name","description"]},"debug_session_creator":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string","enum":["Debug Session Creator"]},"description":{"type":"string","example":"This role grants access to create debug sessions. This role also grants read-only access to all entities within a control plane.","enum":["This role grants access to create debug sessions. This role also grants read-only access to all entities within a control plane."]}},"required":["name","description"]},"deployer":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string","enum":["Deployer"]},"description":{"type":"string","example":"This role grants full write access to administer services, routes and plugins necessary to deploy services in Service Hub.","enum":["This role grants full write access to administer services, routes and plugins necessary to deploy services in Service Hub."]}},"required":["name","description"]},"gateway_service_admin":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string","enum":["Gateway Service Admin"]},"description":{"description":"This role grants full write access to administer Gateway Services. Can configure plugins and view plugin partials for Services they have access to. Cannot create or modify global plugins or plugins outside their scope.","type":"string","example":"This role grants full write access to administer gateway services.","enum":["This role grants full write access to administer gateway services."]}},"required":["name","description"]},"plugin_admin":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string","enum":["Plugin Admin"]},"description":{"description":"Can configure plugins at any scope (global, Service, Route, or Consumer) within a Control Plane Group. Also has write access to plugin partials.","type":"string","example":"This role grants full write access to administer plugins.","enum":["This role grants full write access to administer plugins."]}},"required":["name","description"]},"route_admin":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string","enum":["Route Admin"]},"description":{"description":"This role grants full write access to administer Routes. Can configure plugins and view plugin partials for Routes they have access to. Cannot create or modify global plugins or plugins outside their scope.","type":"string","example":"This role grants full write access to administer routes.","enum":["This role grants full write access to administer routes."]}},"required":["name","description"]},"sni_admin":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string","enum":["SNI Admin"]},"description":{"type":"string","example":"This role grants full write access to administer SNIs.","enum":["This role grants full write access to administer SNIs."]}},"required":["name","description"]},"upstream_admin":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string","enum":["Upstream Admin"]},"description":{"type":"string","example":"This role grants full write access to administer upstreams.","enum":["This role grants full write access to administer upstreams."]}},"required":["name","description"]},"viewer":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string","enum":["Viewer"]},"description":{"description":"This role grants read-only access to all the configurations of a Control Plane Group and corresponding Data Plane nodes. Includes read-only access to plugin partials within accessible scopes.","type":"string","example":"This role grants read only access to all entities within a control plane.","enum":["This role grants read only access to all entities within a control plane."]}},"required":["name","description"]}}}},"required":["name","roles"]},"api_products":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string","enum":["API Products"]},"roles":{"type":"object","properties":{"admin":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string","enum":["Admin"]},"description":{"type":"string","example":"This role grants full write access to an API product and its versions.","enum":["This role grants full write access to an API product and its versions."]}},"required":["name","description"]},"application_registration":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string","enum":["Application Registration"]},"description":{"type":"string","example":"This role grants permission to enable and disable application registration on an API product.","enum":["This role grants permission to enable and disable application registration on an API product."]}},"required":["name","description"]},"creator":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string","enum":["Creator"]},"description":{"type":"string","example":"This access is required to create API products. This access is not for creating sub-entities such as versions, API specs, etc.","enum":["This access is required to create API products. This access is not for creating sub-entities such as versions, API specs, etc."]}},"required":["name","description"]},"deployer":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string","enum":["Deployer"]},"description":{"type":"string","example":"This role grants permission to deploy and remove an API product from a control plane.","enum":["This role grants permission to deploy and remove an API product from a control plane."]}},"required":["name","description"]},"maintainer":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string","enum":["Maintainer"]},"description":{"type":"string","example":"This role grants all write permission to manage an API product and to administer plugins.","enum":["This role grants all write permission to manage an API product and to administer plugins."]}},"required":["name","description"]},"plugins_admin":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string","enum":["Plugins Admin"]},"description":{"type":"string","example":"This role grants full write permission to administer plugins.","enum":["This role grants full write permission to administer plugins."]}},"required":["name","description"]},"publisher":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string","enum":["Publisher"]},"description":{"type":"string","example":"This role grants permission to publish an API product to one or more portals.","enum":["This role grants permission to publish an API product to one or more portals."]}},"required":["name","description"]},"viewer":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string","enum":["Viewer"]},"description":{"type":"string","example":"Viewer has read-only access to an API product and its sub-entities.","enum":["Viewer has read-only access to an API product and its sub-entities."]}},"required":["name","description"]}}}},"required":["name","roles"]},"portals":{"$ref":"#/components/schemas/PortalsRoles"},"application_auth_strategies":{"$ref":"#/components/schemas/ApplicationAuthStrategiesRoles"},"dcr_providers":{"$ref":"#/components/schemas/DCRProvidersRoles"},"audit_logs":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string","enum":["Audit Logs"]},"roles":{"type":"object","properties":{"admin":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string","enum":["Admin"]},"description":{"type":"string","example":"This role grants full write access to the Audit log configuration.","enum":["This role grants full write access to the Audit log configuration."]}},"required":["name","description"]}}}},"required":["name","roles"]},"identity":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string","enum":["Identity"]},"roles":{"type":"object","properties":{"admin":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string","enum":["Admin"]},"description":{"type":"string","example":"This role grants full write access to the Identity configuration.","enum":["This role grants full write access to the Identity configuration."]}},"required":["name","description"]}}}},"required":["name","roles"]},"mesh_control_planes":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string","enum":["Mesh Control Plane"]},"roles":{"type":"object","properties":{"admin":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string","enum":["Admin"]},"description":{"type":"string","example":"This role grants full write access to the related to Mesh control planes.","enum":["This role grants full write access to the related to Mesh control planes."]}},"required":["name","description"]},"connector":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string","enum":["Connector"]},"description":{"type":"string","example":"This role grants a mesh zone to connect to the mesh control plane in Konnect.","enum":["This role grants a mesh zone to connect to the mesh control plane in Konnect."]}},"required":["name","description"]},"creator":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string","enum":["Creator"]},"description":{"type":"string","example":"This role grants access to create new Mesh control planes.","enum":["This role grants access to create new Mesh control planes."]}},"required":["name","description"]},"viewer":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string","enum":["Viewer"]},"description":{"type":"string","example":"This role grants access to read-only permissions to Mesh control planes.","enum":["This role grants access to read-only permissions to Mesh control planes."]}},"required":["name","description"]}}}},"required":["name","roles"]},"dashboards":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string","enum":["Dashboards"]},"roles":{"type":"object","properties":{"admin":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string","enum":["Admin"]},"description":{"type":"string","example":"Allows users to edit, delete, and share a Dashboard in Konnect Analytics.","enum":["Allows users to edit, delete, and share a Dashboard in Konnect Analytics."]}},"required":["name","description"]},"creator":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string","enum":["Creator"]},"description":{"type":"string","example":"Allows users to create a new Dashboard in Konnect Analytics.","enum":["Allows users to create a new Dashboard in Konnect Analytics."]}},"required":["name","description"]},"editor":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string","enum":["Editor"]},"description":{"type":"string","example":"Allows users to edit a Dashboard in Konnect Analytics.","enum":["Allows users to edit a Dashboard in Konnect Analytics."]}},"required":["name","description"]},"viewer":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string","enum":["Viewer"]},"description":{"type":"string","example":"Allows users to view any Dashboards content in Konnect Analytics.","enum":["Allows users to view any Dashboards content in Konnect Analytics."]}},"required":["name","description"]}}}},"required":["name","roles"]},"reports":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string","enum":["Reports"]},"roles":{"type":"object","properties":{"admin":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string","enum":["Admin"]},"description":{"type":"string","example":"Allows users to edit, delete, and share a Report in Konnect Analytics.","enum":["Allows users to edit, delete, and share a Report in Konnect Analytics."]}},"required":["name","description"]},"creator":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string","enum":["Creator"]},"description":{"type":"string","example":"Allows users to create a new Report in Konnect Analytics.","enum":["Allows users to create a new Report in Konnect Analytics."]}},"required":["name","description"]},"editor":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string","enum":["Editor"]},"description":{"type":"string","example":"Allows users to edit a Report in Konnect Analytics.","enum":["Allows users to edit a Report in Konnect Analytics."]}},"required":["name","description"]},"viewer":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string","enum":["Viewer"]},"description":{"type":"string","example":"Allows users to view a Report in Konnect Analytics.","enum":["Allows users to view a Report in Konnect Analytics."]}},"required":["name","description"]}}}},"required":["name","roles"]}},"title":"Roles Response"},"examples":{"Predefined Roles":{"value":{"control_planes":{"name":"Control Planes","roles":{"admin":{"name":"Admin","description":"This role grants full write access to all entities within a control plane."},"certificate_admin":{"name":"Certificate Admin","description":"This role grants full write access to administer certificates."},"consumer_admin":{"name":"Consumer Admin","description":"This role grants full write access to administer consumers."},"creator":{"name":"Creator","description":"Creates a new Control Plane in an organization. The creator becomes the owner of the Control Plane they create."},"debug_session_creator":{"name":"Debug Session Creator","description":"This role grants access to create debug sessions. This role also grants read-only access to all entities within a control plane."},"deployer":{"name":"Deployer","description":"This role grants full write access to administer services, routes and plugins necessary to deploy services in Service Hub."},"gateway_service_admin":{"name":"Gateway Service Admin","description":"This role grants full write access to administer gateway services."},"plugin_admin":{"name":"Plugin Admin","description":"This role grants full write access to administer plugins."},"route_admin":{"name":"Route Admin","description":"This role grants full write access to administer routes."},"sni_admin":{"name":"SNI Admin","description":"This role grants full write access to administer SNIs."},"upstream_admin":{"name":"Upstream Admin","description":"This role grants full write access to administer upstreams."},"viewer":{"name":"Viewer","description":"This role grants read only access to all entities within a control plane."}}},"api_products":{"name":"API Products","roles":{"admin":{"name":"Admin","description":"This role grants full write access to an API product and its versions."},"application_registration":{"name":"Application Registration","description":"This role grants permission to enable and disable application registration on an API product."},"creator":{"name":"Creator","description":"This access is required to create API products. This access is not for creating sub-entities such as versions, API specs, etc."},"deployer":{"name":"Deployer","description":"This role grants permission to deploy and remove an API product from a control plane."},"maintainer":{"name":"Maintainer","description":"This role grants all write permission to manage an API product and to administer plugins."},"plugins_admin":{"name":"Plugins Admin","description":"This role grants full write permission to administer plugins."},"publisher":{"name":"Publisher","description":"This role grants permission to publish an API product to one or more portals."},"viewer":{"name":"Viewer","description":"Viewer has read-only access to an API product and its sub-entities."}}},"audit_logs":{"name":"Audit Logs","roles":{"admin":{"name":"Admin","description":"This role grants full write access to the Audit log configuration."}}},"identity":{"name":"Identity","roles":{"admin":{"name":"Admin","description":"This role grants full write access to the Identity configuration."}}},"mesh_control_planes":{"name":"Mesh Control Plane","roles":{"admin":{"name":"Admin","description":"This role grants full write access to the related to Mesh control planes."},"connector":{"name":"Connector","description":"This role grants a mesh zone to connect to the mesh control plane in Konnect."},"creator":{"name":"Creator","description":"This role grants access to create new Mesh control planes."},"viewer":{"name":"Viewer","description":"This role grants access to read-only permissions to Mesh control planes."}}},"dashboards":{"name":"Dashboards","roles":{"viewer":{"name":"Viewer","description":"Allows users to view any Dashboards content in Konnect Analytics."}}}}}}}}},"MeOrganization":{"description":"Me Organization","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"UUID of the organization.","type":"string","format":"uuid","readOnly":true},"name":{"description":"Name of the organization.","type":"string"},"owner_id":{"description":"Owner ID of the organization.","type":"string"},"login_path":{"description":"Path to organization-specific login when single sign on (SSO) is enabled. Blank otherwise.","type":"string"},"created_at":{"description":"Date the organization was created.","type":"string","format":"date-time","readOnly":true},"updated_at":{"description":"Date the organization was last updated.","type":"string","format":"date-time","readOnly":true},"state":{"description":"State of the organization","type":"string","enum":["active","inactive","deleting","deleted"]},"retention_period_days":{"description":"The number of days an organization spends inactive before being deleted.","type":"integer"},"pats_enabled":{"description":"Whether Personal Access Tokens (PATs) are enabled for the organization.","type":"boolean"},"mfa_enabled":{"description":"Whether Multi-Factor Authentication (MFA) is enabled for the organization.","type":"boolean"}},"example":{"id":"d99c041a-c7cf-46a2-bf3a-44bb5f75400e","name":"string","owner_id":"1c9c3848-5897-4f2c-beed-df6f3e3adb37","created_at":"2023-01-23T17:22:52.150Z","updated_at":"2023-01-23T17:22:52.150Z","state":"active","retention_period_days":90},"title":"Me Organization Response"},"examples":{"Example":{"value":{"id":"023bfa42-3513-4cbf-b059-a9ddb4ea995d","name":"Acme Co.","owner_id":"e02c829c-0e2d-44b5-9057-07714ea613a3","login_path":"acme","created_at":"2023-01-18T11:35:45.130Z","updated_at":"2023-01-23T17:22:52.150Z","state":"active","retention_period_days":90,"pats_enabled":true,"mfa_enabled":true}}}}}},"GetMFASettingsResponse":{"description":"Response containing Multi-Factor Authentication settings.","content":{"application/json":{"schema":{"type":"object","properties":{"mfa_enabled":{"description":"Whether MFA is enabled for the user","type":"boolean"}},"additionalProperties":false,"required":["mfa_enabled"]},"examples":{"Multi-Factor Authentication Response":{"$ref":"#/components/examples/GetMFASettingsResponse"}}}}},"BadRequest":{"description":"Bad Request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}}},"responses-Unauthorized":{"description":"Unauthorized","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"},"examples":{"UnauthorizedExample":{"$ref":"#/components/examples/UnauthorizedExample"}}}}},"NotFound":{"description":"Not Found","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/NotFoundError"},"examples":{"NotFoundExample":{"$ref":"#/components/examples/NotFoundExample"}}}}},"Conflict":{"description":"Conflict","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ConflictError"}}}},"Forbidden":{"description":"Forbidden","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"},"examples":{"UnauthorizedExample":{"$ref":"#/components/examples/ForbiddenExample"}}}}}},"securitySchemes":{"systemAccountAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"Token","description":"The system account access token is meant for automations and integrations that are not directly associated with a human identity.\nYou can generate a system account Access Token by creating a system account and then obtaining a system account access token for that account.\nThe access token must be passed in the header of a request, for example:\n`curl -X GET 'https://global.api.konghq.com/v2/users/' --header 'Authorization: Bearer spat_i2Ej...'`\n"},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"Token","description":"The personal access token is meant to be used as an alternative to basic-auth when accessing Konnect via APIs.\nYou can generate a Personal Access Token (PAT) from the [personal access token page](https://cloud.konghq.com/global/account/tokens/) in the Konnect dashboard.\nThe PAT token must be passed in the header of a request, for example:\n`curl -X GET 'https://global.api.konghq.com/v2/users/' --header 'Authorization: Bearer kpat_xgfT...'`\n"},"konnectAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The Konnect access token is meant to be used by the Konnect dashboard and the decK CLI authenticate with.\n"},"clientToken":{"type":"http","scheme":"bearer","bearerFormat":"Token","description":"The Client token is meant to be used by internal service clients for the MinK integration.\n"},"serviceAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The Service access token is meant to be used between internal services.\n"}}},"tags":[{"name":"Auth Settings"},{"name":"Roles"},{"name":"Users"},{"name":"Me"}],"security":[{"personalAccessToken":[]},{"systemAccountAccessToken":[]},{"konnectAccessToken":[]},{"clientToken":[]},{"serviceAccessToken":[]}]}
```
