openapi: 3.0.0 info: version: '1' title: Kinde Management API description: Provides endpoints to manage your Kinde Businesses termsOfService: https://docs.kinde.com/trust-center/agreements/terms-of-service/ contact: name: Kinde Support Team email: support@kinde.com url: https://docs.kinde.com servers: - url: https://{your_subdomain}.kinde.com variables: your_subdomain: default: app description: The subdomain generated for your business on Kinde. basePath: default: v1 description: The version of the API. tags: - name: OAuth x-displayName: OAuth - name: APIs x-displayName: APIs - name: Applications x-displayName: Applications - name: Business x-displayName: Business - name: Industries x-displayName: Industries - name: Timezones x-displayName: Timezones - name: Callbacks x-displayName: Callbacks - name: Connected Apps x-displayName: Connected Apps - name: Connections x-displayName: Connections - name: Environments x-displayName: Environments - name: Environment variables x-displayName: Environment variables - name: Feature Flags x-displayName: Feature Flags - name: Identities x-displayName: Identities - name: Organizations x-displayName: Organizations - name: Permissions x-displayName: Permissions - name: Properties x-displayName: Properties - name: Property Categories x-displayName: Property Categories - name: Roles x-displayName: Roles - name: Subscribers x-displayName: Subscribers - name: Users x-displayName: Users - name: Webhooks x-displayName: Webhooks paths: /oauth2/user_profile: get: tags: - OAuth operationId: getUser description: | Contains the id, names and email of the currently logged in user. summary: Get User Profile responses: '200': description: Details of logged in user V1. content: application/json: schema: $ref: '#/components/schemas/user_profile' '403': description: Invalid credentials. security: - kindeBearerAuth: [] /oauth2/introspect: post: tags: - OAuth operationId: tokenIntrospection description: Retrieve information about the provided token. summary: Get token details requestBody: description: Token details. required: true content: application/x-www-form-urlencoded: schema: type: object properties: token: description: The token to be introspected. type: string token_type: type: string description: The provided token's type. responses: '200': description: Details of the token. content: application/json: schema: $ref: '#/components/schemas/token_introspect' application/json; charset=utf-8: schema: $ref: '#/components/schemas/token_introspect' '401': description: Bad request. content: application/json: schema: $ref: '#/components/schemas/token_error_response' application/json; charset=utf-8: schema: $ref: '#/components/schemas/token_error_response' '403': description: Invalid credentials. '429': description: Request was throttled. security: - kindeBearerAuth: [] /oauth2/revoke: post: tags: - OAuth operationId: tokenRevocation description: Revoke a previously issued token. summary: Revoke token requestBody: description: Details of the token to be revoked. required: true content: application/x-www-form-urlencoded: schema: type: object properties: token: description: The token to be revoked. type: string client_id: type: string description: The identifier for your client. client_secret: type: string description: The secret associated with your client. responses: '200': description: Token successfully revoked. '401': description: Bad request. content: application/json: schema: $ref: '#/components/schemas/token_error_response' application/json; charset=utf-8: schema: $ref: '#/components/schemas/token_error_response' '403': description: Invalid credentials. '429': description: Request was throttled. security: - kindeBearerAuth: [] /oauth2/v2/user_profile: get: tags: - OAuth operationId: getUserProfileV2 description: > Contains the ID, names, profile picture URL and email of the currently logged in user. summary: Returns the details of the currently logged in user responses: '200': description: Details of logged in user V2. content: application/json: schema: $ref: '#/components/schemas/user_profile_v2' '403': description: Invalid credentials. '429': description: Request was throttled. security: - kindeBearerAuth: [] /api/v1/apis: get: tags: - APIs operationId: getAPIs summary: Get APIs description: Returns a list of your APIs. The APIs are returned sorted by name. security: - ManagementAPI: - read:apis responses: '200': description: A list of APIs. content: application/json: schema: $ref: '#/components/schemas/get_apis_response' '400': $ref: '#/components/responses/bad_request' '403': $ref: '#/components/responses/forbidden' '429': $ref: '#/components/responses/too_many_requests' post: tags: - APIs operationId: addAPIs summary: Create API description: >- Register a new API. For more information read [Register and manage APIs](https://docs.kinde.com/developer-tools/your-apis/register-manage-apis/). externalDocs: url: https://docs.kinde.com/developer-tools/your-apis/register-manage-apis description: Register and manage APIs security: - ManagementAPI: - create:apis requestBody: required: true content: application/json: schema: type: object properties: name: type: string description: The name of the API. (1-64 characters). example: Example API audience: type: string description: >- A unique identifier for the API - commonly the URL. This value will be used as the `audience` parameter in authorization claims. (1-64 characters) example: https://api.example.com required: - name - audience responses: '200': description: APIs successfully updated content: application/json: schema: $ref: '#/components/schemas/create_apis_response' '400': $ref: '#/components/responses/bad_request' '403': $ref: '#/components/responses/forbidden' '429': $ref: '#/components/responses/too_many_requests' /api/v1/apis/{api_id}: parameters: - $ref: '#/components/parameters/api_id' get: tags: - APIs operationId: getAPI summary: Get API description: Retrieve API details by ID. security: - ManagementAPI: - read:apis responses: '200': description: API successfully retrieved. content: application/json: schema: $ref: '#/components/schemas/get_api_response' '400': $ref: '#/components/responses/bad_request' '403': $ref: '#/components/responses/forbidden' '429': $ref: '#/components/responses/too_many_requests' delete: tags: - APIs operationId: deleteAPI summary: Delete API description: Delete an API you previously created. security: - ManagementAPI: - delete:apis responses: '200': description: API successfully deleted. content: application/json: schema: $ref: '#/components/schemas/delete_api_response' '400': $ref: '#/components/responses/bad_request' '403': $ref: '#/components/responses/forbidden' '429': $ref: '#/components/responses/too_many_requests' /api/v1/apis/{api_id}/applications: parameters: - $ref: '#/components/parameters/api_id' patch: tags: - APIs operationId: updateAPIApplications summary: Authorize API applications description: Authorize applications to be allowed to request access tokens for an API security: - ManagementAPI: - update:apis requestBody: description: The applications you want to authorize. required: true content: application/json: schema: type: object required: - applications properties: applications: type: array items: type: object required: - id properties: id: description: The application's Client ID. type: string example: d2db282d6214242b3b145c123f0c123 operation: description: >- Optional operation, set to 'delete' to revoke authorization for the application. If not set, the application will be authorized. type: string example: delete responses: '200': description: Authorized applications updated. content: application/json: schema: $ref: '#/components/schemas/authorize_app_api_response' '400': $ref: '#/components/responses/bad_request' '403': $ref: '#/components/responses/forbidden' '429': $ref: '#/components/responses/too_many_requests' /api/v1/applications: get: tags: - Applications operationId: getApplications summary: Get applications description: Get a list of applications / clients. security: - ManagementAPI: - read:applications parameters: - name: sort in: query description: Field and order to sort the result by. schema: type: string nullable: true enum: - name_asc - name_desc - name: page_size in: query description: Number of results per page. Defaults to 10 if parameter not sent. schema: type: integer nullable: true - name: next_token in: query description: A string to get the next page of results if there are more results. schema: type: string nullable: true responses: '200': description: A successful response with a list of applications or an empty list. content: application/json: schema: $ref: '#/components/schemas/get_applications_response' '400': $ref: '#/components/responses/bad_request' '403': $ref: '#/components/responses/forbidden' '429': $ref: '#/components/responses/too_many_requests' post: tags: - Applications operationId: createApplication summary: Create application description: Create a new client. security: - ManagementAPI: - create:applications requestBody: required: true content: application/json: schema: type: object properties: name: description: The application's name. type: string example: React Native app type: description: >- The application's type. Use `reg` for regular server rendered applications, `spa` for single-page applications, and `m2m` for machine-to-machine applications. type: string enum: - reg - spa - m2m required: - name - type responses: '201': description: Application successfully created. content: application/json: schema: $ref: '#/components/schemas/create_application_response' '400': $ref: '#/components/responses/bad_request' '403': $ref: '#/components/responses/forbidden' '429': $ref: '#/components/responses/too_many_requests' /api/v1/applications/{application_id}: get: tags: - Applications operationId: getApplication summary: Get application description: Gets an application given the application's ID. security: - ManagementAPI: - read:applications parameters: - name: application_id in: path description: The identifier for the application. required: true schema: type: string nullable: false responses: '200': description: Application successfully retrieved. content: application/json: schema: $ref: '#/components/schemas/get_application_response' '400': $ref: '#/components/responses/bad_request' '403': $ref: '#/components/responses/forbidden' '429': $ref: '#/components/responses/too_many_requests' patch: tags: - Applications operationId: updateApplication summary: Update Application description: >- Updates a client's settings. For more information, read [Applications in Kinde](https://docs.kinde.com/build/applications/about-applications) security: - ManagementAPI: - update:applications parameters: - name: application_id in: path description: The identifier for the application. required: true schema: type: string requestBody: description: Application details. required: false content: application/json: schema: type: object properties: name: description: The application's name. type: string language_key: description: The application's language key. type: string logout_uris: description: The application's logout uris. type: array items: type: string redirect_uris: description: The application's redirect uris. type: array items: type: string login_uri: description: The default login route for resolving session issues. type: string homepage_uri: description: The homepage link to your application. type: string responses: '200': description: Application successfully updated. '400': $ref: '#/components/responses/bad_request' '403': $ref: '#/components/responses/forbidden' '429': $ref: '#/components/responses/too_many_requests' delete: tags: - Applications operationId: deleteApplication summary: Delete application description: Delete a client / application. security: - ManagementAPI: - delete:applications parameters: - name: application_id in: path description: The identifier for the application. required: true schema: type: string responses: '200': description: Application successfully deleted. content: application/json: schema: $ref: '#/components/schemas/success_response' '400': $ref: '#/components/responses/bad_request' '403': $ref: '#/components/responses/forbidden' '429': $ref: '#/components/responses/too_many_requests' /api/v1/applications/{application_id}/connections: get: tags: - Applications operationId: GetApplicationConnections description: Gets all connections for an application. summary: Get connections security: - ManagementAPI: - read:application_connections parameters: - name: application_id in: path description: The identifier/client ID for the application. required: true schema: type: string nullable: false responses: '200': description: Application connections successfully retrieved. content: application/json: schema: $ref: '#/components/schemas/get_connections_response' '400': $ref: '#/components/responses/bad_request' '403': $ref: '#/components/responses/forbidden' '429': $ref: '#/components/responses/too_many_requests' /api/v1/applications/{application_id}/connections/{connection_id}: post: tags: - Applications operationId: EnableConnection summary: Enable connection description: Enable an auth connection for an application. security: - ManagementAPI: - create:application_connections parameters: - name: application_id in: path description: The identifier/client ID for the application. required: true schema: type: string - name: connection_id in: path description: The identifier for the connection. required: true schema: type: string responses: '200': description: Connection successfully enabled. '400': $ref: '#/components/responses/bad_request' '403': $ref: '#/components/responses/forbidden' '429': $ref: '#/components/responses/too_many_requests' delete: tags: - Applications operationId: RemoveConnection summary: Remove connection description: Turn off an auth connection for an application security: - ManagementAPI: - delete:application_connections parameters: - name: application_id in: path description: The identifier/client ID for the application. required: true schema: type: string - name: connection_id in: path description: The identifier for the connection. required: true schema: type: string responses: '200': description: Connection successfully removed. content: application/json: schema: $ref: '#/components/schemas/success_response' '400': $ref: '#/components/responses/bad_request' '403': $ref: '#/components/responses/forbidden' '429': $ref: '#/components/responses/too_many_requests' /api/v1/applications/{application_id}/properties: parameters: - $ref: '#/components/parameters/application_id' get: tags: - Applications operationId: getApplicationPropertyValues summary: Get property values description: Gets properties for an application by client ID. security: - ManagementAPI: - read:application_properties responses: '200': description: Properties successfully retrieved. content: application/json: schema: $ref: '#/components/schemas/get_property_values_response' '400': $ref: '#/components/responses/bad_request' '403': $ref: '#/components/responses/forbidden' '429': $ref: '#/components/responses/too_many_requests' /api/v1/applications/{application_id}/properties/{property_key}: parameters: - $ref: '#/components/parameters/application_id' - $ref: '#/components/parameters/property_key' put: tags: - Applications operationId: updateApplicationsProperty summary: Update property description: Update application property value. security: - ManagementAPI: - update:application_properties requestBody: required: true content: application/json: schema: type: object properties: value: oneOf: - type: string - type: boolean description: The new value for the propery example: Some new value required: - value responses: '200': description: Property successfully updated content: application/json: schema: $ref: '#/components/schemas/success_response' '400': $ref: '#/components/responses/bad_request' '403': $ref: '#/components/responses/forbidden' '429': $ref: '#/components/responses/too_many_requests' /api/v1/business: get: tags: - Business operationId: getBusiness summary: Get business description: Get your business details. security: - ManagementAPI: - read:business responses: '200': description: Your business details. content: application/json: schema: $ref: '#/components/schemas/get_business_response' '400': $ref: '#/components/responses/bad_request' '403': $ref: '#/components/responses/forbidden' '429': $ref: '#/components/responses/too_many_requests' patch: tags: - Business operationId: updateBusiness summary: Update business description: Update your business details. security: - ManagementAPI: - update:businesses requestBody: description: The business details to update. required: true content: application/json: schema: type: object properties: business_name: type: string description: The name of the business. example: Tailsforce Ltd nullable: true email: type: string description: The email address of the business. example: sally@example.com nullable: true industry_key: type: string description: >- The key of the industry of your business. Can be retrieved from the /industries endpoint. example: construction nullable: true is_click_wrap: description: Whether the business is using clickwrap agreements. type: boolean example: false nullable: true is_show_kinde_branding: description: >- Whether the business is showing Kinde branding. Requires a paid plan. type: boolean example: true nullable: true kinde_perk_code: description: The Kinde perk code for the business. type: string nullable: true phone: description: The phone number of the business. type: string example: 123-456-7890 nullable: true privacy_url: description: The URL to the business's privacy policy. type: string example: https://example.com/privacy nullable: true terms_url: description: The URL to the business's terms of service. type: string example: https://example.com/terms nullable: true timezone_key: description: >- The key of the timezone of your business. Can be retrieved from the /timezones endpoint. type: string example: los_angeles_pacific_standard_time nullable: true responses: '200': description: Business successfully updated. content: application/json: schema: $ref: '#/components/schemas/success_response' '400': $ref: '#/components/responses/bad_request' '403': $ref: '#/components/responses/forbidden' '429': $ref: '#/components/responses/too_many_requests' /api/v1/industries: get: tags: - Industries operationId: getIndustries summary: Get industries description: Get a list of industries and associated industry keys. security: - ManagementAPI: - read:industries responses: '200': description: A list of industries. content: application/json: schema: $ref: '#/components/schemas/get_industries_response' '400': $ref: '#/components/responses/bad_request' '403': $ref: '#/components/responses/forbidden' '429': $ref: '#/components/responses/too_many_requests' /api/v1/timezones: get: tags: - Timezones operationId: getTimezones summary: Get timezones description: Get a list of timezones and associated timezone keys. security: - ManagementAPI: - read:timezones responses: '200': description: A list of timezones. content: application/json: schema: $ref: '#/components/schemas/get_timezones_response' '400': $ref: '#/components/responses/bad_request' '403': $ref: '#/components/responses/forbidden' '429': $ref: '#/components/responses/too_many_requests' /api/v1/applications/{app_id}/auth_redirect_urls: get: tags: - Callbacks operationId: getCallbackURLs description: | Returns an application's redirect callback URLs. summary: List Callback URLs security: - ManagementAPI: - read:applications_redirect_uris parameters: - name: app_id in: path description: The identifier for the application. required: true schema: type: string responses: '200': description: Callback URLs successfully retrieved. content: application/json: schema: $ref: '#/components/schemas/redirect_callback_urls' application/json; charset=utf-8: schema: $ref: '#/components/schemas/redirect_callback_urls' '400': description: Invalid request. content: application/json: schema: $ref: '#/components/schemas/error_response' application/json; charset=utf-8: schema: $ref: '#/components/schemas/error_response' '403': description: Invalid credentials. '429': description: Request was throttled. post: tags: - Callbacks operationId: addRedirectCallbackURLs description: | Add additional redirect callback URLs. summary: Add Redirect Callback URLs security: - ManagementAPI: - create:application_redirect_uris parameters: - name: app_id in: path description: The identifier for the application. required: true schema: type: string requestBody: description: Callback details. required: true content: application/json: schema: type: object properties: urls: type: array items: type: string description: Array of callback urls. responses: '200': description: Callbacks successfully updated content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/success_response' '400': description: Invalid request. content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/error_response' '403': description: Invalid credentials. content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/error_response' '429': description: Request was throttled. put: tags: - Callbacks operationId: replaceRedirectCallbackURLs description: | Replace all redirect callback URLs. summary: Replace Redirect Callback URLs security: - ManagementAPI: - update:application_redirect_uris parameters: - name: app_id in: path description: The identifier for the application. required: true schema: type: string requestBody: description: Callback details. required: true content: application/json: schema: type: object properties: urls: type: array items: type: string description: Array of callback urls. responses: '200': description: Callbacks successfully updated content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/success_response' '400': description: Invalid request. content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/error_response' '403': description: Invalid credentials. '429': description: Request was throttled. delete: tags: - Callbacks operationId: deleteCallbackURLs description: | Delete callback URLs. summary: Delete Callback URLs security: - ManagementAPI: - delete:application_redirect_uris parameters: - name: app_id in: path description: The identifier for the application. required: true schema: type: string - name: urls in: query description: Urls to delete, comma separated and url encoded. required: true schema: type: string responses: '200': description: Callback URLs successfully deleted. content: application/json: schema: $ref: '#/components/schemas/success_response' application/json; charset=utf-8: schema: $ref: '#/components/schemas/success_response' '400': description: Invalid request. content: application/json: schema: $ref: '#/components/schemas/error_response' application/json; charset=utf-8: schema: $ref: '#/components/schemas/error_response' '403': description: Invalid credentials. content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/error_response' '429': description: Request was throttled. /api/v1/applications/{app_id}/auth_logout_urls: get: tags: - Callbacks operationId: getLogoutURLs description: Returns an application's logout redirect URLs. summary: List logout URLs security: - ManagementAPI: - read:application_logout_uris parameters: - name: app_id in: path description: The identifier for the application. required: true schema: type: string responses: '200': description: Logout URLs successfully retrieved. content: application/json: schema: $ref: '#/components/schemas/logout_redirect_urls' '400': $ref: '#/components/responses/bad_request' '403': $ref: '#/components/responses/forbidden' '429': $ref: '#/components/responses/too_many_requests' post: tags: - Callbacks operationId: addLogoutRedirectURLs description: Add additional logout redirect URLs. summary: Add logout redirect URLs security: - ManagementAPI: - create:application_logout_uris parameters: - name: app_id in: path description: The identifier for the application. required: true schema: type: string requestBody: description: Callback details. required: true content: application/json: schema: type: object properties: urls: type: array items: type: string description: Array of logout urls. responses: '200': description: Logout URLs successfully updated. content: application/json: schema: $ref: '#/components/schemas/success_response' '400': $ref: '#/components/responses/bad_request' '403': $ref: '#/components/responses/forbidden' '429': $ref: '#/components/responses/too_many_requests' put: tags: - Callbacks operationId: replaceLogoutRedirectURLs description: Replace all logout redirect URLs. summary: Replace logout redirect URls security: - ManagementAPI: - update:application_logout_uris parameters: - name: app_id in: path description: The identifier for the application. required: true schema: type: string requestBody: description: Callback details. required: true content: application/json: schema: type: object properties: urls: type: array items: type: string description: Array of logout urls. responses: '200': description: Logout URLs successfully updated. content: application/json: schema: $ref: '#/components/schemas/success_response' '400': $ref: '#/components/responses/bad_request' '403': $ref: '#/components/responses/forbidden' '429': $ref: '#/components/responses/too_many_requests' delete: tags: - Callbacks operationId: deleteLogoutURLs description: | Delete logout URLs. summary: Delete Logout URLs security: - ManagementAPI: - delete:application_logout_uris parameters: - name: app_id in: path description: The identifier for the application. required: true schema: type: string - name: urls in: query description: Urls to delete, comma separated and url encoded. required: true schema: type: string responses: '200': description: Logout URLs successfully deleted. content: application/json: schema: $ref: '#/components/schemas/success_response' '400': $ref: '#/components/responses/bad_request' '403': $ref: '#/components/responses/forbidden' '429': $ref: '#/components/responses/too_many_requests' /api/v1/connected_apps/auth_url: get: tags: - Connected Apps operationId: GetConnectedAppAuthUrl description: >- Get a URL that authenticates and authorizes a user to a third-party connected app. summary: Get Connected App URL security: - ManagementAPI: - read:connected_apps parameters: - name: key_code_ref in: query description: >- The unique key code reference of the connected app to authenticate against. schema: type: string nullable: false required: true - name: user_id in: query description: >- The id of the user that needs to authenticate to the third-party connected app. schema: type: string nullable: false required: false - name: org_code in: query description: >- The code of the Kinde organization that needs to authenticate to the third-party connected app. schema: type: string nullable: false required: false - name: override_callback_url in: query description: >- A URL that overrides the default callback URL setup in your connected app configuration schema: type: string nullable: false required: false responses: '200': description: >- A URL that can be used to authenticate and a session id to identify this authentication session. content: application/json: schema: $ref: '#/components/schemas/connected_apps_auth_url' application/json; charset=utf-8: schema: $ref: '#/components/schemas/connected_apps_auth_url' '400': description: Error retrieving connected app auth url. content: application/json: schema: $ref: '#/components/schemas/error_response' application/json; charset=utf-8: schema: $ref: '#/components/schemas/error_response' '403': description: Invalid credentials. '404': description: Error retrieving connected app auth url. content: application/json: schema: $ref: '#/components/schemas/error_response' application/json; charset=utf-8: schema: $ref: '#/components/schemas/error_response' '429': description: Request was throttled. /api/v1/connected_apps/token: get: tags: - Connected Apps operationId: GetConnectedAppToken description: >- Get an access token that can be used to call the third-party provider linked to the connected app. summary: Get Connected App Token security: - ManagementAPI: - read:connected_apps parameters: - name: session_id in: query description: The unique sesssion id representing the login session of a user. schema: type: string nullable: false required: true responses: '200': description: >- An access token that can be used to query a third-party provider, as well as the token's expiry time. content: application/json: schema: $ref: '#/components/schemas/connected_apps_access_token' application/json; charset=utf-8: schema: $ref: '#/components/schemas/connected_apps_access_token' '400': description: The session id provided points to an invalid session. content: application/json: schema: $ref: '#/components/schemas/error_response' application/json; charset=utf-8: schema: $ref: '#/components/schemas/error_response' '403': description: Invalid credentials. content: application/json: schema: $ref: '#/components/schemas/error_response' application/json; charset=utf-8: schema: $ref: '#/components/schemas/error_response' '429': description: Request was throttled. /api/v1/connected_apps/revoke: post: tags: - Connected Apps operationId: RevokeConnectedAppToken description: Revoke the tokens linked to the connected app session. summary: Revoke Connected App Token security: - ManagementAPI: - create:connected_apps parameters: - name: session_id in: query description: The unique sesssion id representing the login session of a user. schema: type: string nullable: false required: true responses: '200': description: >- An access token that can be used to query a third-party provider, as well as the token's expiry time. content: application/json: schema: $ref: '#/components/schemas/success_response' application/json; charset=utf-8: schema: $ref: '#/components/schemas/success_response' '400': description: Bad request. content: application/json: schema: $ref: '#/components/schemas/error_response' application/json; charset=utf-8: schema: $ref: '#/components/schemas/error_response' '403': description: Invalid credentials. content: application/json: schema: $ref: '#/components/schemas/error_response' application/json; charset=utf-8: schema: $ref: '#/components/schemas/error_response' '405': description: Invalid HTTP method used. '429': description: Request was throttled. /api/v1/connections: get: tags: - Connections operationId: GetConnections description: | Returns a list of Connections summary: List Connections security: - ManagementAPI: - read:connections parameters: - name: page_size in: query description: Number of results per page. Defaults to 10 if parameter not sent. schema: type: integer nullable: true - name: starting_after in: query description: The ID of the connection to start after. schema: type: string nullable: true - name: ending_before in: query description: The ID of the connection to end before. schema: type: string nullable: true responses: '200': description: Connections successfully retrieved. content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/get_connections_response' application/json: schema: $ref: '#/components/schemas/get_connections_response' '400': description: Invalid request. content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/error_response' application/json: schema: $ref: '#/components/schemas/error_response' '403': description: Invalid credentials. content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/error_response' application/json: schema: $ref: '#/components/schemas/error_response' '429': description: Request was throttled. post: tags: - Connections operationId: CreateConnection description: Create Connection. summary: Create Connection security: - ManagementAPI: - create:connections requestBody: description: Connection details. required: true content: application/json: schema: type: object properties: name: description: The internal name of the connection. type: string nullable: false display_name: description: The public facing name of the connection. type: string nullable: false strategy: description: The identity provider identifier for the connection. type: string enum: - oauth2:apple - oauth2:azure_ad - oauth2:bitbucket - oauth2:discord - oauth2:facebook - oauth2:github - oauth2:gitlab - oauth2:google - oauth2:linkedin - oauth2:microsoft - oauth2:patreon - oauth2:slack - oauth2:stripe - oauth2:twitch - oauth2:twitter - oauth2:xero - saml:custom - wsfed:azure_ad nullable: false enabled_applications: description: >- Client IDs of applications in which this connection is to be enabled. type: array items: type: string options: description: The connection's options (varies by strategy). type: object required: - name - display_name - strategy responses: '201': description: Connection successfully created content: application/json: schema: $ref: '#/components/schemas/create_connection_response' application/json; charset=utf-8: schema: $ref: '#/components/schemas/create_connection_response' '400': description: Invalid request. content: application/json: schema: $ref: '#/components/schemas/error_response' application/json; charset=utf-8: schema: $ref: '#/components/schemas/error_response' '403': description: Invalid credentials. '429': description: Request was throttled. /api/v1/connections/{connection_id}: get: tags: - Connections operationId: GetConnection description: Get Connection. summary: Get Connection security: - ManagementAPI: - read:connections parameters: - name: connection_id in: path description: The unique identifier for the connection. required: true schema: type: string responses: '200': description: Connection successfully retrieved. content: application/json: schema: $ref: '#/components/schemas/connection' application/json; charset=utf-8: schema: $ref: '#/components/schemas/connection' '400': description: Invalid request. content: application/json: schema: $ref: '#/components/schemas/error_response' application/json; charset=utf-8: schema: $ref: '#/components/schemas/error_response' '403': description: Invalid credentials. '429': description: Request was throttled. patch: tags: - Connections operationId: UpdateConnection description: Update Connection. summary: Update Connection security: - ManagementAPI: - update:connections parameters: - name: connection_id in: path description: The unique identifier for the connection. required: true schema: type: string requestBody: description: The fields of the connection to update. required: true content: application/json: schema: type: object properties: name: description: The internal name of the connection. type: string nullable: false display_name: description: The public facing name of the connection. type: string nullable: false enabled_applications: description: >- Client IDs of applications in which this connection is to be enabled. type: array items: type: string options: description: The connection's options (varies by strategy). type: object responses: '200': description: Connection successfully updated. content: application/json: schema: $ref: '#/components/schemas/success_response' application/json; charset=utf-8: schema: $ref: '#/components/schemas/success_response' '400': description: Invalid request. content: application/json: schema: $ref: '#/components/schemas/error_response' application/json; charset=utf-8: schema: $ref: '#/components/schemas/error_response' '403': description: Invalid credentials. '429': description: Request was throttled. delete: tags: - Connections operationId: deleteConnection description: | Delete connection. summary: Delete Connection security: - ManagementAPI: - delete:connections parameters: - name: connection_id in: path description: The identifier for the connection. required: true schema: type: string responses: '200': description: Connection deleted. content: application/json: schema: $ref: '#/components/schemas/success_response' application/json; charset=utf-8: schema: $ref: '#/components/schemas/success_response' '400': description: Invalid request. content: application/json: schema: $ref: '#/components/schemas/error_response' application/json; charset=utf-8: schema: $ref: '#/components/schemas/error_response' '403': description: Invalid credentials. content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/error_response' '429': description: Request was throttled. /api/v1/environment/feature_flags: delete: tags: - Environments operationId: DeleteEnvironementFeatureFlagOverrides description: Delete all environment feature flag overrides. summary: Delete Environment Feature Flag Overrides security: - ManagementAPI: - delete:environment_feature_flags responses: '200': description: Feature flag overrides deleted successfully. content: application/json: schema: $ref: '#/components/schemas/success_response' application/json; charset=utf-8: schema: $ref: '#/components/schemas/success_response' '400': description: Invalid request. content: application/json: schema: $ref: '#/components/schemas/error_response' application/json; charset=utf-8: schema: $ref: '#/components/schemas/error_response' '403': description: Invalid credentials. '429': description: Request was throttled. get: tags: - Environments operationId: GetEnvironementFeatureFlags description: Get environment feature flags. summary: List Environment Feature Flags security: - ManagementAPI: - read:environment_feature_flags responses: '200': description: Feature flags retrieved successfully. content: application/json: schema: $ref: '#/components/schemas/get_environment_feature_flags_response' application/json; charset=utf-8: schema: $ref: '#/components/schemas/get_environment_feature_flags_response' '400': description: Invalid request. content: application/json: schema: $ref: '#/components/schemas/error_response' application/json; charset=utf-8: schema: $ref: '#/components/schemas/error_response' '403': description: Invalid credentials. '429': description: Request was throttled. /api/v1/environment/feature_flags/{feature_flag_key}: delete: tags: - Environments operationId: DeleteEnvironementFeatureFlagOverride description: Delete environment feature flag override. summary: Delete Environment Feature Flag Override security: - ManagementAPI: - delete:environment_feature_flags parameters: - name: feature_flag_key in: path description: The identifier for the feature flag. required: true schema: type: string responses: '200': description: Feature flag deleted successfully. content: application/json: schema: $ref: '#/components/schemas/success_response' application/json; charset=utf-8: schema: $ref: '#/components/schemas/success_response' '400': description: Invalid request. content: application/json: schema: $ref: '#/components/schemas/error_response' application/json; charset=utf-8: schema: $ref: '#/components/schemas/error_response' '403': description: Invalid credentials. '429': description: Request was throttled. patch: tags: - Environments operationId: UpdateEnvironementFeatureFlagOverride description: Update environment feature flag override. summary: Update Environment Feature Flag Override security: - ManagementAPI: - update:environment_feature_flags parameters: - name: feature_flag_key in: path description: The identifier for the feature flag. required: true schema: type: string requestBody: description: Flag details. required: true content: application/json: schema: type: object properties: value: description: The flag override value. type: string nullable: false required: - value responses: '200': description: Feature flag override successful content: application/json: schema: $ref: '#/components/schemas/success_response' application/json; charset=utf-8: schema: $ref: '#/components/schemas/success_response' '400': description: Invalid request. content: application/json: schema: $ref: '#/components/schemas/error_response' application/json; charset=utf-8: schema: $ref: '#/components/schemas/error_response' '403': description: Invalid credentials. '429': description: Request was throttled. /api/v1/environment_variables: get: tags: - Environment variables operationId: getEnvironmentVariables summary: Get environment variables description: >- Get environment variables. This feature is in beta and admin UI is not yet available. security: - ManagementAPI: - read:environment_variables responses: '200': description: >- A successful response with a list of environment variables or an empty list. content: application/json: schema: $ref: '#/components/schemas/get_environment_variables_response' '400': $ref: '#/components/responses/bad_request' '403': $ref: '#/components/responses/forbidden' '429': $ref: '#/components/responses/too_many_requests' post: tags: - Environment variables operationId: createEnvironmentVariable summary: Create environment variable description: >- Create a new environment variable. This feature is in beta and admin UI is not yet available. security: - ManagementAPI: - create:environment_variables requestBody: description: The environment variable details. required: true content: application/json: schema: type: object properties: key: type: string description: The name of the environment variable (max 128 characters). example: MY_API_KEY value: type: string description: >- The value of the new environment variable (max 2048 characters). example: some-secret-value is_secret: type: boolean description: >- Whether the environment variable is sensitive. Secrets are not-readable by you or your team after creation. example: false required: - key - value responses: '201': description: Environment variable successfully created. content: application/json: schema: $ref: '#/components/schemas/create_environment_variable_response' '400': $ref: '#/components/responses/bad_request' '403': $ref: '#/components/responses/forbidden' '429': $ref: '#/components/responses/too_many_requests' /api/v1/environment_variables/{variable_id}: parameters: - $ref: '#/components/parameters/variable_id' get: tags: - Environment variables operationId: getEnvironmentVariable summary: Get environment variable description: >- Retrieve environment variable details by ID. This feature is in beta and admin UI is not yet available. security: - ManagementAPI: - read:environment_variables responses: '200': description: Environment variable successfully retrieved. content: application/json: schema: $ref: '#/components/schemas/get_environment_variable_response' '400': $ref: '#/components/responses/bad_request' '403': $ref: '#/components/responses/forbidden' '429': $ref: '#/components/responses/too_many_requests' patch: tags: - Environment variables operationId: updateEnvironmentVariable summary: Update environment variable description: >- Update an environment variable you previously created. This feature is in beta and admin UI is not yet available. security: - ManagementAPI: - update:environment_variables requestBody: description: The new details for the environment variable required: true content: application/json: schema: type: object properties: key: type: string description: The key to update. example: MY_API_KEY value: type: string description: The new value for the environment variable. example: new-secret-value is_secret: type: boolean description: >- Whether the environment variable is sensitive. Secret variables are not-readable by you or your team after creation. responses: '200': description: Environment variable successfully updated. content: application/json: schema: $ref: '#/components/schemas/update_environment_variable_response' '400': $ref: '#/components/responses/bad_request' '403': $ref: '#/components/responses/forbidden' '429': $ref: '#/components/responses/too_many_requests' delete: tags: - Environment variables operationId: deleteEnvironmentVariable summary: Delete environment variable description: >- Delete an environment variable you previously created. This feature is in beta and admin UI is not yet available. security: - ManagementAPI: - delete:environment_variables responses: '200': description: Environment variable successfully deleted. content: application/json: schema: $ref: '#/components/schemas/delete_environment_variable_response' '400': $ref: '#/components/responses/bad_request' '403': $ref: '#/components/responses/forbidden' '429': $ref: '#/components/responses/too_many_requests' /api/v1/feature_flags: post: tags: - Feature Flags operationId: CreateFeatureFlag description: Create feature flag. summary: Create Feature Flag security: - ManagementAPI: - create:feature_flags requestBody: description: Flag details. required: true content: application/json: schema: type: object properties: name: description: The name of the flag. type: string nullable: false description: description: Description of the flag purpose. type: string nullable: false key: description: The flag identifier to use in code. type: string nullable: false type: description: The variable type. type: string enum: - str - int - bool nullable: false allow_override_level: description: Allow the flag to be overridden at a different level. type: string enum: - env - org - usr nullable: false default_value: description: >- Default value for the flag used by environments and organizations. type: string nullable: false required: - name - key - type - default_value responses: '201': description: Feature flag successfully created content: application/json: schema: $ref: '#/components/schemas/success_response' application/json; charset=utf-8: schema: $ref: '#/components/schemas/success_response' '400': description: Invalid request. content: application/json: schema: $ref: '#/components/schemas/error_response' application/json; charset=utf-8: schema: $ref: '#/components/schemas/error_response' '403': description: Invalid credentials. '429': description: Request was throttled. /api/v1/feature_flags/{feature_flag_key}: delete: tags: - Feature Flags operationId: DeleteFeatureFlag description: Delete feature flag summary: Delete Feature Flag security: - ManagementAPI: - delete:feature_flags parameters: - name: feature_flag_key in: path description: The identifier for the feature flag. required: true schema: type: string responses: '200': description: Feature flag successfully updated. content: application/json: schema: $ref: '#/components/schemas/success_response' application/json; charset=utf-8: schema: $ref: '#/components/schemas/success_response' '400': description: Invalid request. content: application/json: schema: $ref: '#/components/schemas/error_response' application/json; charset=utf-8: schema: $ref: '#/components/schemas/error_response' '403': description: Invalid credentials. '429': description: Request was throttled. put: tags: - Feature Flags operationId: UpdateFeatureFlag description: Update feature flag. summary: Replace Feature Flag security: - ManagementAPI: - update:feature_flags parameters: - name: feature_flag_key in: path description: The key identifier for the feature flag. required: true schema: type: string - name: name in: query description: The name of the flag. schema: type: string nullable: false required: true - name: description in: query description: Description of the flag purpose. schema: type: string nullable: false required: true - name: type in: query description: The variable type schema: type: string enum: - str - int - bool nullable: false required: true - name: allow_override_level in: query description: Allow the flag to be overridden at a different level. schema: type: string enum: - env - org nullable: false required: true - name: default_value in: query description: Default value for the flag used by environments and organizations. schema: type: string nullable: false required: true responses: '200': description: Feature flag successfully updated. content: application/json: schema: $ref: '#/components/schemas/success_response' application/json; charset=utf-8: schema: $ref: '#/components/schemas/success_response' '400': description: Invalid request. content: application/json: schema: $ref: '#/components/schemas/error_response' application/json; charset=utf-8: schema: $ref: '#/components/schemas/error_response' '403': description: Invalid credentials. '429': description: Request was throttled. /api/v1/identities/{identity_id}: get: tags: - Identities operationId: GetIdentity description: | Returns an identity by ID summary: Get identity security: - ManagementAPI: - read:identities parameters: - name: identity_id in: path description: The unique identifier for the identity. required: true schema: type: string responses: '200': description: Identity successfully retrieved. content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/identity' application/json: schema: $ref: '#/components/schemas/identity' '400': description: Invalid request. content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/error_response' application/json: schema: $ref: '#/components/schemas/error_response' '403': description: Invalid credentials. content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/error_response' application/json: schema: $ref: '#/components/schemas/error_response' '429': description: Request was throttled. patch: tags: - Identities operationId: UpdateIdentity description: Update identity by ID. summary: Update identity security: - ManagementAPI: - update:identities parameters: - name: identity_id in: path description: The unique identifier for the identity. required: true schema: type: string requestBody: description: The fields of the identity to update. required: true content: application/json: schema: type: object properties: is_primary: description: Whether the identity is the primary for it's type type: boolean nullable: false responses: '200': description: Identity successfully updated. content: application/json: schema: $ref: '#/components/schemas/success_response' application/json; charset=utf-8: schema: $ref: '#/components/schemas/success_response' '400': description: Invalid request. content: application/json: schema: $ref: '#/components/schemas/error_response' application/json; charset=utf-8: schema: $ref: '#/components/schemas/error_response' '403': description: Invalid credentials. '429': description: Request was throttled. delete: tags: - Identities operationId: DeleteIdentity description: Delete identity by ID. summary: Delete identity security: - ManagementAPI: - delete:identities parameters: - name: identity_id in: path description: The unique identifier for the identity. required: true schema: type: string responses: '200': description: Identity successfully deleted. content: application/json: schema: $ref: '#/components/schemas/success_response' application/json; charset=utf-8: schema: $ref: '#/components/schemas/success_response' '400': description: Invalid request. content: application/json: schema: $ref: '#/components/schemas/error_response' application/json; charset=utf-8: schema: $ref: '#/components/schemas/error_response' '403': description: Invalid credentials. '429': description: Request was throttled. /api/v1/organization: get: tags: - Organizations operationId: getOrganization summary: Get organization description: Retrieve organization details by code. security: - ManagementAPI: - read:organizations parameters: - in: query name: code description: The organization's code. schema: type: string example: org_1ccfb819462 responses: '200': description: Organization successfully retrieved. content: application/json: schema: $ref: '#/components/schemas/get_organization_response' '400': $ref: '#/components/responses/bad_request' '403': $ref: '#/components/responses/forbidden' '429': $ref: '#/components/responses/too_many_requests' post: tags: - Organizations operationId: createOrganization summary: Create organization description: >- Create a new organization. To learn more read about [multi tenancy using organizations](https://docs.kinde.com/build/organizations/multi-tenancy-using-organizations/) security: - ManagementAPI: - create:organizations requestBody: description: Organization details. required: true content: application/json: schema: type: object required: - name properties: name: description: The organization's name. type: string example: Acme Corp feature_flags: type: object description: The organization's feature flag settings. additionalProperties: type: string enum: - str - int - bool description: Value of the feature flag. external_id: description: >- The organization's external identifier - commonly used when migrating from or mapping to other systems. type: string example: some1234 background_color: description: The organization's brand settings - background color. type: string button_color: description: The organization's brand settings - button color. type: string button_text_color: description: The organization's brand settings - button text color. type: string link_color: description: The organization's brand settings - link color. type: string background_color_dark: description: >- The organization's brand settings - dark mode background color. type: string button_color_dark: description: The organization's brand settings - dark mode button color. type: string button_text_color_dark: description: >- The organization's brand settings - dark mode button text color. type: string link_color_dark: description: The organization's brand settings - dark mode link color. type: string theme_code: description: >- The organization's brand settings - theme/mode 'light' | 'dark' | 'user_preference'. type: string handle: description: >- A unique handle for the organization - can be used for dynamic callback urls. type: string example: acme_corp is_allow_registrations: description: >- If users become members of this organization when the org code is supplied during authentication. type: boolean example: true is_custom_auth_connections_enabled: description: Enable custom auth connections for this organization. type: boolean responses: '200': description: Organization successfully created. content: application/json: schema: $ref: '#/components/schemas/create_organization_response' '400': $ref: '#/components/responses/bad_request' '403': $ref: '#/components/responses/forbidden' '429': $ref: '#/components/responses/too_many_requests' /api/v1/organizations: get: tags: - Organizations operationId: getOrganizations summary: Get organizations description: Get a list of organizations. security: - ManagementAPI: - read:organizations parameters: - name: sort in: query description: Field and order to sort the result by. schema: type: string nullable: true enum: - name_asc - name_desc - email_asc - email_desc - name: page_size in: query description: Number of results per page. Defaults to 10 if parameter not sent. schema: type: integer nullable: true - name: next_token in: query description: A string to get the next page of results if there are more results. schema: type: string nullable: true responses: '200': description: Organizations successfully retreived. content: application/json: schema: $ref: '#/components/schemas/get_organizations_response' '400': $ref: '#/components/responses/bad_request' '403': $ref: '#/components/responses/forbidden' '429': $ref: '#/components/responses/too_many_requests' /api/v1/organization/{org_code}: patch: tags: - Organizations operationId: updateOrganization description: Update an organization. summary: Update Organization security: - ManagementAPI: - update:organizations parameters: - name: org_code in: path description: The identifier for the organization. required: true schema: type: string example: org_1ccfb819462 requestBody: description: Organization details. required: false content: application/json: schema: type: object properties: name: description: The organization's name. type: string example: Acme Corp external_id: description: The organization's ID. type: string example: some1234 background_color: description: The organization's brand settings - background color. type: string example: '#fff' button_color: description: The organization's brand settings - button color. type: string example: '#fff' button_text_color: description: The organization's brand settings - button text color. type: string example: '#fff' link_color: description: The organization's brand settings - link color. type: string example: '#fff' background_color_dark: description: >- The organization's brand settings - dark mode background color. type: string example: '#000' button_color_dark: description: The organization's brand settings - dark mode button color. type: string example: '#000' button_text_color_dark: description: >- The organization's brand settings - dark mode button text color. type: string example: '#000' link_color_dark: description: The organization's brand settings - dark mode link color. type: string example: '#000' theme_code: description: The organization's brand settings - theme/mode. type: string enum: - light - dark - user_preference example: light handle: description: The organization's handle. type: string example: acme_corp is_allow_registrations: deprecated: true description: Deprecated - Use 'is_auto_membership_enabled' instead. type: boolean is_custom_auth_connections_enabled: description: Enable custom auth connections for this organization. type: boolean example: true is_auto_join_domain_list: description: Users can sign up to this organization. type: boolean example: true allowed_domains: description: Domains allowed for self-sign up to this environment. type: array example: - https://acme.kinde.com - https://acme.com items: type: string responses: '200': description: Organization successfully updated. content: application/json: schema: $ref: '#/components/schemas/success_response' '400': $ref: '#/components/responses/bad_request' '403': $ref: '#/components/responses/forbidden' '429': $ref: '#/components/responses/too_many_requests' delete: tags: - Organizations operationId: deleteOrganization description: Delete an organization. summary: Delete Organization security: - ManagementAPI: - delete:organizations parameters: - name: org_code in: path description: The identifier for the organization. required: true schema: type: string responses: '200': description: Organization successfully deleted. content: application/json: schema: $ref: '#/components/schemas/success_response' '400': $ref: '#/components/responses/bad_request' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not_found' '429': $ref: '#/components/responses/too_many_requests' /api/v1/organizations/{org_code}/users: get: tags: - Organizations operationId: GetOrganizationUsers description: Get users in an organization. summary: List Organization Users security: - ManagementAPI: - read:organization_users parameters: - name: sort in: query description: Field and order to sort the result by. schema: type: string nullable: true enum: - name_asc - name_desc - email_asc - email_desc - id_asc - id_desc - name: page_size in: query description: Number of results per page. Defaults to 10 if parameter not sent. schema: type: integer nullable: true - name: next_token in: query description: A string to get the next page of results if there are more results. schema: type: string nullable: true - name: org_code in: path description: The organization's code. required: true schema: type: string nullable: false - name: permissions in: query description: Filter by user permissions comma separated (where all match) schema: type: string - name: roles in: query description: Filter by user roles comma separated (where all match) schema: type: string responses: '200': description: >- A successful response with a list of organization users or an empty list. content: application/json: schema: $ref: '#/components/schemas/get_organization_users_response' application/json; charset=utf-8: schema: $ref: '#/components/schemas/get_organization_users_response' '400': description: Error creating user content: application/json: schema: $ref: '#/components/schemas/error_response' application/json; charset=utf-8: schema: $ref: '#/components/schemas/error_response' '403': description: Invalid credentials. '429': description: Request was throttled. post: tags: - Organizations operationId: AddOrganizationUsers description: Add existing users to an organization. summary: Add Organization Users security: - ManagementAPI: - create:organization_users parameters: - name: org_code in: path description: The organization's code. required: true schema: type: string nullable: false requestBody: required: false content: application/json: schema: type: object properties: users: description: Users to be added to the organization. type: array items: type: object properties: id: description: The users id. type: string roles: description: Role keys to assign to the user. type: array items: type: string permissions: description: Permission keys to assign to the user. type: array items: type: string responses: '200': description: Users successfully added. content: application/json: schema: $ref: '#/components/schemas/add_organization_users_response' application/json; charset=utf-8: schema: $ref: '#/components/schemas/add_organization_users_response' '204': description: No users added. '400': description: Bad request. content: application/json: schema: $ref: '#/components/schemas/error_response' application/json; charset=utf-8: schema: $ref: '#/components/schemas/error_response' '403': description: Invalid credentials. '429': description: Request was throttled. patch: tags: - Organizations operationId: UpdateOrganizationUsers description: Update users that belong to an organization. summary: Update Organization Users security: - ManagementAPI: - update:organization_users parameters: - name: org_code in: path description: The organization's code. required: true schema: type: string nullable: false requestBody: required: false content: application/json: schema: type: object properties: users: description: Users to add, update or remove from the organization. type: array items: type: object properties: id: description: The users id. type: string operation: description: >- Optional operation, set to 'delete' to remove the user from the organization. type: string roles: description: Role keys to assign to the user. type: array items: type: string permissions: description: Permission keys to assign to the user. type: array items: type: string responses: '200': description: Users successfully removed. content: application/json: schema: $ref: '#/components/schemas/update_organization_users_response' application/json; charset=utf-8: schema: $ref: '#/components/schemas/update_organization_users_response' '400': description: Error updating organization user. content: application/json: schema: $ref: '#/components/schemas/error_response' application/json; charset=utf-8: schema: $ref: '#/components/schemas/error_response' '403': description: Invalid credentials. '429': description: Request was throttled. /api/v1/organizations/{org_code}/users/{user_id}/roles: get: tags: - Organizations operationId: GetOrganizationUserRoles description: Get roles for an organization user. summary: List Organization User Roles security: - ManagementAPI: - read:organization_user_roles parameters: - name: org_code in: path description: The organization's code. required: true schema: type: string nullable: false - name: user_id in: path description: The user's id. required: true schema: type: string nullable: false responses: '200': description: A successful response with a list of user roles. content: application/json: schema: $ref: '#/components/schemas/get_organizations_user_roles_response' application/json; charset=utf-8: schema: $ref: '#/components/schemas/get_organizations_user_roles_response' '403': description: Invalid credentials. '429': description: Request was throttled. post: tags: - Organizations operationId: CreateOrganizationUserRole description: Add role to an organization user. summary: Add Organization User Role security: - ManagementAPI: - create:organization_user_roles parameters: - name: org_code in: path description: The organization's code. required: true schema: type: string nullable: false - name: user_id in: path description: The user's id. required: true schema: type: string nullable: false requestBody: description: Role details. required: true content: application/json: schema: type: object properties: role_id: description: The role id. type: string responses: '200': description: Role successfully added. content: application/json: schema: $ref: '#/components/schemas/success_response' application/json; charset=utf-8: schema: $ref: '#/components/schemas/success_response' '403': description: Invalid credentials. '429': description: Request was throttled. /api/v1/organizations/{org_code}/users/{user_id}/roles/{role_id}: delete: tags: - Organizations operationId: DeleteOrganizationUserRole description: Delete role for an organization user. summary: Delete Organization User Role security: - ManagementAPI: - delete:organization_user_roles parameters: - name: org_code in: path description: The organization's code. required: true schema: type: string nullable: false - name: user_id in: path description: The user's id. required: true schema: type: string nullable: false - name: role_id in: path description: The role id. required: true schema: type: string nullable: false responses: '200': description: User successfully removed. content: application/json: schema: $ref: '#/components/schemas/success_response' application/json; charset=utf-8: schema: $ref: '#/components/schemas/success_response' '400': description: Error creating user. content: application/json: schema: $ref: '#/components/schemas/error_response' application/json; charset=utf-8: schema: $ref: '#/components/schemas/error_response' '403': description: Invalid credentials. '429': description: Request was throttled. /api/v1/organizations/{org_code}/users/{user_id}/permissions: get: tags: - Organizations operationId: GetOrganizationUserPermissions description: Get permissions for an organization user. summary: List Organization User Permissions security: - ManagementAPI: - read:organization_user_permissions parameters: - name: org_code in: path description: The organization's code. required: true schema: type: string nullable: false - name: user_id in: path description: The user's id. required: true schema: type: string nullable: false - name: expand in: query description: Specify additional data to retrieve. Use "roles". required: false schema: type: string nullable: true responses: '200': description: A successful response with a list of user permissions. content: application/json: schema: $ref: >- #/components/schemas/get_organizations_user_permissions_response application/json; charset=utf-8: schema: $ref: >- #/components/schemas/get_organizations_user_permissions_response '403': description: Invalid credentials. '429': description: Request was throttled. post: tags: - Organizations operationId: CreateOrganizationUserPermission description: Add permission to an organization user. summary: Add Organization User Permission security: - ManagementAPI: - create:organization_user_permissions parameters: - name: org_code in: path description: The organization's code. required: true schema: type: string nullable: false - name: user_id in: path description: The user's id. required: true schema: type: string nullable: false requestBody: description: Permission details. required: true content: application/json: schema: type: object properties: permission_id: description: The permission id. type: string responses: '200': description: User permission successfully updated. content: application/json: schema: $ref: '#/components/schemas/success_response' application/json; charset=utf-8: schema: $ref: '#/components/schemas/success_response' '403': description: Invalid credentials. '429': description: Request was throttled. /api/v1/organizations/{org_code}/users/{user_id}/permissions/{permission_id}: delete: tags: - Organizations operationId: DeleteOrganizationUserPermission description: Delete permission for an organization user. summary: Delete Organization User Permission security: - ManagementAPI: - delete:organization_user_permissions parameters: - name: org_code in: path description: The organization's code. required: true schema: type: string nullable: false - name: user_id in: path description: The user's id. required: true schema: type: string nullable: false - name: permission_id in: path description: The permission id. required: true schema: type: string nullable: false responses: '200': description: User successfully removed. content: application/json: schema: $ref: '#/components/schemas/success_response' application/json; charset=utf-8: schema: $ref: '#/components/schemas/success_response' '400': description: Error creating user. content: application/json: schema: $ref: '#/components/schemas/error_response' application/json; charset=utf-8: schema: $ref: '#/components/schemas/error_response' '403': description: Invalid credentials. '429': description: Request was throttled. /api/v1/organizations/{org_code}/users/{user_id}: delete: tags: - Organizations operationId: RemoveOrganizationUser description: Remove user from an organization. summary: Remove Organization User security: - ManagementAPI: - delete:organization_users parameters: - name: org_code in: path description: The organization's code. required: true schema: type: string nullable: false - name: user_id in: path description: The user's id. required: true schema: type: string nullable: false responses: '200': description: User successfully removed from organization content: application/json: schema: $ref: '#/components/schemas/success_response' application/json; charset=utf-8: schema: $ref: '#/components/schemas/success_response' '400': description: Error removing user content: application/json: schema: $ref: '#/components/schemas/error_response' application/json; charset=utf-8: schema: $ref: '#/components/schemas/error_response' '403': description: Invalid credentials. '429': description: Request was throttled. /api/v1/organizations/{org_code}/feature_flags: get: tags: - Organizations operationId: GetOrganizationFeatureFlags description: Get all organization feature flags. summary: List Organization Feature Flags security: - ManagementAPI: - read:organization_feature_flags parameters: - name: org_code in: path description: The identifier for the organization. required: true schema: type: string responses: '200': description: Feature flag overrides successfully returned. content: application/json: schema: $ref: '#/components/schemas/get_organization_feature_flags_response' application/json; charset=utf-8: schema: $ref: '#/components/schemas/get_organization_feature_flags_response' '400': description: Invalid request. content: application/json: schema: $ref: '#/components/schemas/error_response' application/json; charset=utf-8: schema: $ref: '#/components/schemas/error_response' '403': description: Invalid credentials. '429': description: Request was throttled. delete: tags: - Organizations operationId: DeleteOrganizationFeatureFlagOverrides description: Delete all organization feature flag overrides. summary: Delete Organization Feature Flag Overrides security: - ManagementAPI: - delete:organization_feature_flags parameters: - name: org_code in: path description: The identifier for the organization. required: true schema: type: string responses: '200': description: Feature flag overrides successfully deleted. content: application/json: schema: $ref: '#/components/schemas/success_response' application/json; charset=utf-8: schema: $ref: '#/components/schemas/success_response' '400': description: Invalid request. content: application/json: schema: $ref: '#/components/schemas/error_response' application/json; charset=utf-8: schema: $ref: '#/components/schemas/error_response' '403': description: Invalid credentials. '429': description: Request was throttled. /api/v1/organizations/{org_code}/feature_flags/{feature_flag_key}: delete: tags: - Organizations operationId: DeleteOrganizationFeatureFlagOverride description: Delete organization feature flag override. summary: Delete Organization Feature Flag Override security: - ManagementAPI: - delete:organization_feature_flags parameters: - name: org_code in: path description: The identifier for the organization. required: true schema: type: string - name: feature_flag_key in: path description: The identifier for the feature flag. required: true schema: type: string responses: '200': description: Feature flag override successfully deleted. content: application/json: schema: $ref: '#/components/schemas/success_response' application/json; charset=utf-8: schema: $ref: '#/components/schemas/success_response' '400': description: Invalid request. content: application/json: schema: $ref: '#/components/schemas/error_response' application/json; charset=utf-8: schema: $ref: '#/components/schemas/error_response' '403': description: Invalid credentials. '429': description: Request was throttled. patch: tags: - Organizations operationId: UpdateOrganizationFeatureFlagOverride description: Update organization feature flag override. summary: Update Organization Feature Flag Override security: - ManagementAPI: - update:organization_feature_flags parameters: - name: org_code in: path description: The identifier for the organization required: true schema: type: string - name: feature_flag_key in: path description: The identifier for the feature flag required: true schema: type: string - name: value in: query description: Override value required: true schema: type: string responses: '200': description: Feature flag override successfully updated. content: application/json: schema: $ref: '#/components/schemas/success_response' application/json; charset=utf-8: schema: $ref: '#/components/schemas/success_response' '400': description: Invalid request. content: application/json: schema: $ref: '#/components/schemas/error_response' application/json; charset=utf-8: schema: $ref: '#/components/schemas/error_response' '403': description: Invalid credentials. '429': description: Request was throttled. /api/v1/organizations/{org_code}/properties/{property_key}: put: tags: - Organizations operationId: UpdateOrganizationProperty description: Update organization property value. summary: Update Organization Property value security: - ManagementAPI: - update:organization_properties parameters: - name: org_code in: path description: The identifier for the organization required: true schema: type: string - name: property_key in: path description: The identifier for the property required: true schema: type: string - name: value in: query description: The new property value required: true schema: type: string responses: '200': description: Property successfully updated. content: application/json: schema: $ref: '#/components/schemas/success_response' application/json; charset=utf-8: schema: $ref: '#/components/schemas/success_response' '400': description: Invalid request. content: application/json: schema: $ref: '#/components/schemas/error_response' application/json; charset=utf-8: schema: $ref: '#/components/schemas/error_response' '403': description: Invalid credentials. '429': description: Request was throttled. /api/v1/organizations/{org_code}/properties: get: tags: - Organizations operationId: GetOrganizationPropertyValues description: | Gets properties for an organization by org code. summary: Get Organization Property Values security: - ManagementAPI: - read:organization_properties parameters: - name: org_code in: path description: The organization's code. required: true schema: type: string nullable: false responses: '200': description: Properties successfully retrieved. content: application/json: schema: $ref: '#/components/schemas/get_property_values_response' application/json; charset=utf-8: schema: $ref: '#/components/schemas/get_property_values_response' '400': description: Bad request. content: application/json: schema: $ref: '#/components/schemas/error_response' application/json; charset=utf-8: schema: $ref: '#/components/schemas/error_response' '403': description: Invalid credentials. '429': description: Request was throttled. patch: tags: - Organizations operationId: UpdateOrganizationProperties description: Update organization property values. summary: Update Organization Property values security: - ManagementAPI: - update:organization_properties parameters: - name: org_code in: path description: The identifier for the organization required: true schema: type: string requestBody: description: Properties to update. required: true content: application/json: schema: type: object properties: properties: description: Property keys and values type: object nullable: false required: - properties responses: '200': description: Properties successfully updated. content: application/json: schema: $ref: '#/components/schemas/success_response' application/json; charset=utf-8: schema: $ref: '#/components/schemas/success_response' '400': description: Invalid request. content: application/json: schema: $ref: '#/components/schemas/error_response' application/json; charset=utf-8: schema: $ref: '#/components/schemas/error_response' '403': description: Invalid credentials. '429': description: Request was throttled. /api/v1/organization/{org_code}/handle: delete: tags: - Organizations operationId: DeleteOrganizationHandle description: | Delete organization handle summary: Delete organization handle security: - ManagementAPI: - delete:organization_handles parameters: - name: org_code in: path description: The organization's code. required: true schema: type: string nullable: false responses: '200': description: Handle successfully deleted. content: application/json: schema: $ref: '#/components/schemas/success_response' application/json; charset=utf-8: schema: $ref: '#/components/schemas/success_response' '400': description: Bad request. content: application/json: schema: $ref: '#/components/schemas/error_response' application/json; charset=utf-8: schema: $ref: '#/components/schemas/error_response' '403': description: Invalid credentials. '429': description: Request was throttled. /api/v1/permissions: get: tags: - Permissions operationId: GetPermissions description: > The returned list can be sorted by permission name or permission ID in ascending or descending order. The number of records to return at a time can also be controlled using the `page_size` query string parameter. summary: List Permissions security: - ManagementAPI: - read:permissions parameters: - name: sort in: query description: Field and order to sort the result by. schema: type: string nullable: true enum: - name_asc - name_desc - id_asc - id_desc - name: page_size in: query description: Number of results per page. Defaults to 10 if parameter not sent. schema: type: integer nullable: true - name: next_token in: query description: A string to get the next page of results if there are more results. schema: type: string nullable: true responses: '200': description: Permissions successfully retrieved. content: application/json: schema: $ref: '#/components/schemas/get_permissions_response' application/json; charset=utf-8: schema: $ref: '#/components/schemas/get_permissions_response' '403': description: Invalid credentials. content: application/json: schema: $ref: '#/components/schemas/error_response' application/json; charset=utf-8: schema: $ref: '#/components/schemas/error_response' '429': description: Request was throttled. post: tags: - Permissions operationId: CreatePermission description: Create a new permission. summary: Create Permission security: - ManagementAPI: - create:permissions requestBody: description: Permission details. required: false content: application/json: schema: type: object properties: name: description: The permission's name. type: string description: description: The permission's description. type: string key: description: The permission identifier to use in code. type: string responses: '201': description: Permission successfully created content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/success_response' '400': description: Invalid request. content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/error_response' '403': description: Invalid credentials. content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/error_response' '429': description: Request was throttled. /api/v1/permissions/{permission_id}: patch: tags: - Permissions operationId: UpdatePermissions description: Update permission summary: Update Permission security: - ManagementAPI: - update:permissions parameters: - name: permission_id in: path description: The identifier for the permission. required: true schema: type: integer nullable: false requestBody: description: Permission details. required: false content: application/json: schema: type: object properties: name: description: The permission's name. type: string description: description: The permission's description. type: string key: description: The permission identifier to use in code. type: string responses: '200': description: Permission successfully updated content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/success_response' '400': description: Invalid request. content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/error_response' '403': description: Invalid credentials. content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/error_response' '429': description: Request was throttled. delete: tags: - Permissions operationId: DeletePermission description: Delete permission summary: Delete Permission security: - ManagementAPI: - delete:permissions parameters: - name: permission_id in: path description: The identifier for the permission. required: true schema: type: string responses: '200': description: permission successfully updated. content: application/json: schema: $ref: '#/components/schemas/success_response' application/json; charset=utf-8: schema: $ref: '#/components/schemas/success_response' '400': description: Invalid request. content: application/json: schema: $ref: '#/components/schemas/error_response' application/json; charset=utf-8: schema: $ref: '#/components/schemas/error_response' '403': description: Invalid credentials. '429': description: Request was throttled. /api/v1/properties: get: tags: - Properties operationId: GetProperties description: | Returns a list of properties summary: List properties security: - ManagementAPI: - read:properties parameters: - name: page_size in: query description: Number of results per page. Defaults to 10 if parameter not sent. schema: type: integer nullable: true - name: starting_after in: query description: The ID of the property to start after. schema: type: string nullable: true - name: ending_before in: query description: The ID of the property to end before. schema: type: string nullable: true - name: context in: query description: Filter results by User or Organization context schema: type: string nullable: true enum: - usr - org responses: '200': description: Properties successfully retrieved. content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/get_properties_response' application/json: schema: $ref: '#/components/schemas/get_properties_response' '400': description: Invalid request. content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/error_response' application/json: schema: $ref: '#/components/schemas/error_response' '403': description: Invalid credentials. content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/error_response' application/json: schema: $ref: '#/components/schemas/error_response' '429': description: Request was throttled. post: tags: - Properties operationId: CreateProperty description: Create property. summary: Create Property security: - ManagementAPI: - create:properties requestBody: description: Property details. required: true content: application/json: schema: type: object properties: name: description: The name of the property. type: string nullable: false description: description: Description of the property purpose. type: string nullable: false key: description: The property identifier to use in code. type: string nullable: false type: description: The property type. type: string enum: - single_line_text - multi_line_text nullable: false context: description: The context that the property applies to. type: string enum: - org - usr - app nullable: false is_private: description: >- Whether the property can be included in id and access tokens. type: boolean nullable: false category_id: description: Which category the property belongs to. type: string nullable: false required: - name - key - type - context - is_private - category_id responses: '201': description: Property successfully created content: application/json: schema: $ref: '#/components/schemas/create_property_response' application/json; charset=utf-8: schema: $ref: '#/components/schemas/create_property_response' '400': description: Invalid request. content: application/json: schema: $ref: '#/components/schemas/error_response' application/json; charset=utf-8: schema: $ref: '#/components/schemas/error_response' '403': description: Invalid credentials. '429': description: Request was throttled. /api/v1/properties/{property_id}: put: tags: - Properties operationId: UpdateProperty description: Update property. summary: Update Property security: - ManagementAPI: - update:properties parameters: - name: property_id in: path description: The unique identifier for the property. required: true schema: type: string requestBody: description: The fields of the property to update. required: true content: application/json: schema: type: object properties: name: description: The name of the property. type: string nullable: false description: type: string description: Description of the property purpose. is_private: type: boolean description: >- Whether the property can be included in id and access tokens. category_id: description: Which category the property belongs to. type: string nullable: false required: - name - is_private - category_id responses: '200': description: Property successfully updated. content: application/json: schema: $ref: '#/components/schemas/success_response' application/json; charset=utf-8: schema: $ref: '#/components/schemas/success_response' '400': description: Invalid request. content: application/json: schema: $ref: '#/components/schemas/error_response' application/json; charset=utf-8: schema: $ref: '#/components/schemas/error_response' '403': description: Invalid credentials. '429': description: Request was throttled. delete: tags: - Properties operationId: DeleteProperty description: Delete property. summary: Delete Property security: - ManagementAPI: - delete:properties parameters: - name: property_id in: path description: The unique identifier for the property. required: true schema: type: string responses: '200': description: Property successfully deleted. content: application/json: schema: $ref: '#/components/schemas/success_response' application/json; charset=utf-8: schema: $ref: '#/components/schemas/success_response' '400': description: Invalid request. content: application/json: schema: $ref: '#/components/schemas/error_response' application/json; charset=utf-8: schema: $ref: '#/components/schemas/error_response' '403': description: Invalid credentials. '429': description: Request was throttled. /api/v1/property_categories: get: tags: - Property Categories operationId: GetCategories description: | Returns a list of categories. summary: List categories security: - ManagementAPI: - read:property_categories parameters: - name: page_size in: query description: Number of results per page. Defaults to 10 if parameter not sent. schema: type: integer nullable: true - name: starting_after in: query description: The ID of the category to start after. schema: type: string nullable: true - name: ending_before in: query description: The ID of the category to end before. schema: type: string nullable: true - name: context in: query description: Filter the results by User or Organization context schema: type: string nullable: true enum: - usr - org responses: '200': description: Categories successfully retrieved. content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/get_categories_response' application/json: schema: $ref: '#/components/schemas/get_categories_response' '400': description: Invalid request. content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/error_response' application/json: schema: $ref: '#/components/schemas/error_response' '403': description: Invalid credentials. content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/error_response' application/json: schema: $ref: '#/components/schemas/error_response' '429': description: Request was throttled. post: tags: - Property Categories operationId: CreateCategory description: Create category. summary: Create Category security: - ManagementAPI: - create:property_categories requestBody: description: Category details. required: true content: application/json: schema: type: object properties: name: description: The name of the category. type: string nullable: false context: description: The context that the category applies to. type: string enum: - org - usr - app nullable: false required: - name - context responses: '201': description: Category successfully created content: application/json: schema: $ref: '#/components/schemas/create_category_response' application/json; charset=utf-8: schema: $ref: '#/components/schemas/create_category_response' '400': description: Invalid request. content: application/json: schema: $ref: '#/components/schemas/error_response' application/json; charset=utf-8: schema: $ref: '#/components/schemas/error_response' '403': description: Invalid credentials. '429': description: Request was throttled. /api/v1/property_categories/{category_id}: put: tags: - Property Categories operationId: UpdateCategory description: Update category. summary: Update Category security: - ManagementAPI: - update:property_categories parameters: - name: category_id in: path description: The unique identifier for the category. required: true schema: type: string requestBody: description: The fields of the category to update. required: true content: application/json: schema: type: object properties: name: description: The name of the category. type: string nullable: false responses: '200': description: category successfully updated. content: application/json: schema: $ref: '#/components/schemas/success_response' application/json; charset=utf-8: schema: $ref: '#/components/schemas/success_response' '400': description: Invalid request. content: application/json: schema: $ref: '#/components/schemas/error_response' application/json; charset=utf-8: schema: $ref: '#/components/schemas/error_response' '403': description: Invalid credentials. '429': description: Request was throttled. /api/v1/roles: get: tags: - Roles operationId: GetRoles description: > The returned list can be sorted by role name or role ID in ascending or descending order. The number of records to return at a time can also be controlled using the `page_size` query string parameter. summary: List roles security: - ManagementAPI: - read:roles parameters: - name: sort in: query description: Field and order to sort the result by. schema: type: string nullable: true enum: - name_asc - name_desc - id_asc - id_desc - name: page_size in: query description: Number of results per page. Defaults to 10 if parameter not sent. schema: type: integer nullable: true - name: next_token in: query description: A string to get the next page of results if there are more results. schema: type: string nullable: true responses: '200': description: Roles successfully retrieved. content: application/json: schema: $ref: '#/components/schemas/get_roles_response' '400': $ref: '#/components/responses/bad_request' '403': $ref: '#/components/responses/forbidden' '429': $ref: '#/components/responses/too_many_requests' post: tags: - Roles operationId: CreateRole description: Create role. summary: Create role security: - ManagementAPI: - create:roles requestBody: description: Role details. required: false content: application/json: schema: type: object properties: name: description: The role's name. type: string description: description: The role's description. type: string key: description: The role identifier to use in code. type: string is_default_role: description: Set role as default for new users. type: boolean responses: '201': description: Role successfully created content: application/json: schema: $ref: '#/components/schemas/create_roles_response' '400': $ref: '#/components/responses/bad_request' '403': $ref: '#/components/responses/forbidden' '429': $ref: '#/components/responses/too_many_requests' /api/v1/roles/{role_id}: get: tags: - Roles operationId: GetRole description: Get a role summary: Get role security: - ManagementAPI: - read:roles parameters: - name: role_id in: path description: The identifier for the role. schema: type: string required: true responses: '200': description: Role successfully retrieved. content: application/json: schema: $ref: '#/components/schemas/get_role_response' '400': $ref: '#/components/responses/bad_request' '403': $ref: '#/components/responses/forbidden' '429': $ref: '#/components/responses/too_many_requests' patch: tags: - Roles operationId: UpdateRoles description: Update a role summary: Update role security: - ManagementAPI: - update:roles parameters: - name: role_id in: path description: The identifier for the role. schema: type: string required: true requestBody: description: Role details. required: false content: application/json: schema: type: object properties: name: description: The role's name. type: string description: description: The role's description. type: string key: description: The role identifier to use in code. type: string is_default_role: description: Set role as default for new users. type: boolean required: - name - key responses: '201': description: Role successfully updated content: application/json: schema: $ref: '#/components/schemas/success_response' '400': $ref: '#/components/responses/bad_request' '403': $ref: '#/components/responses/forbidden' '429': $ref: '#/components/responses/too_many_requests' delete: tags: - Roles operationId: DeleteRole description: Delete role summary: Delete role security: - ManagementAPI: - delete:roles parameters: - name: role_id in: path description: The identifier for the role. required: true schema: type: string responses: '200': description: Role successfully deleted. content: application/json: schema: $ref: '#/components/schemas/success_response' '400': $ref: '#/components/responses/bad_request' '403': $ref: '#/components/responses/forbidden' '429': $ref: '#/components/responses/too_many_requests' /api/v1/roles/{role_id}/permissions: get: tags: - Roles operationId: GetRolePermission description: Get permissions for a role. summary: Get role permissions security: - ManagementAPI: - read:role_permissions parameters: - name: role_id in: path description: The role's public id. required: true schema: type: string nullable: false - name: sort in: query description: Field and order to sort the result by. schema: type: string nullable: true enum: - name_asc - name_desc - id_asc - id_desc - name: page_size in: query description: Number of results per page. Defaults to 10 if parameter not sent. schema: type: integer nullable: true - name: next_token in: query description: A string to get the next page of results if there are more results. schema: type: string nullable: true responses: '200': description: A list of permissions for a role content: application/json: schema: $ref: '#/components/schemas/roles_permission_response' application/json; charset=utf-8: schema: $ref: '#/components/schemas/roles_permission_response' '400': description: Error removing user content: application/json: schema: $ref: '#/components/schemas/error_response' application/json; charset=utf-8: schema: $ref: '#/components/schemas/error_response' '403': description: Invalid credentials. '429': description: Request was throttled. patch: tags: - Roles operationId: UpdateRolePermissions description: | Update role permissions. summary: Update role permissions security: - ManagementAPI: - update:role_permissions parameters: - name: role_id in: path description: The identifier for the role. required: true schema: type: string nullable: false requestBody: required: true content: application/json: schema: type: object properties: permissions: description: Permissions to add or remove from the role. type: array items: type: object properties: id: description: The permission id. type: string operation: description: >- Optional operation, set to 'delete' to remove the permission from the role. type: string responses: '200': description: Permissions successfully updated. content: application/json: schema: $ref: '#/components/schemas/update_role_permissions_response' application/json; charset=utf-8: schema: $ref: '#/components/schemas/update_role_permissions_response' '403': description: Invalid credentials. content: application/json: schema: $ref: '#/components/schemas/error_response' application/json; charset=utf-8: schema: $ref: '#/components/schemas/error_response' '429': description: Request was throttled. /api/v1/roles/{role_id}/permissions/{permission_id}: delete: tags: - Roles operationId: RemoveRolePermission description: Remove a permission from a role. summary: Remove role permission security: - ManagementAPI: - delete:role_permissions parameters: - name: role_id in: path description: The role's public id. required: true schema: type: string nullable: false - name: permission_id in: path description: The permission's public id. required: true schema: type: string nullable: false responses: '200': description: Permission successfully removed from role content: application/json: schema: $ref: '#/components/schemas/success_response' application/json; charset=utf-8: schema: $ref: '#/components/schemas/success_response' '400': description: Error removing user content: application/json: schema: $ref: '#/components/schemas/error_response' application/json; charset=utf-8: schema: $ref: '#/components/schemas/error_response' '403': description: Invalid credentials. '429': description: Request was throttled. /api/v1/subscribers: get: tags: - Subscribers operationId: GetSubscribers description: > The returned list can be sorted by full name or email address in ascending or descending order. The number of records to return at a time can also be controlled using the `page_size` query string parameter. summary: List Subscribers security: - ManagementAPI: - read:subscribers parameters: - name: sort in: query description: Field and order to sort the result by. schema: type: string nullable: true enum: - name_asc - name_desc - email_asc - email_desc - name: page_size in: query description: Number of results per page. Defaults to 10 if parameter not sent. schema: type: integer nullable: true - name: next_token in: query description: A string to get the next page of results if there are more results. schema: type: string nullable: true responses: '200': description: Subscriber successfully retrieved. content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/get_subscribers_response' '403': description: Bad request. content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/error_response' '429': description: Request was throttled. post: tags: - Subscribers operationId: CreateSubscriber description: Create subscriber. summary: Create Subscriber security: - ManagementAPI: - create:subscribers parameters: - name: first_name in: query description: Subscriber's first name. required: true schema: type: string nullable: false - name: last_name in: query description: Subscriber's last name. required: true schema: type: string nullable: true - name: email in: query description: The email address of the subscriber. required: true schema: type: string nullable: true responses: '201': description: Subscriber successfully created content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/create_subscriber_success_response' '400': description: Invalid request. content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/error_response' '403': description: Invalid credentials. content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/error_response' '429': description: Request was throttled. /api/v1/subscribers/{subscriber_id}: get: tags: - Subscribers operationId: GetSubscriber description: | Retrieve a subscriber record. summary: Get Subscriber security: - ManagementAPI: - read:subscribers parameters: - name: subscriber_id in: path description: The subscriber's id. required: true schema: type: string nullable: false responses: '200': description: Subscriber successfully retrieved. content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/get_subscriber_response' '400': description: Bad request. content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/error_response' '403': description: Invalid credentials. content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/error_response' '429': description: Request was throttled. /api/v1/users: get: tags: - Users operationId: getUsers description: > The returned list can be sorted by full name or email address in ascending or descending order. The number of records to return at a time can also be controlled using the `page_size` query string parameter. summary: Get users security: - ManagementAPI: - read:users parameters: - name: page_size in: query description: Number of results per page. Defaults to 10 if parameter not sent. schema: type: integer nullable: true - name: user_id in: query description: ID of the user to filter by. schema: type: string nullable: true - name: next_token in: query description: A string to get the next page of results if there are more results. schema: type: string nullable: true - name: email in: query description: >- Filter the results by email address. The query string should be comma separated and url encoded. schema: type: string nullable: true - name: username in: query description: >- Filter the results by username. The query string should be comma separated and url encoded. schema: type: string nullable: true - name: expand in: query description: >- Specify additional data to retrieve. Use "organizations" and/or "identities". required: false schema: type: string nullable: true - name: has_organization in: query description: >- Filter the results by if the user has at least one organization assigned. required: false schema: type: boolean nullable: true responses: '200': description: Users successfully retrieved. content: application/json: schema: $ref: '#/components/schemas/users_response' '400': $ref: '#/components/responses/bad_request' '403': $ref: '#/components/responses/forbidden' '429': $ref: '#/components/responses/too_many_requests' /api/v1/users/{user_id}/refresh_claims: post: tags: - Users operationId: refreshUserClaims description: | Refreshes the user's claims and invalidates the current cache. summary: Refresh User Claims and Invalidate Cache security: - ManagementAPI: - update:user_refresh_claims parameters: - in: path name: user_id schema: type: string required: true description: The id of the user whose claims needs to be updated. responses: '200': description: Claims successfully refreshed. content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/success_response' application/json: schema: $ref: '#/components/schemas/success_response' '400': description: Bad request. content: application/json: schema: $ref: '#/components/schemas/error_response' application/json; charset=utf-8: schema: $ref: '#/components/schemas/error_response' '403': description: Bad request. content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/error_response' application/json: schema: $ref: '#/components/schemas/error_response' '429': description: Request was throttled. /api/v1/user: get: tags: - Users operationId: getUserData description: | Retrieve a user record. summary: Get user security: - ManagementAPI: - read:users parameters: - name: id in: query description: The user's id. required: true schema: type: string nullable: false - name: expand in: query description: >- Specify additional data to retrieve. Use "organizations" and/or "identities". required: false schema: type: string nullable: true responses: '200': description: User successfully updated. content: application/json: schema: $ref: '#/components/schemas/user' '400': $ref: '#/components/responses/bad_request' '403': $ref: '#/components/responses/forbidden' '429': $ref: '#/components/responses/too_many_requests' post: tags: - Users operationId: createUser description: > Creates a user record and optionally zero or more identities for the user. An example identity could be the email address of the user. summary: Create user security: - ManagementAPI: - create:users requestBody: description: The details of the user to create. required: false content: application/json: schema: type: object properties: profile: description: Basic information required to create a user. type: object properties: given_name: type: string description: User's first name. family_name: type: string description: User's last name. picture: type: string description: The user's profile picture. organization_code: description: >- The unique code associated with the organization you want the user to join. type: string provided_id: description: An external id to reference the user. type: string identities: type: array description: Array of identities to assign to the created user items: type: object description: The result of the user creation operation. properties: type: type: string description: >- The type of identity to create, e.g. email, username, or phone. enum: - email - phone - username details: type: object description: Additional details required to create the user. properties: email: type: string description: The email address of the user. example: email@email.com phone: type: string description: The phone number of the user. example: '+61426148233' phone_country_id: type: string description: The country code for the phone number. example: au username: type: string description: The username of the user. example: myusername example: - type: email details: email: email@email.com - type: phone details: phone: '+61426148233' phone_country_id: au - type: username details: username: myusername responses: '200': description: User successfully created. content: application/json: schema: $ref: '#/components/schemas/create_user_response' '400': $ref: '#/components/responses/bad_request' '403': $ref: '#/components/responses/forbidden' '429': $ref: '#/components/responses/too_many_requests' patch: tags: - Users operationId: updateUser description: | Update a user record. summary: Update user security: - ManagementAPI: - update:users parameters: - name: id in: query description: The user's id. required: true schema: type: string nullable: false requestBody: description: The user to update. required: true content: application/json: schema: type: object properties: given_name: type: string description: User's first name. family_name: type: string description: User's last name. picture: type: string description: The user's profile picture. is_suspended: type: boolean description: Whether the user is currently suspended or not. is_password_reset_requested: type: boolean description: Prompt the user to change their password on next sign in. provided_id: description: An external id to reference the user. type: string responses: '200': description: User successfully updated. content: application/json: schema: $ref: '#/components/schemas/update_user_response' '400': $ref: '#/components/responses/bad_request' '403': $ref: '#/components/responses/forbidden' '429': $ref: '#/components/responses/too_many_requests' delete: tags: - Users operationId: deleteUser description: | Delete a user record. summary: Delete user security: - ManagementAPI: - delete:users parameters: - name: id in: query description: The user's id. required: true schema: type: string nullable: false example: kp_c3143a4b50ad43c88e541d9077681782 - name: is_delete_profile in: query description: >- Delete all data and remove the user's profile from all of Kinde, including the subscriber list schema: type: boolean nullable: false example: true responses: '200': description: User successfully deleted. content: application/json: schema: $ref: '#/components/schemas/success_response' '400': $ref: '#/components/responses/bad_request' '403': $ref: '#/components/responses/forbidden' '429': $ref: '#/components/responses/too_many_requests' /api/v1/users/{user_id}/feature_flags/{feature_flag_key}: patch: tags: - Users operationId: UpdateUserFeatureFlagOverride description: Update user feature flag override. summary: Update User Feature Flag Override security: - ManagementAPI: - update:user_feature_flags parameters: - name: user_id in: path description: The identifier for the user required: true schema: type: string - name: feature_flag_key in: path description: The identifier for the feature flag required: true schema: type: string - name: value in: query description: Override value required: true schema: type: string responses: '200': description: Feature flag override successfully updated. content: application/json: schema: $ref: '#/components/schemas/success_response' application/json; charset=utf-8: schema: $ref: '#/components/schemas/success_response' '400': description: Invalid request. content: application/json: schema: $ref: '#/components/schemas/error_response' application/json; charset=utf-8: schema: $ref: '#/components/schemas/error_response' '403': description: Invalid credentials. '429': description: Request was throttled. /api/v1/users/{user_id}/properties/{property_key}: put: tags: - Users operationId: UpdateUserProperty description: Update property value. summary: Update Property value security: - ManagementAPI: - update:user_properties parameters: - name: user_id in: path description: The identifier for the user required: true schema: type: string - name: property_key in: path description: The identifier for the property required: true schema: type: string - name: value in: query description: The new property value required: true schema: type: string responses: '200': description: Property successfully updated. content: application/json: schema: $ref: '#/components/schemas/success_response' application/json; charset=utf-8: schema: $ref: '#/components/schemas/success_response' '400': description: Invalid request. content: application/json: schema: $ref: '#/components/schemas/error_response' application/json; charset=utf-8: schema: $ref: '#/components/schemas/error_response' '403': description: Invalid credentials. '429': description: Request was throttled. /api/v1/users/{user_id}/properties: get: tags: - Users operationId: GetUserPropertyValues description: | Gets properties for an user by ID. summary: Get property values security: - ManagementAPI: - read:user_properties parameters: - name: user_id in: path description: The user's ID. required: true schema: type: string nullable: false responses: '200': description: Properties successfully retrieved. content: application/json: schema: $ref: '#/components/schemas/get_property_values_response' application/json; charset=utf-8: schema: $ref: '#/components/schemas/get_property_values_response' '400': description: Bad request. content: application/json: schema: $ref: '#/components/schemas/error_response' application/json; charset=utf-8: schema: $ref: '#/components/schemas/error_response' '403': description: Invalid credentials. '429': description: Request was throttled. patch: tags: - Users operationId: UpdateUserProperties description: Update property values. summary: Update Property values security: - ManagementAPI: - update:user_properties parameters: - name: user_id in: path description: The identifier for the user required: true schema: type: string requestBody: description: Properties to update. required: true content: application/json: schema: type: object properties: properties: description: Property keys and values type: object nullable: false required: - properties responses: '200': description: Properties successfully updated. content: application/json: schema: $ref: '#/components/schemas/success_response' application/json; charset=utf-8: schema: $ref: '#/components/schemas/success_response' '400': description: Invalid request. content: application/json: schema: $ref: '#/components/schemas/error_response' application/json; charset=utf-8: schema: $ref: '#/components/schemas/error_response' '403': description: Invalid credentials. '429': description: Request was throttled. /api/v1/users/{user_id}/password: put: tags: - Users operationId: SetUserPassword description: Set user password. summary: Set User password security: - ManagementAPI: - update:user_passwords parameters: - name: user_id in: path description: The identifier for the user required: true schema: type: string requestBody: description: Password details. required: true content: application/json: schema: type: object properties: hashed_password: description: The hashed password. type: string hashing_method: description: >- The hashing method or algorithm used to encrypt the user’s password. Default is bcrypt. type: string enum: - bcrypt - crypt - md5 - wordpress salt: type: string description: >- Extra characters added to passwords to make them stronger. Not required for bcrypt. salt_position: type: string description: >- Position of salt in password string. Not required for bcrypt. enum: - prefix - suffix is_temporary_password: type: boolean description: >- The user will be prompted to set a new password after entering this one. required: - hashed_password responses: '200': description: User successfully created. content: application/json: schema: $ref: '#/components/schemas/success_response' application/json; charset=utf-8: schema: $ref: '#/components/schemas/success_response' '400': description: Error creating user. content: application/json: schema: $ref: '#/components/schemas/error_response' application/json; charset=utf-8: schema: $ref: '#/components/schemas/error_response' '403': description: Invalid credentials. '429': description: Request was throttled. /api/v1/users/{user_id}/identities: get: tags: - Users operationId: GetUserIdentities description: | Gets a list of identities for an user by ID. summary: Get identities security: - ManagementAPI: - read:user_identities parameters: - name: user_id in: path description: The user's ID. required: true schema: type: string nullable: false - name: starting_after in: query description: The ID of the identity to start after. schema: type: string nullable: true - name: ending_before in: query description: The ID of the identity to end before. schema: type: string nullable: true responses: '200': description: Identities successfully retrieved. content: application/json: schema: $ref: '#/components/schemas/get_identities_response' application/json; charset=utf-8: schema: $ref: '#/components/schemas/get_identities_response' '400': description: Bad request. content: application/json: schema: $ref: '#/components/schemas/error_response' application/json; charset=utf-8: schema: $ref: '#/components/schemas/error_response' '403': description: Invalid credentials. '429': description: Request was throttled. post: tags: - Users operationId: CreateUserIdentity description: | Creates an identity for a user. summary: Create identity security: - ManagementAPI: - create:user_identities parameters: - name: user_id in: path description: The user's ID. required: true schema: type: string nullable: false requestBody: description: The identity details. required: false content: application/json: schema: type: object properties: value: type: string description: The email address, social identity, or username of the user. example: sally@example.com type: type: string description: The identity type enum: - email - username - phone - enterprise - social example: email phone_country_id: type: string description: >- The country code for the phone number, only required when identity type is 'phone'. example: au connection_id: type: string description: >- The social connection ID, only required when identity type is 'social'. example: conn_019289347f1193da6c0e4d49b97b4bd2 responses: '201': description: Identity successfully created. content: application/json: schema: $ref: '#/components/schemas/create_identity_response' application/json; charset=utf-8: schema: $ref: '#/components/schemas/create_identity_response' '400': description: Error creating identity. content: application/json: schema: $ref: '#/components/schemas/error_response' application/json; charset=utf-8: schema: $ref: '#/components/schemas/error_response' '403': description: Invalid credentials. '429': description: Request was throttled. /api/v1/events/{event_id}: get: tags: - Webhooks operationId: GetEvent description: | Returns an event summary: Get Event security: - ManagementAPI: - read:events parameters: - name: event_id in: path description: The event id. required: true schema: type: string nullable: false responses: '200': description: Event successfully retrieved. content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/get_event_response' application/json: schema: $ref: '#/components/schemas/get_event_response' '400': description: Invalid request. content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/error_response' application/json: schema: $ref: '#/components/schemas/error_response' '403': description: Invalid credentials. content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/error_response' application/json: schema: $ref: '#/components/schemas/error_response' '429': description: Request was throttled. /api/v1/event_types: get: tags: - Webhooks operationId: GetEventTypes description: | Returns a list event type definitions summary: List Event Types security: - ManagementAPI: - read:event_types responses: '200': description: Event types successfully retrieved. content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/get_event_types_response' application/json: schema: $ref: '#/components/schemas/get_event_types_response' '400': description: Invalid request. content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/error_response' application/json: schema: $ref: '#/components/schemas/error_response' '403': description: Invalid credentials. content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/error_response' application/json: schema: $ref: '#/components/schemas/error_response' '429': description: Request was throttled. /api/v1/webhooks/{webhook_id}: delete: tags: - Webhooks operationId: DeleteWebHook description: | Delete webhook summary: Delete Webhook security: - ManagementAPI: - delete:webhooks parameters: - name: webhook_id in: path description: The webhook id. required: true schema: type: string nullable: false responses: '200': description: Webhook successfully deleted. content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/delete_webhook_response' application/json: schema: $ref: '#/components/schemas/delete_webhook_response' '400': description: Invalid request. content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/error_response' application/json: schema: $ref: '#/components/schemas/error_response' '403': description: Invalid credentials. content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/error_response' application/json: schema: $ref: '#/components/schemas/error_response' '429': description: Request was throttled. /api/v1/webhooks: get: tags: - Webhooks operationId: GetWebHooks description: | List webhooks summary: List Webhooks security: - ManagementAPI: - read:webhooks responses: '200': description: Webhook list successfully returned. content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/get_webhooks_response' application/json: schema: $ref: '#/components/schemas/get_webhooks_response' '400': description: Invalid request. content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/error_response' application/json: schema: $ref: '#/components/schemas/error_response' '403': description: Invalid credentials. content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/error_response' application/json: schema: $ref: '#/components/schemas/error_response' '429': description: Request was throttled. post: tags: - Webhooks operationId: CreateWebHook description: | Create a webhook summary: Create a Webhook security: - ManagementAPI: - create:webhooks requestBody: description: Webhook request specification. required: true content: application/json: schema: type: object properties: endpoint: description: The webhook endpoint url type: string nullable: false event_types: description: Array of event type keys type: array items: type: string nullable: false name: description: The webhook name type: string nullable: false description: description: The webhook description type: string nullable: true required: - endpoint - event_types - name responses: '200': description: Webhook successfully created. content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/create_webhook_response' application/json: schema: $ref: '#/components/schemas/create_webhook_response' '400': description: Invalid request. content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/error_response' application/json: schema: $ref: '#/components/schemas/error_response' '403': description: Invalid credentials. content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/error_response' application/json: schema: $ref: '#/components/schemas/error_response' '429': description: Request was throttled. patch: tags: - Webhooks operationId: UpdateWebHook description: | Update a webhook summary: Update a Webhook security: - ManagementAPI: - update:webhooks requestBody: description: Update webhook request specification. required: true content: application/json: schema: type: object properties: event_types: description: Array of event type keys type: array items: type: string nullable: false name: description: The webhook name type: string nullable: false description: description: The webhook description type: string nullable: true responses: '200': description: Webhook successfully updated. content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/update_webhook_response' application/json: schema: $ref: '#/components/schemas/update_webhook_response' '400': description: Invalid request. content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/error_response' application/json: schema: $ref: '#/components/schemas/error_response' '403': description: Invalid credentials. content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/error_response' application/json: schema: $ref: '#/components/schemas/error_response' '429': description: Request was throttled. components: parameters: api_id: in: path name: api_id description: The API's ID. required: true schema: type: string example: 7ccd126599aa422a771abcb341596881 application_id: in: path name: application_id description: The application's ID / client ID. required: true schema: type: string example: 3b0b5c6c8fcc464fab397f4969b5f482 property_key: in: path name: property_key description: The property's key. required: true schema: type: string example: kp_some_key variable_id: in: path name: variable_id description: The environment variable's ID. required: true schema: type: string example: env_var_0192b1941f125645fa15bf28a662a0b3 responses: bad_request: description: Invalid request. content: application/json: schema: $ref: '#/components/schemas/error_response' not_found: description: The specified resource was not found content: application/json: schema: $ref: '#/components/schemas/not_found_response' forbidden: description: Unauthorized - invalid credentials. content: application/json: schema: $ref: '#/components/schemas/error_response' too_many_requests: description: Too many requests. Request was throttled. content: application/json: schema: $ref: '#/components/schemas/error_response' schemas: success_response: type: object properties: message: type: string example: Success code: type: string example: OK error: type: object properties: code: type: string description: Error code. message: type: string description: Error message. error_response: type: object properties: errors: type: array items: $ref: '#/components/schemas/error' not_found_response: type: object properties: errors: type: object properties: code: type: string example: ROUTE_NOT_FOUND message: type: string example: The requested API route does not exist get_apis_response: type: object properties: code: type: string description: Response code. example: OK message: type: string description: Response message. example: Success next_token: type: string description: Pagination token. example: Njo5Om1hvWVfYXNj apis: type: array items: type: object properties: id: description: The unique ID for the API. type: string example: 7ccd126599aa422a771abcb341596881 name: type: string description: The API’s name. example: Example API audience: type: string description: >- A unique identifier for the API - commonly the URL. This value will be used as the `audience` parameter in authorization claims. example: https://api.example.com is_management_api: type: boolean description: Whether or not it is the Kinde management API. example: false create_apis_response: type: object properties: message: type: string description: A Kinde generated message. example: Success code: type: string description: A Kinde generated status code. example: OK api: type: object properties: id: description: The unique ID for the API. type: string example: 7ccd126599aa422a771abcb341596881 get_environment_variables_response: type: object properties: code: type: string description: Response code. example: OK message: type: string description: Response message. example: Success has_more: description: Whether more records exist. type: boolean environment_variables: type: array items: $ref: '#/components/schemas/environment_variable' get_environment_variable_response: type: object properties: code: type: string description: Response code. example: OK message: type: string description: Response message. example: Success environment_variable: $ref: '#/components/schemas/environment_variable' create_environment_variable_response: type: object properties: message: type: string description: A Kinde generated message. example: Environment variable created code: type: string description: A Kinde generated status code. example: VARIABLE_CREATED environment_variable: type: object properties: id: description: The unique ID for the environment variable. type: string example: env_var_0192b194f6156fb7452fe38cfb144958 update_environment_variable_response: type: object properties: message: type: string description: A Kinde generated message. example: Environment variable updated code: type: string description: A Kinde generated status code. example: ENVIRONMENT_VARIABLE_UPDATED delete_environment_variable_response: type: object properties: message: type: string description: A Kinde generated message. example: Environment variable deleted code: type: string description: A Kinde generated status code. example: ENVIRONMENT_VARIABLE_DELETED get_business_response: type: object properties: code: type: string description: Response code. example: OK message: type: string description: Response message. example: Success business: type: object properties: code: type: string description: The unique ID for the business. example: bus_c69fb73b091 name: type: string description: Your business's name. example: Tailsforce Ltd phone: type: string description: Phone number associated with business. example: 555-555-5555 nullable: true email: type: string description: Email address associated with business. example: sally@example.com nullable: true industry: type: string description: The industry your business is in. example: Healthcare & Medical nullable: true timezone: type: string description: The timezone your business is in. example: Los Angeles (Pacific Standard Time) nullable: true privacy_url: type: string description: Your Privacy policy URL. example: https://example.com/privacy nullable: true terms_url: type: string description: Your Terms and Conditions URL. example: https://example.com/terms nullable: true get_industries_response: type: object properties: code: type: string description: Response code. example: OK message: type: string description: Response message. example: Success industries: type: array items: type: object properties: key: description: The unique key for the industry. type: string example: administration_office_support name: type: string description: The display name for the industry. example: Administration & Office Support get_timezones_response: type: object properties: code: type: string description: Response code. example: OK message: type: string description: Response message. example: Success timezones: type: array items: type: object properties: key: description: The unique key for the timezone. type: string example: london_greenwich_mean_time name: type: string description: The display name for the timezone. example: London (Greenwich Mean Time) [+01:00] get_api_response: type: object properties: code: type: string description: Response code. example: OK message: type: string description: Response message. example: success_response api: type: object properties: id: type: string description: Unique ID of the API. example: 7ccd126599aa422a771abcb341596881 name: type: string description: The API’s name. example: Example API audience: type: string description: >- A unique identifier for the API - commonly the URL. This value will be used as the `audience` parameter in authorization claims. example: https://api.example.com is_management_api: type: boolean description: Whether or not it is the Kinde management API. example: false applications: type: array items: type: object properties: id: type: string description: The Client ID of the application. example: 3b0b5c6c8fcc464fab397f4969b5f482 name: type: string description: The application's name. example: My M2M app type: type: string description: The application's type. enum: - Machine to machine (M2M) - Back-end web - Front-end and mobile example: Machine to machine (M2M) is_active: type: boolean description: >- Whether or not the application is authorized to access the API example: true nullable: true authorize_app_api_response: type: object properties: message: type: string example: API applications updated code: type: string example: API_APPLICATIONS_UPDATED applications_disconnected: type: array items: type: string applications_connected: type: array items: type: string example: d2db282d6214242b3b145c123f0c123 delete_api_response: type: object properties: message: type: string example: API successfully deleted code: type: string example: API_DELETED user: type: object properties: id: type: string description: Unique ID of the user in Kinde. provided_id: type: string description: External ID for user. preferred_email: type: string description: Default email address of the user in Kinde. username: type: string description: Primary username of the user in Kinde. last_name: type: string description: User's last name. first_name: type: string description: User's first name. is_suspended: type: boolean description: Whether the user is currently suspended or not. picture: type: string description: User's profile picture URL. total_sign_ins: type: integer description: Total number of user sign ins. nullable: true failed_sign_ins: type: integer description: Number of consecutive failed user sign ins. nullable: true last_signed_in: type: string description: Last sign in date in ISO 8601 format. nullable: true created_on: type: string description: Date of user creation in ISO 8601 format. nullable: true organizations: type: array description: Array of organizations a user belongs to. items: type: string identities: type: array description: Array of identities belonging to the user. items: type: object properties: type: type: string identity: type: string update_user_response: type: object properties: id: type: string description: Unique ID of the user in Kinde. given_name: type: string description: User's first name. family_name: type: string description: User's last name. email: type: string description: User's preferred email. is_suspended: type: boolean description: Whether the user is currently suspended or not. is_password_reset_requested: type: boolean description: Whether a password reset has been requested. picture: type: string description: User's profile picture URL. nullable: true users: type: array description: Array of users. items: $ref: '#/components/schemas/user' users_response: type: object properties: code: type: string description: Response code. message: type: string description: Response message. users: type: array items: type: object properties: id: type: string description: Unique ID of the user in Kinde. provided_id: type: string description: External ID for user. email: type: string description: Default email address of the user in Kinde. username: type: string description: Primary username of the user in Kinde. last_name: type: string description: User's last name. first_name: type: string description: User's first name. is_suspended: type: boolean description: Whether the user is currently suspended or not. picture: type: string description: User's profile picture URL. total_sign_ins: type: integer description: Total number of user sign ins. nullable: true failed_sign_ins: type: integer description: Number of consecutive failed user sign ins. nullable: true last_signed_in: type: string description: Last sign in date in ISO 8601 format. nullable: true created_on: type: string description: Date of user creation in ISO 8601 format. nullable: true organizations: type: array description: Array of organizations a user belongs to. items: type: string identities: type: array description: Array of identities belonging to the user. items: type: object properties: type: type: string identity: type: string next_token: type: string description: Pagination token. create_user_response: type: object properties: id: description: Unique ID of the user in Kinde. type: string created: description: True if the user was successfully created. type: boolean identities: type: array items: $ref: '#/components/schemas/user_identity' create_organization_response: type: object properties: message: type: string description: Response message. example: Success code: type: string description: Response code. example: OK organization: type: object properties: code: description: The organization's unique code. type: string example: org_1ccfb819462 user_identity: type: object properties: type: type: string description: The type of identity object created. result: type: object description: The result of the user creation operation. properties: created: type: boolean description: True if the user identity was successfully created. user_profile: type: object properties: id: type: string description: Unique ID of the user in Kinde. preferred_email: type: string description: Default email address of the user in Kinde. username: type: string description: Primary username of the user in Kinde. provided_id: type: string description: >- Value of the user's ID in a third-party system when the user is imported into Kinde. nullable: true last_name: type: string description: User's last name. first_name: type: string description: User's first name. picture: type: string description: URL that point's to the user's picture or avatar create_property_response: type: object properties: message: type: string code: type: string property: type: object properties: id: description: The property's ID. type: string create_identity_response: type: object properties: message: type: string code: type: string identity: type: object properties: id: description: The identity's ID. type: string get_identities_response: type: object properties: code: type: string description: Response code. message: type: string description: Response message. identities: type: array items: $ref: '#/components/schemas/identity' has_more: description: Whether more records exist. type: boolean get_properties_response: type: object properties: code: type: string description: Response code. message: type: string description: Response message. properties: type: array items: $ref: '#/components/schemas/property' has_more: description: Whether more records exist. type: boolean get_property_values_response: type: object properties: code: type: string description: Response code. message: type: string description: Response message. properties: type: array items: $ref: '#/components/schemas/property_value' next_token: description: Pagination token. type: string create_category_response: type: object properties: message: type: string code: type: string category: type: object properties: id: description: The category's ID. type: string get_categories_response: type: object properties: code: type: string description: Response code. message: type: string description: Response message. categories: type: array items: $ref: '#/components/schemas/category' has_more: description: Whether more records exist. type: boolean get_event_response: type: object properties: code: type: string description: Response code. message: type: string description: Response message. event: type: object properties: type: type: string source: type: string event_id: type: string timestamp: type: string description: Timestamp in ISO 8601 format. data: type: object description: Event specific data object. get_event_types_response: type: object properties: code: type: string description: Response code. message: type: string description: Response message. event_types: type: array items: $ref: '#/components/schemas/event_type' get_webhooks_response: type: object properties: code: type: string description: Response code. message: type: string description: Response message. webhooks: type: array items: $ref: '#/components/schemas/webhook' webhook: type: object properties: id: type: string name: type: string endpoint: type: string description: type: string event_types: type: array items: type: string created_on: type: string description: Created on date in ISO 8601 format. create_webhook_response: type: object properties: code: type: string description: Response code. message: type: string description: Response message. webhook: type: object properties: id: type: string endpoint: type: string update_webhook_response: type: object properties: message: type: string code: type: string webhook: type: object properties: id: type: string create_connection_response: type: object properties: message: type: string code: type: string connection: type: object properties: id: description: The connection's ID. type: string get_connections_response: type: object properties: code: type: string description: Response code. message: type: string description: Response message. connections: type: array items: $ref: '#/components/schemas/connection' has_more: description: Whether more records exist. type: boolean delete_webhook_response: type: object properties: code: type: string description: Response code. message: type: string description: Response message. event_type: type: object properties: id: type: string code: type: string name: type: string origin: type: string schema: type: object token_introspect: type: object properties: active: type: boolean description: Indicates the status of the token. aud: type: array description: Array of intended token recipients. items: type: string client_id: type: string description: Identifier for the requesting client. exp: type: string description: Token expiration timestamp. iat: type: string description: Token issuance timestamp. token_error_response: type: object properties: error: type: string description: Error. error_description: type: string description: The error description. user_profile_v2: type: object properties: id: type: string description: Unique ID of the user in Kinde (deprecated). sub: type: string description: Unique ID of the user in Kinde. provided_id: type: string description: >- Value of the user's ID in a third-party system when the user is imported into Kinde. nullable: true name: type: string description: User's first and last name separated by a space. given_name: type: string description: User's first name. family_name: type: string description: User's last name. updated_at: type: integer description: Date the user was last updated at (In Unix time). email: type: string description: User's email address if available. picture: type: string description: URL that point's to the user's picture or avatar organization_item_schema: type: object properties: code: type: string description: The unique identifier for the organization. example: org_1ccfb819462 name: type: string description: The organization's name. example: Acme Corp handle: type: string description: >- A unique handle for the organization - can be used for dynamic callback urls. example: acme_corp nullable: true is_default: type: boolean description: Whether the organization is the default organization. example: false external_id: type: string description: >- The organization's external identifier - commonly used when migrating from or mapping to other systems. example: some1234 nullable: true is_auto_membership_enabled: type: boolean example: true description: >- If users become members of this organization when the org code is supplied during authentication. get_organization_response: type: object properties: code: type: string description: The unique identifier for the organization. example: org_1ccfb819462 name: type: string description: The organization's name. example: Acme Corp handle: type: string description: >- A unique handle for the organization - can be used for dynamic callback urls. example: acme_corp nullable: true is_default: type: boolean description: Whether the organization is the default organization. example: false external_id: type: string description: >- The organization's external identifier - commonly used when migrating from or mapping to other systems. example: some1234 nullable: true is_auto_membership_enabled: type: boolean example: true description: >- If users become members of this organization when the org code is supplied during authentication. logo: type: string deprecated: true nullable: true link_color: type: object nullable: true properties: raw: type: string example: '#0056F1' hex: type: string example: '#0056F1' hsl: type: string example: hsl(220, 100%, 50%) background_color: nullable: true type: object properties: raw: type: string example: '#ffffff' hex: type: string example: '#ffffff' hsl: type: string example: hsl(0, 0%, 100%) button_color: nullable: true type: object properties: raw: type: string example: '#0056F1' hex: type: string example: '#0056F1' hsl: type: string example: hsl(220, 100%, 50%) button_text_color: nullable: true type: object properties: raw: type: string example: '#ffffff' hex: type: string example: '#ffffff' hsl: type: string example: hsl(0, 0%, 100%) link_color_dark: type: object nullable: true properties: raw: type: string example: '#0056F1' hex: type: string example: '#0056F1' hsl: type: string example: hsl(220, 100%, 50%) background_color_dark: type: object nullable: true properties: raw: type: string example: '#0056F1' hex: type: string example: '#0056F1' hsl: type: string example: hsl(220, 100%, 50%) button_text_color_dark: type: object nullable: true properties: raw: type: string example: '#0056F1' hex: type: string example: '#0056F1' hsl: type: string example: hsl(220, 100%, 50%) button_color_dark: type: object nullable: true properties: raw: type: string example: '#0056F1' hex: type: string example: '#0056F1' hsl: type: string example: hsl(220, 100%, 50%) is_allow_registrations: nullable: true type: boolean example: true deprecated: true description: Deprecated - Use 'is_auto_membership_enabled' instead organization_user: type: object properties: id: type: string email: type: string full_name: type: string last_name: type: string first_name: type: string picture: type: string roles: type: array items: type: string category: type: object properties: id: type: string name: type: string connection: type: object properties: id: type: string name: type: string display_name: type: string strategy: type: string environment_variable: type: object properties: id: description: The unique ID for the environment variable. type: string example: env_var_0192b1941f125645fa15bf28a662a0b3 key: type: string description: The name of the environment variable. example: MY_API_KEY value: type: string description: The value of the environment variable. example: some-secret nullable: true is_secret: type: boolean description: Whether the environment variable is sensitive. example: false created_on: type: string description: The date the environment variable was created. example: '2021-01-01T00:00:00Z' identity: type: object properties: id: type: string type: type: string is_confirmed: type: boolean created_on: type: string description: Date of user creation in ISO 8601 format. last_login_on: type: string description: Date of user creation in ISO 8601 format. total_logins: type: integer name: type: string property: type: object properties: id: type: string key: type: string name: type: string is_private: type: boolean description: type: string is_kinde_property: type: boolean property_value: type: object properties: id: type: string example: prop_0192b7e8b4f8ca08110d2b22059662a8 name: type: string example: Town description: type: string example: Where the entity is located nullable: true key: type: string example: kp_town value: type: string example: West-side Staines massive nullable: true role: type: object properties: id: type: string key: type: string name: type: string description: type: string subscribers_subscriber: type: object properties: id: type: string email: type: string full_name: type: string first_name: type: string last_name: type: string subscriber: type: object properties: id: type: string preferred_email: type: string first_name: type: string last_name: type: string organization_user_role: type: object properties: id: type: string key: type: string name: type: string organization_user_role_permissions: type: object properties: id: type: string role: type: string permissions: type: object properties: key: type: string organization_user_permission: type: object properties: id: type: string key: type: string name: type: string description: type: string roles: type: array items: type: object properties: id: type: string key: type: string organization_users: type: array items: $ref: '#/components/schemas/organization_user' get_subscriber_response: type: object properties: code: type: string description: Response code. message: type: string description: Response message. subscribers: type: array items: $ref: '#/components/schemas/subscriber' get_subscribers_response: type: object properties: code: type: string description: Response code. message: type: string description: Response message. subscribers: type: array items: $ref: '#/components/schemas/subscribers_subscriber' next_token: description: Pagination token. type: string get_roles_response: type: object properties: code: type: string description: Response code. message: type: string description: Response message. roles: type: array items: $ref: '#/components/schemas/roles' next_token: description: Pagination token. type: string get_role_response: type: object properties: code: type: string description: Response code. message: type: string description: Response message. role: type: object properties: id: type: string description: The role's ID. example: 01929904-316d-bb2c-069f-99dfea4ac394 key: type: string description: The role identifier to use in code. example: admin name: type: string description: The role's name. example: Administrator description: type: string description: The role's description. example: Full access to all resources. is_default_role: type: boolean description: Whether the role is the default role. example: false create_roles_response: type: object properties: code: type: string description: Response code. message: type: string description: Response message. role: type: object properties: id: type: string description: The role's ID. get_organizations_response: type: object properties: code: type: string description: Response code. example: OK message: type: string description: Response message. example: Success organizations: type: array items: $ref: '#/components/schemas/organization_item_schema' next_token: description: Pagination token. type: string example: Mjo5Om1hbWVfYZNj get_organization_users_response: type: object properties: code: type: string description: Response code. message: type: string description: Response message. organization_users: type: array items: $ref: '#/components/schemas/organization_user' next_token: type: string description: Pagination token. get_organizations_user_roles_response: type: object properties: code: type: string description: Response code. message: type: string description: Response message. roles: type: array items: $ref: '#/components/schemas/organization_user_role' next_token: type: string description: Pagination token. get_organizations_user_permissions_response: type: object properties: code: type: string description: Response code. message: type: string description: Response message. permissions: type: array items: $ref: '#/components/schemas/organization_user_permission' get_organization_feature_flags_response: type: object properties: code: type: string description: Response code. message: type: string description: Response message. feature_flags: type: object description: The environment's feature flag settings. additionalProperties: type: object properties: type: type: string enum: - str - int - bool value: type: string get_environment_feature_flags_response: type: object properties: code: type: string description: Response code. message: type: string description: Response message. feature_flags: type: object description: The environment's feature flag settings. additionalProperties: type: object properties: type: type: string enum: - str - int - bool value: type: string next_token: type: string description: Pagination token. add_organization_users_response: type: object properties: code: type: string description: Response code. message: type: string description: Response message. users_added: type: array items: type: string update_role_permissions_response: type: object properties: code: type: string message: type: string permissions_added: type: array items: type: string permissions_removed: type: array items: type: string update_organization_users_response: type: object properties: message: type: string users_added: type: array items: type: string users_updated: type: array items: type: string users_removed: type: array items: type: string connected_apps_auth_url: type: object properties: url: type: string description: >- A URL that is used to authenticate an end-user against a connected app. session_id: type: string description: A unique identifier for the login session. create_subscriber_success_response: type: object properties: subscriber: type: object properties: subscriber_id: type: string description: A unique identifier for the subscriber. connected_apps_access_token: type: object properties: access_token: type: string description: The access token to access a third-party provider. access_token_expiry: type: string description: The date and time that the access token expires. api_result: type: object properties: result: type: string description: The result of the api operation. create_application_response: type: object properties: code: type: string description: Response code. message: type: string description: Response message. application: type: object properties: id: description: The application's identifier. type: string client_id: description: The application's client ID. type: string client_secret: description: The application's client secret. type: string get_application_response: type: object properties: code: type: string description: Response code. message: type: string description: Response message. application: type: object properties: id: description: The application's identifier. type: string name: description: The application's name. type: string type: description: The application's type. type: string client_id: description: The application's client ID. type: string client_secret: description: The application's client secret. type: string login_uri: description: The default login route for resolving session issues. type: string homepage_uri: description: The homepage link to your application. type: string applications: type: object properties: id: type: string name: type: string type: type: string get_applications_response: type: object properties: code: type: string description: Response code. message: type: string description: Response message. applications: type: array items: $ref: '#/components/schemas/applications' next_token: description: Pagination token. type: string redirect_callback_urls: type: object properties: redirect_urls: type: array description: An application's redirect URLs. items: type: string get_redirect_callback_urls_response: type: object properties: redirect_urls: description: An application's redirect callback URLs. type: array items: $ref: '#/components/schemas/redirect_callback_urls' logout_redirect_urls: type: object properties: logout_urls: type: array description: An application's logout URLs. items: type: string code: type: string description: Response code. example: OK message: type: string description: Response message. example: Success get_permissions_response: type: object properties: code: type: string description: Response code. message: type: string description: Response message. permissions: type: array items: $ref: '#/components/schemas/permissions' next_token: type: string description: Pagination token. permissions: type: object properties: id: type: string description: The permission's ID. key: type: string description: The permission identifier to use in code. name: type: string description: The permission's name. description: type: string description: The permission's description. roles: type: object properties: id: type: string description: The role's ID. key: type: string description: The role identifier to use in code. name: type: string description: The role's name. description: type: string description: The role's description. nullable: true is_default_role: type: boolean description: Whether the role is the default role. roles_permission_response: type: array items: type: object properties: id: type: string key: type: string name: type: string description: type: string securitySchemes: kindeBearerAuth: description: > Accessing the API requires obtaining an access token when login in through Kinde. However, management functions (for e.g. user management) requires an access token obtained using the client_credentials flow. type: http scheme: bearer bearerFormat: JWT ManagementAPI: type: oauth2 flows: clientCredentials: tokenUrl: https://.kinde.com/oauth2/token scopes: create:apis: Create Apis create:application_connections: Create Application Connections create:application_logout_uris: Create Application Logout Uris create:application_redirect_uris: Create Application Redirect Uris create:applications: Create Applications create:billing_entitlement_change_requests: Create Billing Entitlement Change Requests create:billing_payment_methods: Create Billing Payment Methods create:connected_apps: Create Connected Apps create:connections: Create Connections create:environment_variables: Create Environment Variables create:feature_flags: Create Feature Flags create:organization_connections: Create Organization Connections create:organization_user_permissions: Create Organization User Permissions create:organization_user_roles: Create Organization User Roles create:organization_users: Create Organization Users create:organizations: Create Organizations create:permissions: Create Permissions create:properties: Create Properties create:property_categories: Create Property Categories create:roles: Create Roles create:subscribers: Create Subscribers create:user_identities: Create User Identities create:users: Create Users create:webhooks: Create Webhooks delete:apis: Delete Apis delete:application_connections: Delete Application Connections delete:application_logout_uris: Delete Application Logout Uris delete:application_redirect_uris: Delete Application Redirect Uris delete:applications: Delete Applications delete:billing_payment_methods: Delete Billing Payment Methods delete:connections: Delete Connections delete:environment_feature_flags: Delete Environment Feature Flags delete:environment_variables: Delete Environment Variables delete:feature_flags: Delete Feature Flags delete:identities: Delete Identities delete:organization_connections: Delete Organization Connections delete:organization_feature_flags: Delete Organization Feature Flags delete:organization_handles: Delete Organization Handle delete:organization_user_permissions: Delete Organization User Permissions delete:organization_user_roles: Delete Organization User Roles delete:organization_users: Delete Organization Users delete:organizations: Delete Organizations delete:permissions: Delete Permissions delete:properties: Delete Properties delete:role_permissions: Delete Role Permissions delete:roles: Delete Roles delete:users: Delete Users delete:webhooks: Delete Webhooks read:apis: Read Apis read:application_connections: Read Application Connections read:application_logout_uris: Read Application Logout Uris read:applications: Read Applications read:applications_redirect_uris: Read Applications Redirect Uris read:billing_payment_methods: Read Billing Payment Methods read:businesses: Read Businesses read:connected_apps: Read Connected Apps read:connections: Read Connections read:environment_feature_flags: Read Environment Feature Flags read:environment_variables: Read Environment Variables read:event_types: Read Event Types read:events: Read Events read:identities: Read Identities read:industries: Read Industries read:organization_connections: Read Organization Connections read:organization_feature_flags: Read Organization Feature Flags read:organization_properties: Read Organization Properties read:organization_user_permissions: Read Organization User Permissions read:organization_user_roles: Read Organization User Roles read:organization_users: Read Organization Users read:organizations: Read Organizations read:permissions: Read Permissions read:properties: Read Properties read:property_categories: Read Property Categories read:role_permissions: Read Role Permissions read:roles: Read Roles read:subscribers: Read Subscribers read:timezones: Read Timezones read:user_feature_flags: Read User Feature Flags read:user_identities: Read User Identities read:user_properties: Read User Properties read:users: Read Users read:webhooks: Read Webhooks update:apis: Update Apis update:application_logout_uris: Update Application Logout Uris update:application_redirect_uris: Update Application Redirect Uris update:applications: Update Applications update:businesses: Update Businesses update:connections: Update Connections update:environment_feature_flags: Update Environment Feature Flags update:environment_variables: Update Environment Variables update:feature_flags: Update Feature Flags update:identities: Update Identities update:organization_feature_flags: Update Organization Feature Flags update:organization_properties: Update Organization Properties update:organization_users: Update Organization Users update:organizations: Update Organizations update:permissions: Update Permissions update:properties: Update Properties update:property_categories: Update Property Categories update:role_permissions: Update Role Permissions update:roles: Update Roles update:user_feature_flags: Update User Feature Flags update:user_passwords: Update User Passwords update:user_properties: Update User Properties update:user_refresh_claims: Update User Refresh Claims update:users: Update Users update:webhooks: Update Webhooks x-tagGroups: - name: Kinde Management API tags: - OAuth - name: APIs API tags: - APIs - Connected Apps - name: Applications API tags: - Applications - name: Business API tags: - Business - Industries - Timezones - name: Callbacks API tags: - Callbacks - name: Connections API tags: - Connections - name: Environment API tags: - Environments - name: Environment variables API tags: - Environment variables - name: Feature flags API tags: - Feature Flags - name: Identities API tags: - Identities - name: Organizations API tags: - Organizations - name: Permissions API tags: - Permissions - name: Properties API tags: - Properties - name: Property Categories API tags: - Property Categories - name: Roles API tags: - Roles - name: Subscribers API tags: - Subscribers - name: Users API tags: - Users - name: Webhooks API tags: - Webhooks