---
title: "Konnect Identity Management"
url: "https://nov18-dev.movespot.fyi/apis/konnect-identity-management-internal-2/versions/770972f0-aec8-404b-85ec-1d58e7079be2"
---

# Konnect Identity Management

OpenAPI specification document.

```json
{"openapi":"3.0.2","info":{"title":"Konnect Identity Management","version":"2.0.0","description":"The management API for Kong Konnect Identity resources.","contact":{"name":"Kong","url":"https://konghq.com"}},"servers":[{"url":"https://global.api.konghq.com/v2","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/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":"Fetch assigned roles for 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":{"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 System Account (Internal)","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":{"get":{"operationId":"get-users-me","summary":"Get My User Account","description":"Returns the user account for the user identified in the token of the request.","responses":{"200":{"$ref":"#/components/responses/UserSingle"},"401":{"$ref":"#/components/responses/IdentityUnauthenticated"}},"security":[{"personalAccessToken":[]},{"konnectAccessToken":[]}],"tags":["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/password":{"patch":{"operationId":"patch-users-me-password","summary":"Update My User Account Password","description":"Update the password of the user identified in the token of the request.","requestBody":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"old_password":{"description":"Old password.","type":"string"},"new_password":{"description":"New Password.","type":"string"}},"required":["old_password","new_password"]}}}},"responses":{"202":{"description":"Accepted"},"400":{"$ref":"#/components/responses/IdentityBadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"description":"Forbidden - If basic auth is disabled or 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":{"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":"Updates the current user's organization","description":"This operation allows you to change the organization's owner. The new user must be part of the organization's admin team.\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"]}}},"components":{"schemas":{"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":"Runtime Groups"},"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":"Connector","entity_id":"18ee2573-dec0-4b83-be99-fa7700bcdc61","entity_type_name":"Mesh Control Planes","entity_region":"us","parameters":{"zoneName":"zone3"}},"title":"ParameterizedAssignedRole"},"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"}}}]},"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"}}}]},"StringFieldEqualsFilter":{"description":"Filters on the given string field value by exact match.","oneOf":[{"type":"string"},{"type":"object","title":"StringFieldEqualsComparison","additionalProperties":false,"properties":{"eq":{"type":"string"}},"required":["eq"]}],"title":"StringFieldEqualsFilter","x-examples":{"example-1":"equals-some-value","example-2":{"eq":"some-value"}}},"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","instance":"konnect:trace:6644808935508571943","detail":"","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"}}},"requestBodies":{"Auth0Registration":{"content":{"application/json":{"schema":{"description":"Auth0 organization registration","type":"object","properties":{"organization_name":{"type":"string"},"default_region":{"type":"string"}},"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's admin team.","type":"string","example":"YOUR_OWNER_ID"},"name":{"description":"The new name of the organization.","type":"string","example":"Kong Inc"}}},"examples":{"Example Request Body":{"$ref":"#/components/examples/Update-Organization"}}}}}},"responses":{"Auth0Registration":{"description":"Auth0 organization registration","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Auth0Registration"}}}},"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"}}}},"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"}}}},"examples":{"ParameterizedAssignedRolesCollection":{"$ref":"#/components/examples/Parameterized-Assigned-Roles-Collection-Example"}}}}},"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"}}},"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":"Example response","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}},"examples":{"Example":{"value":{"created_at":"2023-01-18T11:35:45.130Z","id":"023bfa42-3513-4cbf-b059-a9ddb4ea995d","name":"Acme Co.","owner_id":"e02c829c-0e2d-44b5-9057-07714ea613a3","login_path":"acme","updated_at":"2023-01-23T17:22:52.150Z","state":"active","retention_period_days":90}}}}}},"UserPermissions":{"description":"Example response","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"]}]}},"examples":{"OrganizationAdminExample":{"value":{"data":[{"resource":"krn:accounts:reg/*:org/aa878768-05cb-4811-90d2-b82ef61caf44","actions":["#root"]}]}}}}}}},"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"}}},"tags":[{"name":"Me"},{"name":"Managed System Accounts - Roles"}],"security":[{"personalAccessToken":[]},{"systemAccountAccessToken":[]},{"konnectAccessToken":[]},{"clientToken":[]}]}
```
