---
title: "Konnect Identity"
url: "https://nov18-dev.movespot.fyi/apis/konnect-identity-internal-3/versions/4156893f-a5db-4eb8-8deb-93f18fa8fbfa"
---

# 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/register":{"post":{"operationId":"post-auth0-register-internal","summary":"Create Organization (Internal)","description":"Create a new organization with Auth0 authentication. The Auth0 user will be the organization owner.","requestBody":{"$ref":"#/components/requestBodies/Auth0Registration"},"responses":{"201":{"$ref":"#/components/responses/Auth0Registration"},"400":{"$ref":"#/components/responses/IdentityBadRequest"},"404":{"$ref":"#/components/responses/IdentityNotFound"}},"tags":["SSO Auth0"]}},"/internal/auth0/organizations":{"get":{"operationId":"get-auth0-organizations-internal","summary":"List Organizations (Internal)","description":"Retrieves the list of organizations available to the given user.","responses":{"200":{"$ref":"#/components/responses/Auth0OrganizationsCollection"},"400":{"$ref":"#/components/responses/IdentityBadRequest"},"404":{"$ref":"#/components/responses/IdentityNotFound"}},"tags":["SSO Auth0"]}},"/internal/users":{"get":{"operationId":"get-users-internal","summary":"List Users (Internal)","description":"The response contains user ids and (non-deleted, non-deleting) organization ids for users associated with provided auth0 user subject.","parameters":[{"name":"aid","in":"query","description":"Auth0 User ID","schema":{"type":"string"}}],"responses":{"200":{"$ref":"#/components/responses/InternalUsers"},"400":{"$ref":"#/components/responses/IdentityBadRequest"}},"tags":["Users"]}},"/internal/oauth/device/authorize":{"post":{"operationId":"post-oauth-device-authorize","summary":"Device authorization request","description":"Initiates a device authorization workflow, generating and returning a unique device verification code.\nSee https://www.rfc-editor.org/rfc/rfc8628#section-3.1 for details.","requestBody":{"description":"The request schema for the device authorization request.","required":true,"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"client_id":{"description":"The client identifier.","type":"string"},"scope":{"description":"The scope of the access request.","type":"string"}},"required":["client_id"]}}}},"responses":{"200":{"$ref":"#/components/responses/DeviceAuthorizationResponse"},"400":{"$ref":"#/components/responses/DeviceAuthorizationGrantAuthorizeBadRequest"}},"security":[{}],"tags":["Device Authorization Grant"]}},"/internal/oauth/device/token":{"post":{"operationId":"post-oauth-device-token","summary":"Device access token request","description":"This endpoint provides the machine client a means of being notified when a request for authorization is granted or rejected.\nIt is expected for the client to try the access token request repeatedly in a polling fashion based on the error code in the response.\nSee https://www.rfc-editor.org/rfc/rfc8628#section-3.4 for details.","requestBody":{"description":"The request schema for the device access token request.","required":true,"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"grant_type":{"description":"Value MUST be set to \"urn:ietf:params:oauth:grant-type:device_code\".","type":"string"},"device_code":{"description":"The device verification code, \"device_code\" from the device authorization response.","type":"string"},"client_id":{"description":"The client identifier.","type":"string"}},"required":["grant_type","device_code","client_id"]}}}},"responses":{"200":{"$ref":"#/components/responses/DeviceAccessTokenResponse"},"400":{"$ref":"#/components/responses/DeviceAuthorizationGrantTokenBadRequest"}},"security":[{}],"tags":["Device Authorization Grant"]}},"/internal/oauth/device/authorize/user":{"post":{"operationId":"post-oauth-device-authorize-user","summary":"User device authorization request","description":"Marks the device code as authorized and is a means to provide the interactive UI flow with the necessary request metadata for the user to confirm the request.","requestBody":{"$ref":"#/components/requestBodies/DeviceAuthorizationUserRequest"},"responses":{"201":{"$ref":"#/components/responses/DeviceAuthorizationUserResponse"},"400":{"$ref":"#/components/responses/IdentityBadRequest"},"401":{"$ref":"#/components/responses/IdentityUnauthenticated"},"403":{"$ref":"#/components/responses/Unauthorized"}},"security":[{"konnectAccessToken":[]}],"tags":["Device Authorization Grant"]}},"/internal/oauth/device/confirm":{"patch":{"operationId":"patch-oauth-device-confirm","summary":"Device confirmation request","description":"Confirms the authorization request by marking the device code as confirmed.","requestBody":{"$ref":"#/components/requestBodies/DeviceConfirmationRequest"},"responses":{"204":{"description":"No Content"},"400":{"$ref":"#/components/responses/IdentityBadRequest"},"401":{"$ref":"#/components/responses/IdentityUnauthenticated"},"403":{"$ref":"#/components/responses/Unauthorized"}},"security":[{"konnectAccessToken":[]}],"tags":["Device Authorization Grant"]}},"/internal/system-accounts/{accountId}/assigned-roles":{"parameters":[{"name":"accountId","in":"path","description":"ID of the system account.","required":true,"schema":{"type":"string"}}],"get":{"operationId":"get-system-accounts-assigned-roles-internal","summary":"List Roles (Internal)","description":"Lists the roles belonging to a managed system account.  Returns 400 if any filter parameters are invalid.","parameters":[{"name":"filter","in":"query","description":"Filter roles returned in the response.","required":false,"schema":{"type":"object","properties":{"entity_id":{"$ref":"#/components/schemas/StringFieldEqualsFilter"},"role_name":{"$ref":"#/components/schemas/StringFieldEqualsFilter"},"entity_type_name":{"$ref":"#/components/schemas/StringFieldEqualsFilter"}}},"style":"deepObject"}],"responses":{"200":{"$ref":"#/components/responses/ParameterizedAssignedRolesCollection"},"400":{"$ref":"#/components/responses/IdentityBadRequest"},"401":{"$ref":"#/components/responses/IdentityUnauthenticated"},"403":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/IdentityNotFound"}},"security":[{"clientToken":[]}],"tags":["Managed System Accounts - Roles"]},"post":{"operationId":"create-system-accounts-assigned-roles-internal","summary":"Assign a role to a managed System Account","description":"Assigns a role to a managed system account. Returns 409 if role is already assigned.","requestBody":{"$ref":"#/components/requestBodies/AssignParameterizedRole"},"responses":{"201":{"$ref":"#/components/responses/ParameterizedAssignedRoleSingle"},"401":{"$ref":"#/components/responses/IdentityUnauthenticated"},"403":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/IdentityNotFound"},"409":{"$ref":"#/components/responses/IdentityConflict"}},"security":[{"clientToken":[]}],"tags":["Managed System Accounts - Roles"]}},"/users/me":{"delete":{"operationId":"delete-users-me","summary":"Delete My User Account","description":"Deletes the user account for the user identified in the token of the request.","responses":{"204":{"description":"No Content"},"401":{"$ref":"#/components/responses/IdentityUnauthenticated"},"403":{"description":"Forbidden - If there are other users in the organization or a konnectAccessToken was not provided."}},"security":[{"konnectAccessToken":[]}],"tags":["Me"]},"patch":{"operationId":"patch-users-me","summary":"Update My User Account","description":"Updates the user account for the user identified in the token of the request.","requestBody":{"$ref":"#/components/requestBodies/UpdateUser"},"responses":{"200":{"$ref":"#/components/responses/UserSingle"},"400":{"description":"Bad Request - Invalid Parameters"},"401":{"$ref":"#/components/responses/IdentityUnauthenticated"},"403":{"description":"Forbidden - If a konnectAccessToken was not provided."}},"security":[{"konnectAccessToken":[]}],"tags":["Me"]}},"/users/me/permissions":{"get":{"operationId":"get-users-me-permissions","summary":"Get My Permissions","description":"Returns the permissions for the current user","parameters":[{"name":"filter","in":"query","description":"Filter permissions returned in the response.","required":false,"schema":{"type":"object","properties":{"actions":{"$ref":"#/components/schemas/StringFieldEqualsFilter"},"region":{"$ref":"#/components/schemas/StringFieldEqualsFilter"},"resource":{"$ref":"#/components/schemas/StringFieldEqualsFilter"},"service":{"$ref":"#/components/schemas/StringFieldEqualsFilter"},"top_level":{"$ref":"#/components/schemas/BooleanFieldFilter"}}},"style":"deepObject"}],"responses":{"200":{"$ref":"#/components/responses/UserPermissions"},"400":{"$ref":"#/components/responses/IdentityBadRequest"},"401":{"$ref":"#/components/responses/IdentityUnauthenticated"}},"security":[{"konnectAccessToken":[]}],"tags":["Me"]}},"/organizations/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"]}},"/refresh":{"post":{"operationId":"refresh-token","summary":"Refresh Token","description":"Issues new tokens. Returns 401 if a) the user is no longer active, b) the token has exceeded its lifetime limit, or c) the token has been revoked.","responses":{"204":{"description":"No Content"},"401":{"$ref":"#/components/responses/IdentityUnauthenticated"}},"tags":["Authentication"]}},"/logout":{"post":{"operationId":"logout","summary":"Log Out","description":"Clears the auth cookies.","responses":{"201":{"$ref":"#/components/responses/LogoutResponse"}},"tags":["Authentication"]}},"/aws/marketplace/resolve-customer":{"post":{"operationId":"resolveCustomer","summary":"Resolves an AWS Customer","description":"This call the aws marketplace resolve customer api.","requestBody":{"$ref":"#/components/requestBodies/AWSResolveCustomerRequest"},"responses":{"201":{"$ref":"#/components/responses/ResolveCustomerResponse"},"400":{"$ref":"#/components/responses/IdentityBadRequest"}},"tags":["AWS"]}}},"components":{"schemas":{"BaseDeviceAuthorizationGrantBadRequest":{"type":"object","properties":{"error_description":{"description":"Human-readable text providing additional information, used to assist the client developer in understanding the error that occurred.","type":"string"},"error_uri":{"description":"A URI identifying a human-readable web page with information about the error, used to provide the client developer with additional information about the error.","type":"string"}},"title":"Base Device Authorization Grant Bad Request"},"DeviceAuthorizationGrantAuthorizeError":{"description":"The error response for the device authorization grant request.","type":"object","properties":{"error":{"description":"A single error code from the following enum.\n\n  invalid_request\n     The request is missing a required parameter, includes an unsupported parameter value (other than grant type),\n     repeats a parameter, includes multiple credentials, utilizes more than one mechanism for authenticating the\n     client, or is otherwise malformed.\n\n  invalid_client\n     Client authentication failed (e.g., unknown client, no client authentication included, or unsupported\n     authentication method).\n\n  invalid_grant\n     The provided authorization grant (e.g., authorization code, resource owner credentials) or refresh token is\n     invalid, expired, revoked, does not match the redirection URI used in the authorization request, or was issued to\n     another client.\n\n  unauthorized_client\n     The authenticated client is not authorized to use this authorization grant type.\n\n  unsupported_grant_type\n     The authorization grant type is not supported by the authorization server.\n\n  invalid_scope\n     The requested scope is invalid, unknown, malformed, or exceeds the scope granted by the resource owner.","type":"string","enum":["invalid_request","invalid_client","invalid_grant","unauthorized_client","unsupported_grant_type","invalid_scope"]}},"required":["error"],"title":"Device Authorization Grant Authorize Error"},"DeviceAuthorizationGrantTokenError":{"description":"The error response for the device token request.","type":"object","properties":{"error":{"description":"A single error code from the following enum.\n\n  authorization_pending\n     The authorization request is still pending as the end user hasn't yet completed the user-interaction steps.\n\n  slow_down\n     A variant of \"authorization_pending\", the authorization request is still pending and polling should continue, but the interval MUST\n     be increased by 5 seconds for this and all subsequent requests.\n\n  access_denied\n     The authorization request was denied.\n\n  expired_token\n     The \"device_code\" has expired, and the device authorization session has concluded.","type":"string","enum":["authorization_pending","slow_down","access_denied","expired_token"]}},"required":["error"],"title":"Device Authorization Grant Token Error"},"Auth0Organization":{"description":"A single auth0 organization.","type":"object","properties":{"name":{"description":"The name of the organization.","type":"string","example":"My Organization","readOnly":true},"login_path":{"description":"The login path of the organization.","type":"string","example":"/v2/authenticate/federated?org_id=7f9fd312-a987-4628-b4c5-bb4f4fddd5f7","readOnly":true}},"title":"Auth0 organization schema."},"Auth0Registration":{"description":"A successful Auth0 organization registration response.","type":"object","properties":{"organization_id":{"type":"string"},"login_path":{"type":"string"}},"title":"Auth0 organization registration response"},"User":{"description":"The user object contains information about an individual user who can use the Konnect application and API.","type":"object","properties":{"id":{"description":"The User ID.","type":"string","format":"uuid","example":"7f9fd312-a987-4628-b4c5-bb4f4fddd5f7","readOnly":true},"email":{"description":"The email registered to the user.","type":"string","format":"email","example":"user@email.com","maxLength":250},"full_name":{"description":"The User's full name.","type":"string","example":"Jane Doe","maxLength":250,"pattern":"^[\\w \\W]+$"},"preferred_name":{"description":"The User's preferred name.","type":"string","example":"Jane","maxLength":250},"active":{"description":"Returns True if a user has verified their email address.","type":"boolean","default":true,"readOnly":true},"inferred_region":{"description":"The Konnect region closest to the user's IP address. This property might only be set for users on signup through Konnect’s build-in native authentication.","type":"string","example":"us","readOnly":true},"created_at":{"description":"The time stamp for the date the account was registered.","type":"string","format":"date-time","example":"2022-02-07T17:46:57.52Z","readOnly":true},"updated_at":{"description":"A Unix timestamp representation of the most recent change to the User account.","type":"string","format":"date-time","example":"2022-10-08T17:00:00.52Z","readOnly":true}},"example":{"id":"7f9fd312-a987-4628-b4c5-bb4f4fddd5f7","email":"user@email.com","full_name":"Test User","preferred_name":"test","active":true,"inferred_region":"us","created_at":"2022-02-07T17:46:57.52Z","updated_at":"2022-10-08T17:00:00.52Z"},"title":"User"},"ParameterizedAssignedRole":{"description":"A parameterized assigned role is a role that has been assigned to a managed system account with additional parameters.","type":"object","properties":{"id":{"description":"The ID of the role assignment.","type":"string","format":"uuid","example":"eaf7adf1-32c8-4bbf-b960-d1f8456afe67"},"role_name":{"description":"Name of the role being assigned.","type":"string","example":"Viewer"},"entity_id":{"description":"A RBAC entity ID.","type":"string","format":"uuid","example":"817d0422-45c9-4d88-8d64-45aef05c1ae7"},"entity_type_name":{"description":"Name of the entity type the role is being assigned to.","type":"string","example":"Control Planes"},"entity_region":{"description":"Region of the entity.","type":"string","example":"eu","enum":["us","eu","au","me","in","sg","*"]},"parameters":{"description":"Additional parameters for the role assignment.","additionalProperties":true,"type":"object"}},"example":{"id":"54cc6168-ebb1-4300-8168-d62a0dd08fc8","role_name":"Viewer","entity_id":"18ee2573-dec0-4b83-be99-fa7700bcdc61","entity_type_name":"Control Planes","entity_region":"us","parameters":{"zoneName":"zone3"}},"title":"ParameterizedAssignedRole"},"UserOrgIDs":{"description":"User with Organization IDs only.","type":"object","properties":{"id":{"description":"ID of a user.","type":"string","format":"uuid","readOnly":true},"organization_id":{"description":"organization ID of a user.","type":"string","format":"uuid","readOnly":true}},"title":"User with Organization IDs only."},"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"}}}]},"PageMeta":{"description":"Contains pagination query parameters and the total number of objects returned.","type":"object","properties":{"number":{"type":"number","example":1},"size":{"type":"number","example":10},"total":{"type":"number","example":100}},"required":["number","size","total"]},"PaginatedMeta":{"description":"returns the pagination information","type":"object","properties":{"page":{"$ref":"#/components/schemas/PageMeta"}},"required":["page"],"title":"PaginatedMeta"},"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"}}},"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"}}}]},"BooleanFieldFilter":{"description":"Filter by a boolean value (true/false).","type":"boolean","title":"BooleanFieldFilter","x-examples":{"example-1":true}}},"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-user-is-already-active":{"value":{"status":409,"title":"Resource Conflict","instance":"konnect:trace:6644808935508571943","detail":"User is already active"}},"Parameterized-Assigned-Roles-Collection-Example":{"value":{"meta":{"page":{"number":1,"size":10,"total":100}},"data":[{"id":"b02e23c5-8ee4-4e5a-99f4-43329923adcd","role_name":"Connector","entity_id":"437c7192-fea0-4f35-8478-c8d57783f8c1","entity_type_name":"Mesh Control Planes","entity_region":"us","parameters":{"zoneName":"zone2"}},{"id":"869d9402-f117-4f9a-840f-69acaf70a81a","role_name":"Connector","entity_id":"18ee2573-dec0-4b83-be99-fa7700bcdc61","entity_type_name":"Mesh Control Planes","entity_region":"eu","parameters":{"zoneName":"zone3"}}]}},"Parameterized-Assigned-Role-Example":{"value":{"id":"eaf7adf1-32c8-4bbf-b960-d1f8456afe67","role_name":"Connector","entity_id":"18ee2573-dec0-4b83-be99-fa7700bcdc61","entity_type_name":"Mesh Control Planes","entity_region":"eu","parameters":{"zoneName":"zone4"}}},"401-unauthenticated":{"value":{"status":401,"title":"Unauthenticated","instance":"konnect:trace:952172606039454040","detail":"A valid token is required"}},"Get-User-Response":{"value":{"id":"7f9fd312-a987-4628-b4c5-bb4f4fddd5f7","email":"james.woods@email.com","full_name":"James Woods","preferred_name":"Jimmy","active":true,"created_at":"1992-02-07T17:46:57.52Z","updated_at":"2022-02-07T17:00:00.52Z"}},"Update-User-Request":{"value":{"full_name":"James C Woods","preferred_name":"Jimmy"}},"Update-Organization":{"value":{"owner_id":"df120cb4-f60b-47bc-a2f8-6a28e6a3c63b","name":"Kong Inc"}},"AWS-Resolve-Customer-Request":{"value":{"token":"A1B2C3D4E5F6G7H8I9J0K+LMNOPQRSTUVWXYZabcd+efghijklmnopqrstuv+wxyz0123456789+"}}},"requestBodies":{"Auth0Registration":{"content":{"application/json":{"schema":{"description":"Auth0 organization registration","type":"object","properties":{"organization_name":{"type":"string"},"default_region":{"type":"string"},"mfa_enabled":{"description":"Whether Multi-Factor Authentication (MFA) is enabled for the organization.","type":"boolean","default":true}},"required":["organization_name","default_region"],"title":"Auth0 organization register"}}}},"UpdateUser":{"description":"The request schema for the update user request.","content":{"application/json":{"schema":{"type":"object","properties":{"full_name":{"description":"The user's full name.","type":"string","example":"James C. Woods","maxLength":250,"pattern":"^[\\w \\W]+$","writeOnly":true},"preferred_name":{"description":"The user's desired name.","type":"string","example":"Jimmy","maxLength":250,"writeOnly":true}}},"examples":{"Example Request Body":{"$ref":"#/components/examples/Update-User-Request"}}}}},"AssignParameterizedRole":{"content":{"application/json":{"schema":{"description":"A parameterized assigned role is a role that has been assigned to a managed system account.","type":"object","properties":{"role_name":{"description":"The desired role.","type":"string","example":"Connector"},"entity_id":{"description":"The ID of the entity.","type":"string","format":"uuid","example":"e67490ce-44dc-4cbd-b65e-b52c746fc26a"},"entity_type_name":{"description":"The type of entity.","type":"string","example":"Mesh Control Planes"},"entity_region":{"description":"The region to scope the role assignment to.","type":"string","example":"eu","enum":["us","eu","au","me","in","sg","*"]},"parameters":{"example":{"zoneName":"zone3"},"type":"object"}}},"examples":{"Parameterized-Assigned-Role":{"$ref":"#/components/examples/Parameterized-Assigned-Role-Example"}}}},"description":"The request schema for assigning a role."},"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"}}}}},"AWSResolveCustomerRequest":{"description":"AWS Marketplace Metering Resolve Customer request.","content":{"application/json":{"schema":{"type":"object","properties":{"token":{"description":"Token is the aws customer token from the aws marketplace.","type":"string"}},"required":["token"]},"examples":{"Example Request Body":{"$ref":"#/components/examples/AWS-Resolve-Customer-Request"}}}}},"DeviceAuthorizationUserRequest":{"description":"The request schema for the user device authorization request.","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"user_code":{"description":"The end-user device verification code.","type":"string"}},"required":["user_code"]}}}},"DeviceConfirmationRequest":{"description":"The request schema for the device confirmation request.","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"user_code":{"description":"The end-user device verification code.","type":"string"}},"required":["user_code"]}}}}},"responses":{"Auth0Registration":{"description":"Auth0 organization registration","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Auth0Registration"}}}},"InternalUsers":{"description":"A get action paginated response of users and organization IDs.","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/PaginatedMeta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/UserOrgIDs"}}}},"examples":{"Internal Users Collection":{"value":{"meta":{"page":{"number":1,"size":1,"total":10}}}}}}}},"Auth0OrganizationsCollection":{"description":"A paginated list response for a collection of auth0 organizations.","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/PaginatedMeta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Auth0Organization"}}},"title":"Auth0 Organizations Collection Response"},"examples":{"Organization Collection":{"value":{"meta":{"page":{"number":1,"size":1,"total":10}},"data":[{"name":"IDM - Developers","login_path":"/v2/authenticate/federated?org_id=7f9fd312-a987-4628-b4c5-bb4f4fddd5f7"}]}}}}}},"UserSingle":{"description":"A get action response of a single user.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"},"examples":{"Example":{"$ref":"#/components/examples/Get-User-Response"}}}}},"ParameterizedAssignedRoleSingle":{"description":"A get response of a single parameterized assigned role.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ParameterizedAssignedRole"},"examples":{"Assigned Role Example":{"$ref":"#/components/examples/Parameterized-Assigned-Role-Example"}}}}},"ParameterizedAssignedRolesCollection":{"description":"A paginated list response for a collection of parameterized assigned roles.","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/PaginatedMeta"},"data":{"description":"An Array","type":"array","items":{"$ref":"#/components/schemas/ParameterizedAssignedRole"}}},"title":"Parameterized Assigned Roles Collection Response"},"examples":{"ParameterizedAssignedRolesCollection":{"$ref":"#/components/examples/Parameterized-Assigned-Roles-Collection-Example"}}}}},"DeviceAuthorizationGrantAuthorizeBadRequest":{"description":"Bad Request","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/BaseDeviceAuthorizationGrantBadRequest"},{"$ref":"#/components/schemas/DeviceAuthorizationGrantAuthorizeError"}]}}}},"DeviceAuthorizationGrantTokenBadRequest":{"description":"Bad Request","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/BaseDeviceAuthorizationGrantBadRequest"},{"oneOf":[{"$ref":"#/components/schemas/DeviceAuthorizationGrantAuthorizeError"},{"$ref":"#/components/schemas/DeviceAuthorizationGrantTokenError"}]}]}}}},"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"}]}}}}}},"IdentityConflict":{"description":"Conflict","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ConflictError"},"examples":{"User is Already Active":{"$ref":"#/components/examples/409-user-is-already-active"}}}}},"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"}}}}},"Unauthorized":{"description":"Unauthorized","content":{"application/problem+json":{"schema":{"description":"The error response object.","type":"object","properties":{"status":{"description":"The HTTP status code.","type":"integer","example":403},"title":{"description":"The Error Response.","type":"string","example":"Unauthorized"},"instance":{"description":"The Konnect traceback code.","type":"string","example":"konnect:trace:952172606039454040"},"detail":{"description":"Details about the error response.","type":"string","example":"You do not have permission to perform this action"}},"title":"Unauthorized Response"},"examples":{"Unauthorized":{"$ref":"#/components/examples/403-permission-denied"}}}}},"IdentityNotFound":{"description":"Not Found","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/NotFoundError"},"examples":{"Not Found":{"$ref":"#/components/examples/404-not-found"}}}}},"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"}},"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}}}}}},"UserPermissions":{"description":"User Permissions","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"resource":{"type":"string"},"actions":{"type":"array","items":{"type":"string"}}}}}},"example":{"data":[{"resource":"krn:accounts:reg/*:org/aa878768-05cb-4811-90d2-b82ef61caf44","actions":["#root"]}]},"title":"User Permissions Response"},"examples":{"OrganizationAdminExample":{"value":{"data":[{"resource":"krn:accounts:reg/*:org/aa878768-05cb-4811-90d2-b82ef61caf44","actions":["#root"]}]}}}}}},"LogoutResponse":{"description":"Logout response","content":{"application/json":{"schema":{"type":"object","properties":{"login_path":{"description":"The login path.","type":"string"}},"required":["login_path"],"title":"Logout Response"}}}},"ResolveCustomerResponse":{"description":"AWS Resolve customer response","content":{"application/json":{"schema":{"type":"object","properties":{"organization_id":{"description":"UUID of the organization.","type":"string","format":"uuid"}},"required":["organization_id"],"title":"Resolve Customer Response"}}}},"DeviceAuthorizationResponse":{"description":"Device authorization response","content":{"application/json":{"schema":{"type":"object","properties":{"device_code":{"description":"The device verification code.","type":"string"},"user_code":{"description":"The end-user verification code.","type":"string"},"verification_uri":{"description":"The end-user verification URI on the authorization server.","type":"string"},"verification_uri_complete":{"description":"A verification URI that includes the \"user_code\".","type":"string"},"expires_in":{"description":"The lifetime in seconds of the \"device_code\" and \"user_code\".","type":"integer"},"interval":{"description":"The minimum amount of time in seconds that the client should wait between polling requests to the token endpoint.","type":"integer"}},"example":{"device_code":"GmRhmhcxhwAzkoEqiMEg_DnyEysNkuNhszIySk9eS","user_code":"WDJB-MJHT","verification_uri":"https://example.com/device","verification_uri_complete":"https://example.com/device?user_code=WDJB-MJHT","expires_in":1800,"interval":5},"required":["device_code","user_code","verification_uri","expires_in"],"title":"Device Authorization Response"}}}},"DeviceAccessTokenResponse":{"description":"Device access token response","content":{"application/json":{"schema":{"type":"object","properties":{"access_token":{"description":"The access token issued by the authorization server.","type":"string"},"token_type":{"description":"The type of the token issued.","type":"string"},"expires_in":{"description":"The lifetime in seconds of the access token.","type":"integer"},"refresh_token":{"description":"The refresh token, which can be used to obtain new access tokens using the same authorization grant.","type":"string"},"scope":{"description":"The scope of the access token.","type":"string"}},"example":{"access_token":"2YotnFZFEjr1zCsicMWpAA","token_type":"Bearer","expires_in":3600,"refresh_token":"tGzv3JOkF0XG5Qx2TlKWIA","scope":"read write"},"required":["access_token","token_type","expires_in"],"title":"Device Access Token Response"}}}},"DeviceAuthorizationUserResponse":{"description":"User device authorization response","content":{"application/json":{"schema":{"type":"object","properties":{"organization_name":{"description":"The name of the organization.","type":"string"},"user":{"$ref":"#/components/schemas/User"},"metadata":{"description":"The device metadata to be displayed to the user for confirmation.","type":"object","example":{"client_name":"Konnect CLI","user_agent":"kconnectctl/0.12","source_ip":"192.158.1.38","requested_at":"2022-02-07T17:46:57.52Z"},"properties":{"client_name":{"description":"The requesting application human name.","type":"string"},"user_agent":{"description":"The device's user agent used to perform the device authorization grant request.","type":"string"},"source_ip":{"description":"The IP address of the device used to perform the device authorization grant request.","type":"string"},"requested_at":{"description":"The time stamp for the date the device authorization request was made.","type":"string","format":"date-time","example":"2022-02-07T17:46:57.52Z"}},"required":["client_name","user_agent","source_ip","requested_at"]}},"required":["organization_name","user","metadata"],"title":"User Device Authorization Response"}}}}},"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":"Users"},{"name":"Me"},{"name":"Managed System Accounts - Roles"},{"name":"Authentication"},{"name":"AWS"},{"name":"Device Authorization Grant"},{"name":"SSO Auth0"}],"security":[{"personalAccessToken":[]},{"systemAccountAccessToken":[]},{"konnectAccessToken":[]},{"clientToken":[]},{"serviceAccessToken":[]}]}
```
