{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://zieapi.vercel.app"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/security:clerk/get-public-interstitial":{"get":{"operationId":"security_clerk_get_public_interstitial","summary":"Returns the markup for the interstitial page","description":"GET /public/interstitial","tags":["security"],"parameters":[{"name":"frontendApi","in":"query","required":false,"description":"Please use `frontend_api` instead","schema":{"type":"string","description":"Please use `frontend_api` instead"}},{"name":"frontend_api","in":"query","required":false,"description":"The Frontend API key of your instance","schema":{"type":"string","description":"The Frontend API key of your instance"}},{"name":"publishable_key","in":"query","required":false,"description":"The publishable key of your instance","schema":{"type":"string","description":"The publishable key of your instance"}},{"name":"proxy_url","in":"query","required":false,"description":"The proxy URL of your instance","schema":{"type":"string","description":"The proxy URL of your instance"}},{"name":"domain","in":"query","required":false,"description":"The domain of your instance","schema":{"type":"string","description":"The domain of your instance"}},{"name":"sign_in_url","in":"query","required":false,"description":"The sign in URL of your instance","schema":{"type":"string","description":"The sign in URL of your instance"}},{"name":"use_domain_for_script","in":"query","required":false,"description":"Whether to use the domain for the script URL","schema":{"type":"boolean","description":"Whether to use the domain for the script URL"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/security:clerk/get-jwks":{"get":{"operationId":"security_clerk_get_jwks","summary":"Retrieve the JSON Web Key Set of the instance","description":"GET /jwks","tags":["security"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/security:clerk/verify-client":{"post":{"operationId":"security_clerk_verify_client","summary":"Verify a client","description":"POST /clients/verify","tags":["security"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:clerk/get-client":{"get":{"operationId":"security_clerk_get_client","summary":"Get a client","description":"GET /clients/{client_id}","tags":["security"],"parameters":[{"name":"client_id","in":"query","required":true,"description":"Client ID.","schema":{"type":"string","description":"Client ID."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/security:clerk/create-email-address":{"post":{"operationId":"security_clerk_create_email_address","summary":"Create an email address","description":"POST /email_addresses","tags":["security"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:clerk/get-email-address":{"get":{"operationId":"security_clerk_get_email_address","summary":"Retrieve an email address","description":"GET /email_addresses/{email_address_id}","tags":["security"],"parameters":[{"name":"email_address_id","in":"query","required":true,"description":"The ID of the email address to retrieve","schema":{"type":"string","description":"The ID of the email address to retrieve"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/security:clerk/update-email-address":{"post":{"operationId":"security_clerk_update_email_address","summary":"Update an email address","description":"PATCH /email_addresses/{email_address_id}","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["email_address_id"],"properties":{"email_address_id":{"type":"string","description":"The ID of the email address to update"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:clerk/delete-email-address":{"post":{"operationId":"security_clerk_delete_email_address","summary":"Delete an email address","description":"DELETE /email_addresses/{email_address_id}","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["email_address_id"],"properties":{"email_address_id":{"type":"string","description":"The ID of the email address to delete"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:clerk/prepare-email-address-verification":{"post":{"operationId":"security_clerk_prepare_email_address_verification","summary":"Send a verification code to an email address","description":"POST /email_addresses/{email_address_id}/prepare_verification","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["email_address_id"],"properties":{"email_address_id":{"type":"string","description":"The ID of the email address to send the verification code to"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:clerk/attempt-email-address-verification":{"post":{"operationId":"security_clerk_attempt_email_address_verification","summary":"Verify a code sent to an email address","description":"POST /email_addresses/{email_address_id}/attempt_verification","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["email_address_id","body"],"properties":{"email_address_id":{"type":"string","description":"The ID of the email address whose code is being verified"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:clerk/replace-user-email-address":{"post":{"operationId":"security_clerk_replace_user_email_address","summary":"Replace a user's email address","description":"PUT /users/{user_id}/email_address","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["user_id","body"],"properties":{"user_id":{"type":"string","description":"The ID of the user whose email address to replace"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:clerk/create-phone-number":{"post":{"operationId":"security_clerk_create_phone_number","summary":"Create a phone number","description":"POST /phone_numbers","tags":["security"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:clerk/get-phone-number":{"get":{"operationId":"security_clerk_get_phone_number","summary":"Retrieve a phone number","description":"GET /phone_numbers/{phone_number_id}","tags":["security"],"parameters":[{"name":"phone_number_id","in":"query","required":true,"description":"The ID of the phone number to retrieve","schema":{"type":"string","description":"The ID of the phone number to retrieve"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/security:clerk/update-phone-number":{"post":{"operationId":"security_clerk_update_phone_number","summary":"Update a phone number","description":"PATCH /phone_numbers/{phone_number_id}","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["phone_number_id"],"properties":{"phone_number_id":{"type":"string","description":"The ID of the phone number to update"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:clerk/delete-phone-number":{"post":{"operationId":"security_clerk_delete_phone_number","summary":"Delete a phone number","description":"DELETE /phone_numbers/{phone_number_id}","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["phone_number_id"],"properties":{"phone_number_id":{"type":"string","description":"The ID of the phone number to delete"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:clerk/prepare-phone-number-verification":{"post":{"operationId":"security_clerk_prepare_phone_number_verification","summary":"Send a verification code to a phone number","description":"POST /phone_numbers/{phone_number_id}/prepare_verification","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["phone_number_id"],"properties":{"phone_number_id":{"type":"string","description":"The ID of the phone number to send the verification code to"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:clerk/attempt-phone-number-verification":{"post":{"operationId":"security_clerk_attempt_phone_number_verification","summary":"Verify a code sent to a phone number","description":"POST /phone_numbers/{phone_number_id}/attempt_verification","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["phone_number_id","body"],"properties":{"phone_number_id":{"type":"string","description":"The ID of the phone number whose code is being verified"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:clerk/replace-user-phone-number":{"post":{"operationId":"security_clerk_replace_user_phone_number","summary":"Replace a user's phone number","description":"PUT /users/{user_id}/phone_number","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["user_id","body"],"properties":{"user_id":{"type":"string","description":"The ID of the user whose phone number to replace"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:clerk/get-session-list":{"get":{"operationId":"security_clerk_get_session_list","summary":"List all sessions","description":"GET /sessions","tags":["security"],"parameters":[{"name":"client_id","in":"query","required":false,"description":"List sessions for the given client","schema":{"type":"string","description":"List sessions for the given client"}},{"name":"user_id","in":"query","required":false,"description":"List sessions for the given user","schema":{"type":"string","description":"List sessions for the given user"}},{"name":"status","in":"query","required":false,"description":"Filter sessions by the provided status","schema":{"type":"string","enum":["abandoned","active","ended","expired","removed","replaced","revoked"],"description":"Filter sessions by the provided status"}},{"name":"paginated","in":"query","required":false,"description":"Whether to paginate the results. If true, the results will be paginated. If false, the results will not be paginated.","schema":{"type":"boolean","description":"Whether to paginate the results. If true, the results will be paginated. If false, the results will not be paginated."}},{"name":"limit","in":"query","required":false,"description":"Applies a limit to the number of results returned. Can be used for paginating the results together with `offset`.","schema":{"type":"integer","default":10,"description":"Applies a limit to the number of results returned. Can be used for paginating the results together with `offset`."}},{"name":"offset","in":"query","required":false,"description":"Skip the first `offset` results when paginating. Needs to be an integer greater or equal to zero. To be used in conjunction with `limit`.","schema":{"type":"integer","default":0,"description":"Skip the first `offset` results when paginating. Needs to be an integer greater or equal to zero. To be used in conjunction with `limit`."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/security:clerk/create-session":{"post":{"operationId":"security_clerk_create_session","summary":"Create a new active session","description":"POST /sessions","tags":["security"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:clerk/get-session":{"get":{"operationId":"security_clerk_get_session","summary":"Retrieve a session","description":"GET /sessions/{session_id}","tags":["security"],"parameters":[{"name":"session_id","in":"query","required":true,"description":"The ID of the session","schema":{"type":"string","description":"The ID of the session"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/security:clerk/refresh-session":{"post":{"operationId":"security_clerk_refresh_session","summary":"Refresh a session","description":"POST /sessions/{session_id}/refresh","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["session_id"],"properties":{"session_id":{"type":"string","description":"The ID of the session"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:clerk/get-reverification":{"get":{"operationId":"security_clerk_get_reverification","summary":"Retrieve a reverification","description":"GET /sessions/{session_id}/reverifications/{reverification_id}","tags":["security"],"parameters":[{"name":"session_id","in":"query","required":true,"description":"The ID of the session the reverification belongs to","schema":{"type":"string","description":"The ID of the session the reverification belongs to"}},{"name":"reverification_id","in":"query","required":true,"description":"The ID of the reverification","schema":{"type":"string","description":"The ID of the reverification"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/security:clerk/revoke-session":{"post":{"operationId":"security_clerk_revoke_session","summary":"Revoke a session","description":"POST /sessions/{session_id}/revoke","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["session_id"],"properties":{"session_id":{"type":"string","description":"The ID of the session"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:clerk/create-session-token":{"post":{"operationId":"security_clerk_create_session_token","summary":"Create a session token","description":"POST /sessions/{session_id}/tokens","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["session_id"],"properties":{"session_id":{"type":"string","description":"The ID of the session"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:clerk/create-session-token-from-template":{"post":{"operationId":"security_clerk_create_session_token_from_template","summary":"Create a session token from a JWT template","description":"POST /sessions/{session_id}/tokens/{template_name}","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["session_id","template_name"],"properties":{"session_id":{"type":"string","description":"The ID of the session"},"template_name":{"type":"string","description":"The name of the JWT template defined in your instance (e.g. `custom_hasura`)."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:clerk/get-user-list":{"get":{"operationId":"security_clerk_get_user_list","summary":"List all users","description":"GET /users","tags":["security"],"parameters":[{"name":"email_address","in":"query","required":false,"description":"Returns users with the specified email addresses. Accepts up to 100 email addresses. Any email addresses not found are ignored.","schema":{"type":"array","description":"Returns users with the specified email addresses. Accepts up to 100 email addresses. Any email addresses not found are ignored."}},{"name":"phone_number","in":"query","required":false,"description":"Returns users with the specified phone numbers. Accepts up to 100 phone numbers. Any phone numbers not found are ignored.","schema":{"type":"array","description":"Returns users with the specified phone numbers. Accepts up to 100 phone numbers. Any phone numbers not found are ignored."}},{"name":"external_id","in":"query","required":false,"description":"Returns users with the specified external IDs. For each external ID, the `+` and `-` can be prepended to the ID, which denote whether the…","schema":{"type":"array","description":"Returns users with the specified external IDs. For each external ID, the `+` and `-` can be prepended to the ID, which denote whether the…"}},{"name":"username","in":"query","required":false,"description":"Returns users with the specified usernames. Accepts up to 100 usernames. Any usernames not found are ignored.","schema":{"type":"array","description":"Returns users with the specified usernames. Accepts up to 100 usernames. Any usernames not found are ignored."}},{"name":"web3_wallet","in":"query","required":false,"description":"Returns users with the specified web3 wallet addresses. Accepts up to 100 web3 wallet addresses. Any web3 wallet addresses not found are…","schema":{"type":"array","description":"Returns users with the specified web3 wallet addresses. Accepts up to 100 web3 wallet addresses. Any web3 wallet addresses not found are…"}},{"name":"user_id","in":"query","required":false,"description":"Returns users with the user IDs specified. For each user ID, the `+` and `-` can be prepended to the ID, which denote whether the…","schema":{"type":"array","description":"Returns users with the user IDs specified. For each user ID, the `+` and `-` can be prepended to the ID, which denote whether the…"}},{"name":"organization_id","in":"query","required":false,"description":"Returns users that have memberships to the given organizations. For each organization ID, the `+` and `-` can be prepended to the ID,…","schema":{"type":"array","description":"Returns users that have memberships to the given organizations. For each organization ID, the `+` and `-` can be prepended to the ID,…"}},{"name":"query","in":"query","required":false,"description":"Returns users that match the given query. For possible matches, we check the email addresses, phone numbers, usernames, web3 wallets, user…","schema":{"type":"string","description":"Returns users that match the given query. For possible matches, we check the email addresses, phone numbers, usernames, web3 wallets, user…"}},{"name":"email_address_query","in":"query","required":false,"description":"Returns users with emails that match the given query, via case-insensitive partial match. For example, `email_address_query=ello` will…","schema":{"type":"string","description":"Returns users with emails that match the given query, via case-insensitive partial match. For example, `email_address_query=ello` will…"}},{"name":"phone_number_query","in":"query","required":false,"description":"Returns users with phone numbers that match the given query, via case-insensitive partial match. For example, `phone_number_query=555`…","schema":{"type":"string","description":"Returns users with phone numbers that match the given query, via case-insensitive partial match. For example, `phone_number_query=555`…"}},{"name":"username_query","in":"query","required":false,"description":"Returns users with usernames that match the given query, via case-insensitive partial match. For example, `username_query=CoolUser` will…","schema":{"type":"string","description":"Returns users with usernames that match the given query, via case-insensitive partial match. For example, `username_query=CoolUser` will…"}},{"name":"name_query","in":"query","required":false,"description":"Returns users with names that match the given query, via case-insensitive partial match.","schema":{"type":"string","description":"Returns users with names that match the given query, via case-insensitive partial match."}},{"name":"banned","in":"query","required":false,"description":"Returns users which are either banned (`banned=true`) or not banned (`banned=false`).","schema":{"type":"boolean","description":"Returns users which are either banned (`banned=true`) or not banned (`banned=false`)."}},{"name":"last_active_at_before","in":"query","required":false,"description":"Returns users whose last session activity was before the given date (with millisecond precision). Example: use 1700690400000 to retrieve…","schema":{"type":"integer","description":"Returns users whose last session activity was before the given date (with millisecond precision). Example: use 1700690400000 to retrieve…"},"example":1700690400000},{"name":"last_active_at_after","in":"query","required":false,"description":"Returns users whose last session activity was after the given date (with millisecond precision). Example: use 1700690400000 to retrieve…","schema":{"type":"integer","description":"Returns users whose last session activity was after the given date (with millisecond precision). Example: use 1700690400000 to retrieve…"},"example":1700690400000},{"name":"last_active_at_since","in":"query","required":false,"description":"Returns users that had session activity since the given date. Example: use 1700690400000 to retrieve users that had session activity from…","schema":{"type":"integer","description":"Returns users that had session activity since the given date. Example: use 1700690400000 to retrieve users that had session activity from…"},"example":1700690400000},{"name":"created_at_before","in":"query","required":false,"description":"Returns users who have been created before the given date (with millisecond precision). Example: use 1730160000000 to retrieve users who…","schema":{"type":"integer","description":"Returns users who have been created before the given date (with millisecond precision). Example: use 1730160000000 to retrieve users who…"},"example":1730160000000},{"name":"created_at_after","in":"query","required":false,"description":"Returns users who have been created after the given date (with millisecond precision). Example: use 1730160000000 to retrieve users who…","schema":{"type":"integer","description":"Returns users who have been created after the given date (with millisecond precision). Example: use 1730160000000 to retrieve users who…"},"example":1730160000000},{"name":"last_sign_in_at_before","in":"query","required":false,"description":"Returns users whose last sign-in was before the given date (with millisecond precision). Example: use 1700690400000 to retrieve users…","schema":{"type":"integer","description":"Returns users whose last sign-in was before the given date (with millisecond precision). Example: use 1700690400000 to retrieve users…"},"example":1700690400000},{"name":"last_sign_in_at_after","in":"query","required":false,"description":"Returns users whose last sign-in was after the given date (with millisecond precision). Example: use 1700690400000 to retrieve users whose…","schema":{"type":"integer","description":"Returns users whose last sign-in was after the given date (with millisecond precision). Example: use 1700690400000 to retrieve users whose…"},"example":1700690400000},{"name":"provider","in":"query","required":false,"description":"Returns users with external accounts for the specified OAuth provider. Must be used in combination with the `provider_user_id` parameter.…","schema":{"type":"string","description":"Returns users with external accounts for the specified OAuth provider. Must be used in combination with the `provider_user_id` parameter.…"}},{"name":"provider_user_id","in":"query","required":false,"description":"Returns users with the specified provider user IDs for a specific provider. Must be used in combination with the `provider` parameter. For…","schema":{"type":"array","description":"Returns users with the specified provider user IDs for a specific provider. Must be used in combination with the `provider` parameter. For…"}},{"name":"limit","in":"query","required":false,"description":"Applies a limit to the number of results returned. Can be used for paginating the results together with `offset`.","schema":{"type":"integer","default":10,"description":"Applies a limit to the number of results returned. Can be used for paginating the results together with `offset`."}},{"name":"offset","in":"query","required":false,"description":"Skip the first `offset` results when paginating. Needs to be an integer greater or equal to zero. To be used in conjunction with `limit`.","schema":{"type":"integer","default":0,"description":"Skip the first `offset` results when paginating. Needs to be an integer greater or equal to zero. To be used in conjunction with `limit`."}},{"name":"starting_after","in":"query","required":false,"description":"A cursor for pagination: the `id` of the last user on the previous page. Returns the users that follow it. **Requires ordering by…","schema":{"type":"string","description":"A cursor for pagination: the `id` of the last user on the previous page. Returns the users that follow it. **Requires ordering by…"}},{"name":"order_by","in":"query","required":false,"description":"Allows to return users in a particular order. At the moment, you can order the returned users by their…","schema":{"type":"string","default":"-created_at","description":"Allows to return users in a particular order. At the moment, you can order the returned users by their…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/security:clerk/create-user":{"post":{"operationId":"security_clerk_create_user","summary":"Create a new user","description":"POST /users","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:clerk/get-users-count":{"get":{"operationId":"security_clerk_get_users_count","summary":"Count users","description":"GET /users/count","tags":["security"],"parameters":[{"name":"email_address","in":"query","required":false,"description":"Counts users with the specified email addresses. Accepts up to 100 email addresses. Any email addresses not found are ignored.","schema":{"type":"array","description":"Counts users with the specified email addresses. Accepts up to 100 email addresses. Any email addresses not found are ignored."}},{"name":"phone_number","in":"query","required":false,"description":"Counts users with the specified phone numbers. Accepts up to 100 phone numbers. Any phone numbers not found are ignored.","schema":{"type":"array","description":"Counts users with the specified phone numbers. Accepts up to 100 phone numbers. Any phone numbers not found are ignored."}},{"name":"external_id","in":"query","required":false,"description":"Counts users with the specified external IDs. Accepts up to 100 external IDs. Any external IDs not found are ignored.","schema":{"type":"array","description":"Counts users with the specified external IDs. Accepts up to 100 external IDs. Any external IDs not found are ignored."}},{"name":"username","in":"query","required":false,"description":"Counts users with the specified usernames. Accepts up to 100 usernames. Any usernames not found are ignored.","schema":{"type":"array","description":"Counts users with the specified usernames. Accepts up to 100 usernames. Any usernames not found are ignored."}},{"name":"web3_wallet","in":"query","required":false,"description":"Counts users with the specified web3 wallet addresses. Accepts up to 100 web3 wallet addresses. Any web3 wallet addresses not found are…","schema":{"type":"array","description":"Counts users with the specified web3 wallet addresses. Accepts up to 100 web3 wallet addresses. Any web3 wallet addresses not found are…"}},{"name":"user_id","in":"query","required":false,"description":"Counts users with the user IDs specified. Accepts up to 100 user IDs. Any user IDs not found are ignored.","schema":{"type":"array","description":"Counts users with the user IDs specified. Accepts up to 100 user IDs. Any user IDs not found are ignored."}},{"name":"organization_id","in":"query","required":false,"description":"Returns users that have memberships to the given organizations. For each organization ID, the `+` and `-` can be prepended to the ID,…","schema":{"type":"array","description":"Returns users that have memberships to the given organizations. For each organization ID, the `+` and `-` can be prepended to the ID,…"}},{"name":"query","in":"query","required":false,"description":"Counts users that match the given query. For possible matches, we check the email addresses, phone numbers, usernames, web3 wallets, user…","schema":{"type":"string","description":"Counts users that match the given query. For possible matches, we check the email addresses, phone numbers, usernames, web3 wallets, user…"}},{"name":"email_address_query","in":"query","required":false,"description":"Counts users with emails that match the given query, via case-insensitive partial match. For example, `email_address_query=ello` will…","schema":{"type":"string","description":"Counts users with emails that match the given query, via case-insensitive partial match. For example, `email_address_query=ello` will…"}},{"name":"phone_number_query","in":"query","required":false,"description":"Counts users with phone numbers that match the given query, via case-insensitive partial match. For example, `phone_number_query=555` will…","schema":{"type":"string","description":"Counts users with phone numbers that match the given query, via case-insensitive partial match. For example, `phone_number_query=555` will…"}},{"name":"username_query","in":"query","required":false,"description":"Counts users with usernames that match the given query, via case-insensitive partial match. For example, `username_query=CoolUser` will…","schema":{"type":"string","description":"Counts users with usernames that match the given query, via case-insensitive partial match. For example, `username_query=CoolUser` will…"}},{"name":"name_query","in":"query","required":false,"description":"Returns users with names that match the given query, via case-insensitive partial match.","schema":{"type":"string","description":"Returns users with names that match the given query, via case-insensitive partial match."}},{"name":"banned","in":"query","required":false,"description":"Counts users which are either banned (`banned=true`) or not banned (`banned=false`).","schema":{"type":"boolean","description":"Counts users which are either banned (`banned=true`) or not banned (`banned=false`)."}},{"name":"last_active_at_before","in":"query","required":false,"description":"Returns users whose last session activity was before the given date (with millisecond precision). Example: use 1700690400000 to retrieve…","schema":{"type":"integer","description":"Returns users whose last session activity was before the given date (with millisecond precision). Example: use 1700690400000 to retrieve…"},"example":1700690400000},{"name":"last_active_at_after","in":"query","required":false,"description":"Returns users whose last session activity was after the given date (with millisecond precision). Example: use 1700690400000 to retrieve…","schema":{"type":"integer","description":"Returns users whose last session activity was after the given date (with millisecond precision). Example: use 1700690400000 to retrieve…"},"example":1700690400000},{"name":"last_active_at_since","in":"query","required":false,"description":"Returns users that had session activity since the given date. Example: use 1700690400000 to retrieve users that had session activity from…","schema":{"type":"integer","description":"Returns users that had session activity since the given date. Example: use 1700690400000 to retrieve users that had session activity from…"},"example":1700690400000},{"name":"created_at_before","in":"query","required":false,"description":"Returns users who have been created before the given date (with millisecond precision). Example: use 1730160000000 to retrieve users who…","schema":{"type":"integer","description":"Returns users who have been created before the given date (with millisecond precision). Example: use 1730160000000 to retrieve users who…"},"example":1730160000000},{"name":"created_at_after","in":"query","required":false,"description":"Returns users who have been created after the given date (with millisecond precision). Example: use 1730160000000 to retrieve users who…","schema":{"type":"integer","description":"Returns users who have been created after the given date (with millisecond precision). Example: use 1730160000000 to retrieve users who…"},"example":1730160000000},{"name":"last_sign_in_at_before","in":"query","required":false,"description":"Counts users whose last sign-in was before the given date (with millisecond precision). Example: use 1700690400000 to count users whose…","schema":{"type":"integer","description":"Counts users whose last sign-in was before the given date (with millisecond precision). Example: use 1700690400000 to count users whose…"},"example":1700690400000},{"name":"last_sign_in_at_after","in":"query","required":false,"description":"Counts users whose last sign-in was after the given date (with millisecond precision). Example: use 1700690400000 to count users whose…","schema":{"type":"integer","description":"Counts users whose last sign-in was after the given date (with millisecond precision). Example: use 1700690400000 to count users whose…"},"example":1700690400000},{"name":"provider","in":"query","required":false,"description":"Counts users with external accounts for the specified OAuth provider. Must be used in combination with the `provider_user_id` parameter.…","schema":{"type":"string","description":"Counts users with external accounts for the specified OAuth provider. Must be used in combination with the `provider_user_id` parameter.…"}},{"name":"provider_user_id","in":"query","required":false,"description":"Counts users with the specified provider user IDs for a specific provider. Must be used in combination with the `provider` parameter. For…","schema":{"type":"array","description":"Counts users with the specified provider user IDs for a specific provider. Must be used in combination with the `provider` parameter. For…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/security:clerk/get-user":{"get":{"operationId":"security_clerk_get_user","summary":"Retrieve a user","description":"GET /users/{user_id}","tags":["security"],"parameters":[{"name":"user_id","in":"query","required":true,"description":"The ID of the user to retrieve","schema":{"type":"string","description":"The ID of the user to retrieve"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/security:clerk/update-user":{"post":{"operationId":"security_clerk_update_user","summary":"Update a user","description":"PATCH /users/{user_id}","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["user_id","body"],"properties":{"user_id":{"type":"string","description":"The ID of the user to update"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:clerk/delete-user":{"post":{"operationId":"security_clerk_delete_user","summary":"Delete a user","description":"DELETE /users/{user_id}","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["user_id"],"properties":{"user_id":{"type":"string","description":"The ID of the user to delete"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:clerk/ban-user":{"post":{"operationId":"security_clerk_ban_user","summary":"Ban a user","description":"POST /users/{user_id}/ban","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["user_id"],"properties":{"user_id":{"type":"string","description":"The ID of the user to ban"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:clerk/unban-user":{"post":{"operationId":"security_clerk_unban_user","summary":"Unban a user","description":"POST /users/{user_id}/unban","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["user_id"],"properties":{"user_id":{"type":"string","description":"The ID of the user to unban"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:clerk/users-ban":{"post":{"operationId":"security_clerk_users_ban","summary":"Ban multiple users","description":"POST /users/ban","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:clerk/users-unban":{"post":{"operationId":"security_clerk_users_unban","summary":"Unban multiple users","description":"POST /users/unban","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:clerk/lock-user":{"post":{"operationId":"security_clerk_lock_user","summary":"Lock a user","description":"POST /users/{user_id}/lock","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["user_id"],"properties":{"user_id":{"type":"string","description":"The ID of the user to lock"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:clerk/unlock-user":{"post":{"operationId":"security_clerk_unlock_user","summary":"Unlock a user","description":"POST /users/{user_id}/unlock","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["user_id"],"properties":{"user_id":{"type":"string","description":"The ID of the user to unlock"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:clerk/merge-user":{"post":{"operationId":"security_clerk_merge_user","summary":"Merge another user into this user","description":"POST /users/{user_id}/merge","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["user_id","body"],"properties":{"user_id":{"type":"string","description":"The ID of the user that remains after the merge"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:clerk/set-user-profile-image":{"post":{"operationId":"security_clerk_set_user_profile_image","summary":"Set user profile image","description":"POST /users/{user_id}/profile_image","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["user_id","body"],"properties":{"user_id":{"type":"string","description":"The ID of the user to update the profile image for"},"body":{"type":"object","description":"Form fields as a JSON object"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:clerk/delete-user-profile-image":{"post":{"operationId":"security_clerk_delete_user_profile_image","summary":"Delete user profile image","description":"DELETE /users/{user_id}/profile_image","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["user_id"],"properties":{"user_id":{"type":"string","description":"The ID of the user to delete the profile image for"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:clerk/replace-user-metadata":{"post":{"operationId":"security_clerk_replace_user_metadata","summary":"Replace a user's metadata","description":"PUT /users/{user_id}/metadata","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["user_id"],"properties":{"user_id":{"type":"string","description":"The ID of the user whose metadata will be replaced"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:clerk/update-user-metadata":{"post":{"operationId":"security_clerk_update_user_metadata","summary":"Merge and update a user's metadata","description":"PATCH /users/{user_id}/metadata","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["user_id"],"properties":{"user_id":{"type":"string","description":"The ID of the user whose metadata will be updated and merged"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:clerk/get-user-billing-credit-balance":{"get":{"operationId":"security_clerk_get_user_billing_credit_balance","summary":"Retrieve a user's credit balance","description":"GET /users/{user_id}/billing/credits","tags":["security"],"parameters":[{"name":"user_id","in":"query","required":true,"description":"The ID of the user whose credit balance to retrieve","schema":{"type":"string","description":"The ID of the user whose credit balance to retrieve"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/security:clerk/adjust-user-billing-credit-balance":{"post":{"operationId":"security_clerk_adjust_user_billing_credit_balance","summary":"Adjust a user's credit balance","description":"POST /users/{user_id}/billing/credits","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["user_id","body"],"properties":{"user_id":{"type":"string","description":"The ID of the user whose credit balance to adjust"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:clerk/get-oauth-access-token":{"get":{"operationId":"security_clerk_get_oauth_access_token","summary":"Retrieve the OAuth access token of a user","description":"GET /users/{user_id}/oauth_access_tokens/{provider}","tags":["security"],"parameters":[{"name":"user_id","in":"query","required":true,"description":"The ID of the user for which to retrieve the OAuth access token","schema":{"type":"string","description":"The ID of the user for which to retrieve the OAuth access token"}},{"name":"provider","in":"query","required":true,"description":"The ID of the OAuth provider (e.g. `oauth_google`)","schema":{"type":"string","description":"The ID of the OAuth provider (e.g. `oauth_google`)"}},{"name":"paginated","in":"query","required":false,"description":"Whether to paginate the results. If true, the results will be paginated. If false, the results will not be paginated.","schema":{"type":"boolean","description":"Whether to paginate the results. If true, the results will be paginated. If false, the results will not be paginated."}},{"name":"limit","in":"query","required":false,"description":"Applies a limit to the number of results returned. Can be used for paginating the results together with `offset`.","schema":{"type":"integer","default":10,"description":"Applies a limit to the number of results returned. Can be used for paginating the results together with `offset`."}},{"name":"offset","in":"query","required":false,"description":"Skip the first `offset` results when paginating. Needs to be an integer greater or equal to zero. To be used in conjunction with `limit`.","schema":{"type":"integer","default":0,"description":"Skip the first `offset` results when paginating. Needs to be an integer greater or equal to zero. To be used in conjunction with `limit`."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/security:clerk/users-get-organization-memberships":{"get":{"operationId":"security_clerk_users_get_organization_memberships","summary":"Retrieve all memberships for a user","description":"GET /users/{user_id}/organization_memberships","tags":["security"],"parameters":[{"name":"user_id","in":"query","required":true,"description":"The ID of the user whose organization memberships we want to retrieve","schema":{"type":"string","description":"The ID of the user whose organization memberships we want to retrieve"}},{"name":"limit","in":"query","required":false,"description":"Applies a limit to the number of results returned. Can be used for paginating the results together with `offset`.","schema":{"type":"integer","default":10,"description":"Applies a limit to the number of results returned. Can be used for paginating the results together with `offset`."}},{"name":"offset","in":"query","required":false,"description":"Skip the first `offset` results when paginating. Needs to be an integer greater or equal to zero. To be used in conjunction with `limit`.","schema":{"type":"integer","default":0,"description":"Skip the first `offset` results when paginating. Needs to be an integer greater or equal to zero. To be used in conjunction with `limit`."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/security:clerk/users-get-organization-invitations":{"get":{"operationId":"security_clerk_users_get_organization_invitations","summary":"Retrieve all invitations for a user","description":"GET /users/{user_id}/organization_invitations","tags":["security"],"parameters":[{"name":"user_id","in":"query","required":true,"description":"The ID of the user whose organization invitations we want to retrieve","schema":{"type":"string","description":"The ID of the user whose organization invitations we want to retrieve"}},{"name":"limit","in":"query","required":false,"description":"Applies a limit to the number of results returned. Can be used for paginating the results together with `offset`.","schema":{"type":"integer","default":10,"description":"Applies a limit to the number of results returned. Can be used for paginating the results together with `offset`."}},{"name":"offset","in":"query","required":false,"description":"Skip the first `offset` results when paginating. Needs to be an integer greater or equal to zero. To be used in conjunction with `limit`.","schema":{"type":"integer","default":0,"description":"Skip the first `offset` results when paginating. Needs to be an integer greater or equal to zero. To be used in conjunction with `limit`."}},{"name":"status","in":"query","required":false,"description":"Filter organization invitations based on their status","schema":{"type":"string","enum":["pending","accepted","revoked","expired"],"description":"Filter organization invitations based on their status"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/security:clerk/remove-user-password":{"post":{"operationId":"security_clerk_remove_user_password","summary":"Remove a user's password","description":"POST /users/{user_id}/remove_password","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["user_id"],"properties":{"user_id":{"type":"string","description":"The ID of the user whose password to remove"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:clerk/verify-password":{"post":{"operationId":"security_clerk_verify_password","summary":"Verify the password of a user","description":"POST /users/{user_id}/verify_password","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["user_id"],"properties":{"user_id":{"type":"string","description":"The ID of the user for whom to verify the password"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:clerk/verify-totp":{"post":{"operationId":"security_clerk_verify_totp","summary":"Verify a TOTP or backup code for a user","description":"POST /users/{user_id}/verify_totp","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["user_id"],"properties":{"user_id":{"type":"string","description":"The ID of the user for whom to verify the TOTP"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:clerk/disable-mfa":{"post":{"operationId":"security_clerk_disable_mfa","summary":"Disable a user's MFA methods","description":"DELETE /users/{user_id}/mfa","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["user_id"],"properties":{"user_id":{"type":"string","description":"The ID of the user whose MFA methods are to be disabled"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:clerk/delete-backup-code":{"post":{"operationId":"security_clerk_delete_backup_code","summary":"Disable all user's Backup codes","description":"DELETE /users/{user_id}/backup_code","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["user_id"],"properties":{"user_id":{"type":"string","description":"The ID of the user whose backup codes are to be deleted."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:clerk/user-passkey-delete":{"post":{"operationId":"security_clerk_user_passkey_delete","summary":"Delete a user passkey","description":"DELETE /users/{user_id}/passkeys/{passkey_identification_id}","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["user_id","passkey_identification_id"],"properties":{"user_id":{"type":"string","description":"The ID of the user that owns the passkey identity"},"passkey_identification_id":{"type":"string","description":"The ID of the passkey identity to be deleted"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:clerk/user-web3-wallet-delete":{"post":{"operationId":"security_clerk_user_web3_wallet_delete","summary":"Delete a user web3 wallet","description":"DELETE /users/{user_id}/web3_wallets/{web3_wallet_identification_id}","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["user_id","web3_wallet_identification_id"],"properties":{"user_id":{"type":"string","description":"The ID of the user that owns the web3 wallet"},"web3_wallet_identification_id":{"type":"string","description":"The ID of the web3 wallet identity to be deleted"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:clerk/delete-totp":{"post":{"operationId":"security_clerk_delete_totp","summary":"Delete all the user's TOTPs","description":"DELETE /users/{user_id}/totp","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["user_id"],"properties":{"user_id":{"type":"string","description":"The ID of the user whose TOTPs are to be deleted"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:clerk/delete-external-account":{"post":{"operationId":"security_clerk_delete_external_account","summary":"Delete External Account","description":"DELETE /users/{user_id}/external_accounts/{external_account_id}","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["user_id","external_account_id"],"properties":{"user_id":{"type":"string","description":"The ID of the user's external account"},"external_account_id":{"type":"string","description":"The ID of the external account to delete"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:clerk/list-invitations":{"get":{"operationId":"security_clerk_list_invitations","summary":"List all invitations","description":"GET /invitations","tags":["security"],"parameters":[{"name":"status","in":"query","required":false,"description":"Filter invitations based on their status","schema":{"type":"string","enum":["pending","accepted","revoked","expired"],"description":"Filter invitations based on their status"}},{"name":"query","in":"query","required":false,"description":"Filter invitations based on their `email_address` or `id`","schema":{"type":"string","description":"Filter invitations based on their `email_address` or `id`"}},{"name":"order_by","in":"query","required":false,"description":"Allows to return invitations in a particular order. At the moment, you can order the returned invitations either by their `created_at`,…","schema":{"type":"string","default":"-created_at","description":"Allows to return invitations in a particular order. At the moment, you can order the returned invitations either by their `created_at`,…"}},{"name":"paginated","in":"query","required":false,"description":"Whether to paginate the results. If true, the results will be paginated. If false, the results will not be paginated.","schema":{"type":"boolean","description":"Whether to paginate the results. If true, the results will be paginated. If false, the results will not be paginated."}},{"name":"limit","in":"query","required":false,"description":"Applies a limit to the number of results returned. Can be used for paginating the results together with `offset`.","schema":{"type":"integer","default":10,"description":"Applies a limit to the number of results returned. Can be used for paginating the results together with `offset`."}},{"name":"offset","in":"query","required":false,"description":"Skip the first `offset` results when paginating. Needs to be an integer greater or equal to zero. To be used in conjunction with `limit`.","schema":{"type":"integer","default":0,"description":"Skip the first `offset` results when paginating. Needs to be an integer greater or equal to zero. To be used in conjunction with `limit`."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/security:clerk/create-invitation":{"post":{"operationId":"security_clerk_create_invitation","summary":"Create an invitation","description":"POST /invitations","tags":["security"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:clerk/create-bulk-invitations":{"post":{"operationId":"security_clerk_create_bulk_invitations","summary":"Create multiple invitations","description":"POST /invitations/bulk","tags":["security"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:clerk/delete-invitation":{"post":{"operationId":"security_clerk_delete_invitation","summary":"Delete an invitation","description":"DELETE /invitations/{invitation_id}","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["invitation_id"],"properties":{"invitation_id":{"type":"string","description":"The ID of the invitation to delete"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:clerk/revoke-invitation":{"post":{"operationId":"security_clerk_revoke_invitation","summary":"Revokes an invitation","description":"POST /invitations/{invitation_id}/revoke","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["invitation_id"],"properties":{"invitation_id":{"type":"string","description":"The ID of the invitation to be revoked"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:clerk/list-instance-organization-invitations":{"get":{"operationId":"security_clerk_list_instance_organization_invitations","summary":"Get a list of organization invitations for the current instance","description":"GET /organization_invitations","tags":["security"],"parameters":[{"name":"order_by","in":"query","required":false,"description":"Allows to return organization invitations in a particular order. At the moment, you can order the returned organization invitations either…","schema":{"type":"string","default":"-created_at","description":"Allows to return organization invitations in a particular order. At the moment, you can order the returned organization invitations either…"}},{"name":"status","in":"query","required":false,"description":"Filter organization invitations based on their status","schema":{"type":"string","enum":["pending","accepted","revoked","expired"],"description":"Filter organization invitations based on their status"}},{"name":"query","in":"query","required":false,"description":"Filter organization invitations based on their `email_address`","schema":{"type":"string","description":"Filter organization invitations based on their `email_address`"}},{"name":"limit","in":"query","required":false,"description":"Applies a limit to the number of results returned. Can be used for paginating the results together with `offset`.","schema":{"type":"integer","default":10,"description":"Applies a limit to the number of results returned. Can be used for paginating the results together with `offset`."}},{"name":"offset","in":"query","required":false,"description":"Skip the first `offset` results when paginating. Needs to be an integer greater or equal to zero. To be used in conjunction with `limit`.","schema":{"type":"integer","default":0,"description":"Skip the first `offset` results when paginating. Needs to be an integer greater or equal to zero. To be used in conjunction with `limit`."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/security:clerk/list-allowlist-identifiers":{"get":{"operationId":"security_clerk_list_allowlist_identifiers","summary":"List all identifiers on the allow-list","description":"GET /allowlist_identifiers","tags":["security"],"parameters":[{"name":"paginated","in":"query","required":false,"description":"Whether to paginate the results. If true, the results will be paginated. If false, the results will not be paginated.","schema":{"type":"boolean","description":"Whether to paginate the results. If true, the results will be paginated. If false, the results will not be paginated."}},{"name":"limit","in":"query","required":false,"description":"Applies a limit to the number of results returned. Can be used for paginating the results together with `offset`.","schema":{"type":"integer","default":10,"description":"Applies a limit to the number of results returned. Can be used for paginating the results together with `offset`."}},{"name":"offset","in":"query","required":false,"description":"Skip the first `offset` results when paginating. Needs to be an integer greater or equal to zero. To be used in conjunction with `limit`.","schema":{"type":"integer","default":0,"description":"Skip the first `offset` results when paginating. Needs to be an integer greater or equal to zero. To be used in conjunction with `limit`."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/security:clerk/create-allowlist-identifier":{"post":{"operationId":"security_clerk_create_allowlist_identifier","summary":"Add identifier to the allow-list","description":"POST /allowlist_identifiers","tags":["security"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:clerk/delete-allowlist-identifier":{"post":{"operationId":"security_clerk_delete_allowlist_identifier","summary":"Delete identifier from allow-list","description":"DELETE /allowlist_identifiers/{identifier_id}","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["identifier_id"],"properties":{"identifier_id":{"type":"string","description":"The ID of the identifier to delete from the allow-list"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:clerk/list-blocklist-identifiers":{"get":{"operationId":"security_clerk_list_blocklist_identifiers","summary":"List all identifiers on the block-list","description":"GET /blocklist_identifiers","tags":["security"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/security:clerk/create-blocklist-identifier":{"post":{"operationId":"security_clerk_create_blocklist_identifier","summary":"Add identifier to the block-list","description":"POST /blocklist_identifiers","tags":["security"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:clerk/delete-blocklist-identifier":{"post":{"operationId":"security_clerk_delete_blocklist_identifier","summary":"Delete identifier from block-list","description":"DELETE /blocklist_identifiers/{identifier_id}","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["identifier_id"],"properties":{"identifier_id":{"type":"string","description":"The ID of the identifier to delete from the block-list"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:clerk/update-instance-auth-config":{"post":{"operationId":"security_clerk_update_instance_auth_config","summary":"Update instance settings","description":"PATCH /beta_features/instance_settings","tags":["security"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:clerk/create-actor-token":{"post":{"operationId":"security_clerk_create_actor_token","summary":"Create actor token","description":"POST /actor_tokens","tags":["security"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:clerk/revoke-actor-token":{"post":{"operationId":"security_clerk_revoke_actor_token","summary":"Revoke actor token","description":"POST /actor_tokens/{actor_token_id}/revoke","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["actor_token_id"],"properties":{"actor_token_id":{"type":"string","description":"The ID of the actor token to be revoked."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:clerk/list-domains":{"get":{"operationId":"security_clerk_list_domains","summary":"List all instance domains","description":"GET /domains","tags":["security"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/security:clerk/add-domain":{"post":{"operationId":"security_clerk_add_domain","summary":"Add a domain","description":"POST /domains","tags":["security"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:clerk/update-domain":{"post":{"operationId":"security_clerk_update_domain","summary":"Update a domain","description":"PATCH /domains/{domain_id}","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["domain_id","body"],"properties":{"domain_id":{"type":"string","description":"The ID of the domain that will be updated."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:clerk/delete-domain":{"post":{"operationId":"security_clerk_delete_domain","summary":"Delete a domain","description":"DELETE /domains/{domain_id}","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["domain_id"],"properties":{"domain_id":{"type":"string","description":"The ID of the domain that will be deleted."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:clerk/get-instance":{"get":{"operationId":"security_clerk_get_instance","summary":"Fetch the current instance","description":"GET /instance","tags":["security"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/security:clerk/update-instance":{"post":{"operationId":"security_clerk_update_instance","summary":"Update instance settings","description":"PATCH /instance","tags":["security"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:clerk/update-instance-restrictions":{"post":{"operationId":"security_clerk_update_instance_restrictions","summary":"Update instance restrictions","description":"PATCH /instance/restrictions","tags":["security"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:clerk/get-instance-protect":{"get":{"operationId":"security_clerk_get_instance_protect","summary":"Get instance protect settings","description":"GET /instance/protect","tags":["security"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/security:clerk/update-instance-protect":{"post":{"operationId":"security_clerk_update_instance_protect","summary":"Update instance protect settings","description":"PATCH /instance/protect","tags":["security"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:clerk/get-instance-communication":{"get":{"operationId":"security_clerk_get_instance_communication","summary":"Get instance communication settings","description":"GET /instance/communication","tags":["security"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/security:clerk/update-instance-communication":{"post":{"operationId":"security_clerk_update_instance_communication","summary":"Update instance communication settings","description":"PATCH /instance/communication","tags":["security"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:clerk/get-instance-oauth-application-settings":{"get":{"operationId":"security_clerk_get_instance_oauth_application_settings","summary":"Get OAuth application settings","description":"GET /instance/oauth_application_settings","tags":["security"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/security:clerk/update-instance-oauth-application-settings":{"post":{"operationId":"security_clerk_update_instance_oauth_application_settings","summary":"Update OAuth application settings","description":"PATCH /instance/oauth_application_settings","tags":["security"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:clerk/change-production-instance-domain":{"post":{"operationId":"security_clerk_change_production_instance_domain","summary":"Update production instance domain","description":"POST /instance/change_domain","tags":["security"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:clerk/get-instance-organization-settings":{"get":{"operationId":"security_clerk_get_instance_organization_settings","summary":"Get instance organization settings","description":"GET /instance/organization_settings","tags":["security"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/security:clerk/update-instance-organization-settings":{"post":{"operationId":"security_clerk_update_instance_organization_settings","summary":"Update instance organization settings","description":"PATCH /instance/organization_settings","tags":["security"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:clerk/create-svix-app":{"post":{"operationId":"security_clerk_create_svix_app","summary":"Create a Svix app","description":"POST /webhooks/svix","tags":["security"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:clerk/delete-svix-app":{"post":{"operationId":"security_clerk_delete_svix_app","summary":"Delete a Svix app","description":"DELETE /webhooks/svix","tags":["security"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:clerk/generate-svix-auth-url":{"post":{"operationId":"security_clerk_generate_svix_auth_url","summary":"Create a Svix Dashboard URL","description":"POST /webhooks/svix_url","tags":["security"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:clerk/list-jwttemplates":{"get":{"operationId":"security_clerk_list_jwttemplates","summary":"List all templates","description":"GET /jwt_templates","tags":["security"],"parameters":[{"name":"paginated","in":"query","required":false,"description":"Whether to paginate the results. If true, the results will be paginated. If false, the results will not be paginated.","schema":{"type":"boolean","description":"Whether to paginate the results. If true, the results will be paginated. If false, the results will not be paginated."}},{"name":"limit","in":"query","required":false,"description":"Applies a limit to the number of results returned. Can be used for paginating the results together with `offset`.","schema":{"type":"integer","default":10,"description":"Applies a limit to the number of results returned. Can be used for paginating the results together with `offset`."}},{"name":"offset","in":"query","required":false,"description":"Skip the first `offset` results when paginating. Needs to be an integer greater or equal to zero. To be used in conjunction with `limit`.","schema":{"type":"integer","default":0,"description":"Skip the first `offset` results when paginating. Needs to be an integer greater or equal to zero. To be used in conjunction with `limit`."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/security:clerk/create-jwttemplate":{"post":{"operationId":"security_clerk_create_jwttemplate","summary":"Create a JWT template","description":"POST /jwt_templates","tags":["security"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:clerk/get-jwttemplate":{"get":{"operationId":"security_clerk_get_jwttemplate","summary":"Retrieve a template","description":"GET /jwt_templates/{template_id}","tags":["security"],"parameters":[{"name":"template_id","in":"query","required":true,"description":"JWT Template ID","schema":{"type":"string","description":"JWT Template ID"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/security:clerk/update-jwttemplate":{"post":{"operationId":"security_clerk_update_jwttemplate","summary":"Update a JWT template","description":"PATCH /jwt_templates/{template_id}","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["template_id"],"properties":{"template_id":{"type":"string","description":"The ID of the JWT template to update"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:clerk/delete-jwttemplate":{"post":{"operationId":"security_clerk_delete_jwttemplate","summary":"Delete a Template","description":"DELETE /jwt_templates/{template_id}","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["template_id"],"properties":{"template_id":{"type":"string","description":"JWT Template ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:clerk/list-machines":{"get":{"operationId":"security_clerk_list_machines","summary":"Get a list of machines for an instance","description":"GET /machines","tags":["security"],"parameters":[{"name":"limit","in":"query","required":false,"description":"Applies a limit to the number of results returned. Can be used for paginating the results together with `offset`.","schema":{"type":"integer","default":10,"description":"Applies a limit to the number of results returned. Can be used for paginating the results together with `offset`."}},{"name":"offset","in":"query","required":false,"description":"Skip the first `offset` results when paginating. Needs to be an integer greater or equal to zero. To be used in conjunction with `limit`.","schema":{"type":"integer","default":0,"description":"Skip the first `offset` results when paginating. Needs to be an integer greater or equal to zero. To be used in conjunction with `limit`."}},{"name":"query","in":"query","required":false,"description":"Returns machines with ID or name that match the given query. Uses exact match for machine ID and partial match for name.","schema":{"type":"string","description":"Returns machines with ID or name that match the given query. Uses exact match for machine ID and partial match for name."}},{"name":"order_by","in":"query","required":false,"description":"Allows to return machines in a particular order. You can order the returned machines by their `name` or `created_at`. To specify the…","schema":{"type":"string","default":"-created_at","description":"Allows to return machines in a particular order. You can order the returned machines by their `name` or `created_at`. To specify the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/security:clerk/create-machine":{"post":{"operationId":"security_clerk_create_machine","summary":"Create a machine","description":"POST /machines","tags":["security"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:clerk/get-machine":{"get":{"operationId":"security_clerk_get_machine","summary":"Retrieve a machine","description":"GET /machines/{machine_id}","tags":["security"],"parameters":[{"name":"machine_id","in":"query","required":true,"description":"The ID of the machine to retrieve","schema":{"type":"string","description":"The ID of the machine to retrieve"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/security:clerk/update-machine":{"post":{"operationId":"security_clerk_update_machine","summary":"Update a machine","description":"PATCH /machines/{machine_id}","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["machine_id"],"properties":{"machine_id":{"type":"string","description":"The ID of the machine to update"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:clerk/delete-machine":{"post":{"operationId":"security_clerk_delete_machine","summary":"Delete a machine","description":"DELETE /machines/{machine_id}","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["machine_id"],"properties":{"machine_id":{"type":"string","description":"The ID of the machine to delete"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:clerk/get-machine-secret-key":{"get":{"operationId":"security_clerk_get_machine_secret_key","summary":"Retrieve a machine secret key","description":"GET /machines/{machine_id}/secret_key","tags":["security"],"parameters":[{"name":"machine_id","in":"query","required":true,"description":"The ID of the machine to retrieve the secret key for","schema":{"type":"string","description":"The ID of the machine to retrieve the secret key for"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/security:clerk/rotate-machine-secret-key":{"post":{"operationId":"security_clerk_rotate_machine_secret_key","summary":"Rotate a machine's secret key","description":"POST /machines/{machine_id}/secret_key/rotate","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["machine_id","body"],"properties":{"machine_id":{"type":"string","description":"The ID of the machine to rotate the secret key for"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:clerk/create-machine-scope":{"post":{"operationId":"security_clerk_create_machine_scope","summary":"Create a machine scope","description":"POST /machines/{machine_id}/scopes","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["machine_id"],"properties":{"machine_id":{"type":"string","description":"The ID of the machine that will have access to another machine"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:clerk/delete-machine-scope":{"post":{"operationId":"security_clerk_delete_machine_scope","summary":"Delete a machine scope","description":"DELETE /machines/{machine_id}/scopes/{other_machine_id}","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["machine_id","other_machine_id"],"properties":{"machine_id":{"type":"string","description":"The ID of the machine that has access to another machine"},"other_machine_id":{"type":"string","description":"The ID of the machine that is being accessed"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:clerk/list-organizations":{"get":{"operationId":"security_clerk_list_organizations","summary":"Get a list of organizations for an instance","description":"GET /organizations","tags":["security"],"parameters":[{"name":"include_members_count","in":"query","required":false,"description":"Flag to denote whether the member counts of each organization should be included in the response or not.","schema":{"type":"boolean","description":"Flag to denote whether the member counts of each organization should be included in the response or not."}},{"name":"include_missing_member_with_elevated_permissions","in":"query","required":false,"description":"Flag to denote whether or not to include a member with elevated permissions who is not currently a member of the organization.","schema":{"type":"boolean","description":"Flag to denote whether or not to include a member with elevated permissions who is not currently a member of the organization."}},{"name":"query","in":"query","required":false,"description":"Returns organizations with ID, name, or slug that match the given query. Uses exact match for organization ID and partial match for name…","schema":{"type":"string","description":"Returns organizations with ID, name, or slug that match the given query. Uses exact match for organization ID and partial match for name…"}},{"name":"user_id","in":"query","required":false,"description":"Returns organizations that include any of the specified user IDs as members. Any user IDs not found are ignored. For each user ID, the `+`…","schema":{"type":"array","description":"Returns organizations that include any of the specified user IDs as members. Any user IDs not found are ignored. For each user ID, the `+`…"}},{"name":"organization_id","in":"query","required":false,"description":"Returns organizations with the organization IDs specified. Any organization IDs not found are ignored. For each organization ID, the `+`…","schema":{"type":"array","description":"Returns organizations with the organization IDs specified. Any organization IDs not found are ignored. For each organization ID, the `+`…"}},{"name":"order_by","in":"query","required":false,"description":"Allows to return organizations in a particular order. At the moment, you can order the returned organizations either by their `name`,…","schema":{"type":"string","default":"-created_at","description":"Allows to return organizations in a particular order. At the moment, you can order the returned organizations either by their `name`,…"}},{"name":"limit","in":"query","required":false,"description":"Applies a limit to the number of results returned. Can be used for paginating the results together with `offset`.","schema":{"type":"integer","default":10,"description":"Applies a limit to the number of results returned. Can be used for paginating the results together with `offset`."}},{"name":"offset","in":"query","required":false,"description":"Skip the first `offset` results when paginating. Needs to be an integer greater or equal to zero. To be used in conjunction with `limit`.","schema":{"type":"integer","default":0,"description":"Skip the first `offset` results when paginating. Needs to be an integer greater or equal to zero. To be used in conjunction with `limit`."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/security:clerk/create-organization":{"post":{"operationId":"security_clerk_create_organization","summary":"Create an organization","description":"POST /organizations","tags":["security"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:clerk/get-organization":{"get":{"operationId":"security_clerk_get_organization","summary":"Retrieve an organization by ID or slug","description":"GET /organizations/{organization_id}","tags":["security"],"parameters":[{"name":"organization_id","in":"query","required":true,"description":"The ID or slug of the organization","schema":{"type":"string","description":"The ID or slug of the organization"}},{"name":"include_members_count","in":"query","required":false,"description":"Flag to denote whether or not the organization's members count should be included in the response.","schema":{"type":"boolean","description":"Flag to denote whether or not the organization's members count should be included in the response."}},{"name":"include_missing_member_with_elevated_permissions","in":"query","required":false,"description":"Flag to denote whether or not to include a member with elevated permissions who is not currently a member of the organization.","schema":{"type":"boolean","description":"Flag to denote whether or not to include a member with elevated permissions who is not currently a member of the organization."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/security:clerk/update-organization":{"post":{"operationId":"security_clerk_update_organization","summary":"Update an organization","description":"PATCH /organizations/{organization_id}","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["organization_id","body"],"properties":{"organization_id":{"type":"string","description":"The ID of the organization to update"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:clerk/delete-organization":{"post":{"operationId":"security_clerk_delete_organization","summary":"Delete an organization","description":"DELETE /organizations/{organization_id}","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["organization_id"],"properties":{"organization_id":{"type":"string","description":"The ID of the organization to delete"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:clerk/replace-organization-metadata":{"post":{"operationId":"security_clerk_replace_organization_metadata","summary":"Replace metadata for an organization","description":"PUT /organizations/{organization_id}/metadata","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["organization_id","body"],"properties":{"organization_id":{"type":"string","description":"The ID of the organization whose metadata will be replaced"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:clerk/merge-organization-metadata":{"post":{"operationId":"security_clerk_merge_organization_metadata","summary":"Merge and update metadata for an organization","description":"PATCH /organizations/{organization_id}/metadata","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["organization_id","body"],"properties":{"organization_id":{"type":"string","description":"The ID of the organization for which metadata will be merged or updated"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:clerk/upload-organization-logo":{"post":{"operationId":"security_clerk_upload_organization_logo","summary":"Upload a logo for the organization","description":"PUT /organizations/{organization_id}/logo","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["organization_id"],"properties":{"organization_id":{"type":"string","description":"The ID of the organization for which to upload a logo"},"body":{"type":"object","description":"Form fields as a JSON object"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:clerk/delete-organization-logo":{"post":{"operationId":"security_clerk_delete_organization_logo","summary":"Delete the organization's logo.","description":"DELETE /organizations/{organization_id}/logo","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["organization_id"],"properties":{"organization_id":{"type":"string","description":"The ID of the organization for which the logo will be deleted."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:clerk/get-organization-billing-subscription":{"get":{"operationId":"security_clerk_get_organization_billing_subscription","summary":"Retrieve an organization's billing subscription","description":"GET /organizations/{organization_id}/billing/subscription","tags":["security"],"parameters":[{"name":"organization_id","in":"query","required":true,"description":"The ID of the organization whose subscription to retrieve","schema":{"type":"string","description":"The ID of the organization whose subscription to retrieve"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/security:clerk/get-organization-billing-credit-balance":{"get":{"operationId":"security_clerk_get_organization_billing_credit_balance","summary":"Retrieve an organization's credit balance","description":"GET /organizations/{organization_id}/billing/credits","tags":["security"],"parameters":[{"name":"organization_id","in":"query","required":true,"description":"The ID of the organization whose credit balance to retrieve","schema":{"type":"string","description":"The ID of the organization whose credit balance to retrieve"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/security:clerk/adjust-organization-billing-credit-balance":{"post":{"operationId":"security_clerk_adjust_organization_billing_credit_balance","summary":"Adjust an organization's credit balance","description":"POST /organizations/{organization_id}/billing/credits","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["organization_id","body"],"properties":{"organization_id":{"type":"string","description":"The ID of the organization whose credit balance to adjust"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:clerk/list-organization-invitations":{"get":{"operationId":"security_clerk_list_organization_invitations","summary":"Get a list of organization invitations","description":"GET /organizations/{organization_id}/invitations","tags":["security"],"parameters":[{"name":"organization_id","in":"query","required":true,"description":"The organization ID.","schema":{"type":"string","description":"The organization ID."}},{"name":"status","in":"query","required":false,"description":"Filter organization invitations based on their status","schema":{"type":"string","enum":["pending","accepted","revoked","expired"],"description":"Filter organization invitations based on their status"}},{"name":"email_address","in":"query","required":false,"description":"Returns organization invitations inviting the specified email address.","schema":{"type":"string","description":"Returns organization invitations inviting the specified email address."}},{"name":"order_by","in":"query","required":false,"description":"Allows to return organization invitations in a particular order. You can order the returned organization invitations either by their…","schema":{"type":"string","default":"-created_at","description":"Allows to return organization invitations in a particular order. You can order the returned organization invitations either by their…"}},{"name":"limit","in":"query","required":false,"description":"Applies a limit to the number of results returned. Can be used for paginating the results together with `offset`.","schema":{"type":"integer","default":10,"description":"Applies a limit to the number of results returned. Can be used for paginating the results together with `offset`."}},{"name":"offset","in":"query","required":false,"description":"Skip the first `offset` results when paginating. Needs to be an integer greater or equal to zero. To be used in conjunction with `limit`.","schema":{"type":"integer","default":0,"description":"Skip the first `offset` results when paginating. Needs to be an integer greater or equal to zero. To be used in conjunction with `limit`."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/security:clerk/create-organization-invitation":{"post":{"operationId":"security_clerk_create_organization_invitation","summary":"Create and send an organization invitation","description":"POST /organizations/{organization_id}/invitations","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["organization_id"],"properties":{"organization_id":{"type":"string","description":"The ID of the organization for which to send the invitation"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:clerk/create-organization-invitation-bulk":{"post":{"operationId":"security_clerk_create_organization_invitation_bulk","summary":"Bulk create and send organization invitations","description":"POST /organizations/{organization_id}/invitations/bulk","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["organization_id","body"],"properties":{"organization_id":{"type":"string","description":"The organization ID."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:clerk/get-organization-invitation":{"get":{"operationId":"security_clerk_get_organization_invitation","summary":"Retrieve an organization invitation by ID","description":"GET /organizations/{organization_id}/invitations/{invitation_id}","tags":["security"],"parameters":[{"name":"organization_id","in":"query","required":true,"description":"The organization ID.","schema":{"type":"string","description":"The organization ID."}},{"name":"invitation_id","in":"query","required":true,"description":"The organization invitation ID.","schema":{"type":"string","description":"The organization invitation ID."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/security:clerk/revoke-organization-invitation":{"post":{"operationId":"security_clerk_revoke_organization_invitation","summary":"Revoke a pending organization invitation","description":"POST /organizations/{organization_id}/invitations/{invitation_id}/revoke","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["organization_id","invitation_id"],"properties":{"organization_id":{"type":"string","description":"The organization ID."},"invitation_id":{"type":"string","description":"The organization invitation ID."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:clerk/list-organization-memberships":{"get":{"operationId":"security_clerk_list_organization_memberships","summary":"Get a list of all members of an organization","description":"GET /organizations/{organization_id}/memberships","tags":["security"],"parameters":[{"name":"organization_id","in":"query","required":true,"description":"The organization ID.","schema":{"type":"string","description":"The organization ID."}},{"name":"order_by","in":"query","required":false,"description":"Sorts organizations memberships by phone_number, email_address, created_at, first_name, last_name or username. By prepending one of those…","schema":{"type":"string","description":"Sorts organizations memberships by phone_number, email_address, created_at, first_name, last_name or username. By prepending one of those…"}},{"name":"user_id","in":"query","required":false,"description":"Returns users with the user IDs specified. For each user ID, the `+` and `-` can be prepended to the ID, which denote whether the…","schema":{"type":"array","description":"Returns users with the user IDs specified. For each user ID, the `+` and `-` can be prepended to the ID, which denote whether the…"}},{"name":"email_address","in":"query","required":false,"description":"Returns users with the specified email addresses. Accepts up to 100 email addresses. Any email addresses not found are ignored.","schema":{"type":"array","description":"Returns users with the specified email addresses. Accepts up to 100 email addresses. Any email addresses not found are ignored."}},{"name":"phone_number","in":"query","required":false,"description":"Returns users with the specified phone numbers. Accepts up to 100 phone numbers. Any phone numbers not found are ignored.","schema":{"type":"array","description":"Returns users with the specified phone numbers. Accepts up to 100 phone numbers. Any phone numbers not found are ignored."}},{"name":"username","in":"query","required":false,"description":"Returns users with the specified usernames. Accepts up to 100 usernames. Any usernames not found are ignored.","schema":{"type":"array","description":"Returns users with the specified usernames. Accepts up to 100 usernames. Any usernames not found are ignored."}},{"name":"web3_wallet","in":"query","required":false,"description":"Returns users with the specified web3 wallet addresses. Accepts up to 100 web3 wallet addresses. Any web3 wallet addresses not found are…","schema":{"type":"array","description":"Returns users with the specified web3 wallet addresses. Accepts up to 100 web3 wallet addresses. Any web3 wallet addresses not found are…"}},{"name":"role","in":"query","required":false,"description":"Returns users with the specified roles. Accepts up to 100 roles. Any roles not found are ignored.","schema":{"type":"array","description":"Returns users with the specified roles. Accepts up to 100 roles. Any roles not found are ignored."}},{"name":"query","in":"query","required":false,"description":"Returns users that match the given query. For possible matches, we check the email addresses, phone numbers, usernames, web3 wallets, user…","schema":{"type":"string","description":"Returns users that match the given query. For possible matches, we check the email addresses, phone numbers, usernames, web3 wallets, user…"}},{"name":"email_address_query","in":"query","required":false,"description":"Returns users with emails that match the given query, via case-insensitive partial match. For example, `email_address_query=ello` will…","schema":{"type":"string","description":"Returns users with emails that match the given query, via case-insensitive partial match. For example, `email_address_query=ello` will…"}},{"name":"phone_number_query","in":"query","required":false,"description":"Returns users with phone numbers that match the given query, via case-insensitive partial match. For example, `phone_number_query=555`…","schema":{"type":"string","description":"Returns users with phone numbers that match the given query, via case-insensitive partial match. For example, `phone_number_query=555`…"}},{"name":"username_query","in":"query","required":false,"description":"Returns users with usernames that match the given query, via case-insensitive partial match. For example, `username_query=CoolUser` will…","schema":{"type":"string","description":"Returns users with usernames that match the given query, via case-insensitive partial match. For example, `username_query=CoolUser` will…"}},{"name":"name_query","in":"query","required":false,"description":"Returns users with names that match the given query, via case-insensitive partial match.","schema":{"type":"string","description":"Returns users with names that match the given query, via case-insensitive partial match."}},{"name":"last_active_at_before","in":"query","required":false,"description":"Returns users whose last session activity was before the given date (with millisecond precision). Example: use 1700690400000 to retrieve…","schema":{"type":"integer","description":"Returns users whose last session activity was before the given date (with millisecond precision). Example: use 1700690400000 to retrieve…"},"example":1700690400000},{"name":"last_active_at_after","in":"query","required":false,"description":"Returns users whose last session activity was after the given date (with millisecond precision). Example: use 1700690400000 to retrieve…","schema":{"type":"integer","description":"Returns users whose last session activity was after the given date (with millisecond precision). Example: use 1700690400000 to retrieve…"},"example":1700690400000},{"name":"created_at_before","in":"query","required":false,"description":"Returns users who have been created before the given date (with millisecond precision). Example: use 1730160000000 to retrieve users who…","schema":{"type":"integer","description":"Returns users who have been created before the given date (with millisecond precision). Example: use 1730160000000 to retrieve users who…"},"example":1730160000000},{"name":"created_at_after","in":"query","required":false,"description":"Returns users who have been created after the given date (with millisecond precision). Example: use 1730160000000 to retrieve users who…","schema":{"type":"integer","description":"Returns users who have been created after the given date (with millisecond precision). Example: use 1730160000000 to retrieve users who…"},"example":1730160000000},{"name":"limit","in":"query","required":false,"description":"Applies a limit to the number of results returned. Can be used for paginating the results together with `offset`.","schema":{"type":"integer","default":10,"description":"Applies a limit to the number of results returned. Can be used for paginating the results together with `offset`."}},{"name":"offset","in":"query","required":false,"description":"Skip the first `offset` results when paginating. Needs to be an integer greater or equal to zero. To be used in conjunction with `limit`.","schema":{"type":"integer","default":0,"description":"Skip the first `offset` results when paginating. Needs to be an integer greater or equal to zero. To be used in conjunction with `limit`."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/security:clerk/create-organization-membership":{"post":{"operationId":"security_clerk_create_organization_membership","summary":"Create a new organization membership","description":"POST /organizations/{organization_id}/memberships","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["organization_id","body"],"properties":{"organization_id":{"type":"string","description":"The ID of the organization where the new membership will be created"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:clerk/update-organization-membership":{"post":{"operationId":"security_clerk_update_organization_membership","summary":"Update an organization membership","description":"PATCH /organizations/{organization_id}/memberships/{user_id}","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["organization_id","user_id","body"],"properties":{"organization_id":{"type":"string","description":"The ID of the organization to which this membership belongs"},"user_id":{"type":"string","description":"The ID of the user to which this membership belongs"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:clerk/delete-organization-membership":{"post":{"operationId":"security_clerk_delete_organization_membership","summary":"Remove a member from an organization","description":"DELETE /organizations/{organization_id}/memberships/{user_id}","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["organization_id","user_id"],"properties":{"organization_id":{"type":"string","description":"The ID of the organization to which this membership belongs"},"user_id":{"type":"string","description":"The ID of the user to which this membership belongs"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:clerk/update-organization-membership-metadata":{"post":{"operationId":"security_clerk_update_organization_membership_metadata","summary":"Merge and update organization membership metadata","description":"PATCH /organizations/{organization_id}/memberships/{user_id}/metadata","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["organization_id","user_id"],"properties":{"organization_id":{"type":"string","description":"The ID of the organization to which this membership belongs"},"user_id":{"type":"string","description":"The ID of the user to which this membership belongs"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:clerk/list-organization-domains":{"get":{"operationId":"security_clerk_list_organization_domains","summary":"Get a list of all domains of an organization.","description":"GET /organizations/{organization_id}/domains","tags":["security"],"parameters":[{"name":"organization_id","in":"query","required":true,"description":"The organization ID.","schema":{"type":"string","description":"The organization ID."}},{"name":"verified","in":"query","required":false,"description":"Filter domains by their verification status. `true` or `false`","schema":{"type":"string","description":"Filter domains by their verification status. `true` or `false`"}},{"name":"enrollment_mode","in":"query","required":false,"description":"Filter domains by their enrollment mode. Accepts `automatic_invitation`, `automatic_suggestion`, `manual_invitation` or `enterprise_sso`.…","schema":{"type":"string","description":"Filter domains by their enrollment mode. Accepts `automatic_invitation`, `automatic_suggestion`, `manual_invitation` or `enterprise_sso`.…"}},{"name":"limit","in":"query","required":false,"description":"Applies a limit to the number of results returned. Can be used for paginating the results together with `offset`.","schema":{"type":"integer","default":10,"description":"Applies a limit to the number of results returned. Can be used for paginating the results together with `offset`."}},{"name":"offset","in":"query","required":false,"description":"Skip the first `offset` results when paginating. Needs to be an integer greater or equal to zero. To be used in conjunction with `limit`.","schema":{"type":"integer","default":0,"description":"Skip the first `offset` results when paginating. Needs to be an integer greater or equal to zero. To be used in conjunction with `limit`."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/security:clerk/create-organization-domain":{"post":{"operationId":"security_clerk_create_organization_domain","summary":"Create a new organization domain.","description":"POST /organizations/{organization_id}/domains","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["organization_id","body"],"properties":{"organization_id":{"type":"string","description":"The ID of the organization where the new domain will be created."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:clerk/update-organization-domain":{"post":{"operationId":"security_clerk_update_organization_domain","summary":"Update an organization domain.","description":"PATCH /organizations/{organization_id}/domains/{domain_id}","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["organization_id","domain_id","body"],"properties":{"organization_id":{"type":"string","description":"The ID of the organization to which the domain belongs"},"domain_id":{"type":"string","description":"The ID of the domain"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:clerk/delete-organization-domain":{"post":{"operationId":"security_clerk_delete_organization_domain","summary":"Remove a domain from an organization.","description":"DELETE /organizations/{organization_id}/domains/{domain_id}","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["organization_id","domain_id"],"properties":{"organization_id":{"type":"string","description":"The ID of the organization to which the domain belongs"},"domain_id":{"type":"string","description":"The ID of the domain"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:clerk/verify-organization-domain-ownership":{"post":{"operationId":"security_clerk_verify_organization_domain_ownership","summary":"Mark an organization domain's ownership as verified","description":"POST /organizations/{organization_id}/domains/{domain_id}/verify_ownership","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["organization_id","domain_id"],"properties":{"organization_id":{"type":"string","description":"The ID of the organization to which the domain belongs"},"domain_id":{"type":"string","description":"The ID of the domain"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:clerk/list-all-organization-domains":{"get":{"operationId":"security_clerk_list_all_organization_domains","summary":"List all organization domains","description":"GET /organization_domains","tags":["security"],"parameters":[{"name":"organization_id","in":"query","required":false,"description":"The ID of the organization to filter domains by","schema":{"type":"string","description":"The ID of the organization to filter domains by"}},{"name":"verified","in":"query","required":false,"description":"Filter by verification status","schema":{"type":"string","enum":["true","false"],"description":"Filter by verification status"}},{"name":"enrollment_mode","in":"query","required":false,"description":"Filter by enrollment mode. Prefix a value with `-` to exclude it instead (e.g. `-enterprise_sso`). Include and exclude filters can be…","schema":{"type":"array","description":"Filter by enrollment mode. Prefix a value with `-` to exclude it instead (e.g. `-enterprise_sso`). Include and exclude filters can be…"}},{"name":"query","in":"query","required":false,"description":"Search domains by name or organization ID. If the query starts with \"org_\", it will search by exact organization ID match. Otherwise, it…","schema":{"type":"string","description":"Search domains by name or organization ID. If the query starts with \"org_\", it will search by exact organization ID match. Otherwise, it…"}},{"name":"domains","in":"query","required":false,"description":"Filter by exact domain names. Accepts multiple values (e.g. domains=example.com&domains=test.org).","schema":{"type":"array","description":"Filter by exact domain names. Accepts multiple values (e.g. domains=example.com&domains=test.org)."}},{"name":"order_by","in":"query","required":false,"description":"Allows to return organization domains in a particular order. At the moment, you can order the returned domains by their `name` or…","schema":{"type":"string","default":"-created_at","description":"Allows to return organization domains in a particular order. At the moment, you can order the returned domains by their `name` or…"}},{"name":"offset","in":"query","required":false,"description":"Skip the first `offset` results when paginating. Needs to be an integer greater or equal to zero. To be used in conjunction with `limit`.","schema":{"type":"integer","default":0,"description":"Skip the first `offset` results when paginating. Needs to be an integer greater or equal to zero. To be used in conjunction with `limit`."}},{"name":"limit","in":"query","required":false,"description":"Applies a limit to the number of results returned. Can be used for paginating the results together with `offset`.","schema":{"type":"integer","default":10,"description":"Applies a limit to the number of results returned. Can be used for paginating the results together with `offset`."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/security:clerk/verify-domain-proxy":{"post":{"operationId":"security_clerk_verify_domain_proxy","summary":"Verify the proxy configuration for your domain","description":"POST /proxy_checks","tags":["security"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:clerk/list-redirect-urls":{"get":{"operationId":"security_clerk_list_redirect_urls","summary":"List all redirect URLs","description":"GET /redirect_urls","tags":["security"],"parameters":[{"name":"paginated","in":"query","required":false,"description":"Whether to paginate the results. If true, the results will be paginated. If false, the results will not be paginated.","schema":{"type":"boolean","description":"Whether to paginate the results. If true, the results will be paginated. If false, the results will not be paginated."}},{"name":"limit","in":"query","required":false,"description":"Applies a limit to the number of results returned. Can be used for paginating the results together with `offset`.","schema":{"type":"integer","default":10,"description":"Applies a limit to the number of results returned. Can be used for paginating the results together with `offset`."}},{"name":"offset","in":"query","required":false,"description":"Skip the first `offset` results when paginating. Needs to be an integer greater or equal to zero. To be used in conjunction with `limit`.","schema":{"type":"integer","default":0,"description":"Skip the first `offset` results when paginating. Needs to be an integer greater or equal to zero. To be used in conjunction with `limit`."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/security:clerk/create-redirect-url":{"post":{"operationId":"security_clerk_create_redirect_url","summary":"Create a redirect URL","description":"POST /redirect_urls","tags":["security"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:clerk/get-redirect-url":{"get":{"operationId":"security_clerk_get_redirect_url","summary":"Retrieve a redirect URL","description":"GET /redirect_urls/{id}","tags":["security"],"parameters":[{"name":"id","in":"query","required":true,"description":"The ID of the redirect URL","schema":{"type":"string","description":"The ID of the redirect URL"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/security:clerk/delete-redirect-url":{"post":{"operationId":"security_clerk_delete_redirect_url","summary":"Delete a redirect URL","description":"DELETE /redirect_urls/{id}","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The ID of the redirect URL"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:clerk/create-sign-in-token":{"post":{"operationId":"security_clerk_create_sign_in_token","summary":"Create sign-in token","description":"POST /sign_in_tokens","tags":["security"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:clerk/revoke-sign-in-token":{"post":{"operationId":"security_clerk_revoke_sign_in_token","summary":"Revoke the given sign-in token","description":"POST /sign_in_tokens/{sign_in_token_id}/revoke","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["sign_in_token_id"],"properties":{"sign_in_token_id":{"type":"string","description":"The ID of the sign-in token to be revoked"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:clerk/get-sign-up":{"get":{"operationId":"security_clerk_get_sign_up","summary":"Retrieve a sign-up by ID","description":"GET /sign_ups/{id}","tags":["security"],"parameters":[{"name":"id","in":"query","required":true,"description":"The ID of the sign-up to retrieve","schema":{"type":"string","description":"The ID of the sign-up to retrieve"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/security:clerk/update-sign-up":{"post":{"operationId":"security_clerk_update_sign_up","summary":"Update a sign-up","description":"PATCH /sign_ups/{id}","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The ID of the sign-up to update"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:clerk/list-oauth-applications":{"get":{"operationId":"security_clerk_list_oauth_applications","summary":"Get a list of OAuth applications for an instance","description":"GET /oauth_applications","tags":["security"],"parameters":[{"name":"limit","in":"query","required":false,"description":"Applies a limit to the number of results returned. Can be used for paginating the results together with `offset`.","schema":{"type":"integer","default":10,"description":"Applies a limit to the number of results returned. Can be used for paginating the results together with `offset`."}},{"name":"offset","in":"query","required":false,"description":"Skip the first `offset` results when paginating. Needs to be an integer greater or equal to zero. To be used in conjunction with `limit`.","schema":{"type":"integer","default":0,"description":"Skip the first `offset` results when paginating. Needs to be an integer greater or equal to zero. To be used in conjunction with `limit`."}},{"name":"order_by","in":"query","required":false,"description":"Allows to return OAuth applications in a particular order. At the moment, you can order the returned OAuth applications by their…","schema":{"type":"string","default":"+created_at","description":"Allows to return OAuth applications in a particular order. At the moment, you can order the returned OAuth applications by their…"}},{"name":"name_query","in":"query","required":false,"description":"Returns OAuth applications with names that match the given query, via case-insensitive partial match. Also returns the OAuth application…","schema":{"type":"string","description":"Returns OAuth applications with names that match the given query, via case-insensitive partial match. Also returns the OAuth application…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/security:clerk/create-oauth-application":{"post":{"operationId":"security_clerk_create_oauth_application","summary":"Create an OAuth application","description":"POST /oauth_applications","tags":["security"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:clerk/get-oauth-application":{"get":{"operationId":"security_clerk_get_oauth_application","summary":"Retrieve an OAuth application by ID","description":"GET /oauth_applications/{oauth_application_id}","tags":["security"],"parameters":[{"name":"oauth_application_id","in":"query","required":true,"description":"The ID of the OAuth application","schema":{"type":"string","description":"The ID of the OAuth application"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/security:clerk/update-oauth-application":{"post":{"operationId":"security_clerk_update_oauth_application","summary":"Update an OAuth application","description":"PATCH /oauth_applications/{oauth_application_id}","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["oauth_application_id","body"],"properties":{"oauth_application_id":{"type":"string","description":"The ID of the OAuth application to update"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:clerk/delete-oauth-application":{"post":{"operationId":"security_clerk_delete_oauth_application","summary":"Delete an OAuth application","description":"DELETE /oauth_applications/{oauth_application_id}","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["oauth_application_id"],"properties":{"oauth_application_id":{"type":"string","description":"The ID of the OAuth application to delete"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:clerk/upload-oauth-application-logo":{"post":{"operationId":"security_clerk_upload_oauth_application_logo","summary":"Upload a logo for the OAuth application","description":"PUT /oauth_applications/{oauth_application_id}/logo","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["oauth_application_id"],"properties":{"oauth_application_id":{"type":"string","description":"The ID of the OAuth application for which to upload a logo"},"body":{"type":"object","description":"Form fields as a JSON object"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:clerk/rotate-oauth-application-secret":{"post":{"operationId":"security_clerk_rotate_oauth_application_secret","summary":"Rotate the client secret of the given OAuth application","description":"POST /oauth_applications/{oauth_application_id}/rotate_secret","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["oauth_application_id"],"properties":{"oauth_application_id":{"type":"string","description":"The ID of the OAuth application for which to rotate the client secret"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:clerk/revoke-oauth-application-token":{"post":{"operationId":"security_clerk_revoke_oauth_application_token","summary":"Revoke an OAuth application token","description":"POST /oauth_applications/{oauth_application_id}/revoke_token","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["oauth_application_id","body"],"properties":{"oauth_application_id":{"type":"string","description":"The ID of the OAuth application for which to revoke the token"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:clerk/list-enterprise-connections":{"get":{"operationId":"security_clerk_list_enterprise_connections","summary":"List enterprise connections","description":"GET /enterprise_connections","tags":["security"],"parameters":[{"name":"limit","in":"query","required":false,"description":"Applies a limit to the number of results returned. Can be used for paginating the results together with `offset`.","schema":{"type":"integer","default":10,"description":"Applies a limit to the number of results returned. Can be used for paginating the results together with `offset`."}},{"name":"offset","in":"query","required":false,"description":"Skip the first `offset` results when paginating. Needs to be an integer greater or equal to zero. To be used in conjunction with `limit`.","schema":{"type":"integer","default":0,"description":"Skip the first `offset` results when paginating. Needs to be an integer greater or equal to zero. To be used in conjunction with `limit`."}},{"name":"organization_id","in":"query","required":false,"description":"Filter enterprise connections by organization ID","schema":{"type":"string","description":"Filter enterprise connections by organization ID"}},{"name":"active","in":"query","required":false,"description":"Filter by active status. If true, only active connections are returned. If false, only inactive connections are returned. If omitted, all…","schema":{"type":"boolean","description":"Filter by active status. If true, only active connections are returned. If false, only inactive connections are returned. If omitted, all…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/security:clerk/create-enterprise-connection":{"post":{"operationId":"security_clerk_create_enterprise_connection","summary":"Create an enterprise connection","description":"POST /enterprise_connections","tags":["security"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:clerk/get-enterprise-connection":{"get":{"operationId":"security_clerk_get_enterprise_connection","summary":"Retrieve an enterprise connection","description":"GET /enterprise_connections/{enterprise_connection_id}","tags":["security"],"parameters":[{"name":"enterprise_connection_id","in":"query","required":true,"description":"The ID of the enterprise connection","schema":{"type":"string","description":"The ID of the enterprise connection"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/security:clerk/update-enterprise-connection":{"post":{"operationId":"security_clerk_update_enterprise_connection","summary":"Update an enterprise connection","description":"PATCH /enterprise_connections/{enterprise_connection_id}","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["enterprise_connection_id","body"],"properties":{"enterprise_connection_id":{"type":"string","description":"The ID of the enterprise connection to update"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:clerk/delete-enterprise-connection":{"post":{"operationId":"security_clerk_delete_enterprise_connection","summary":"Delete an enterprise connection","description":"DELETE /enterprise_connections/{enterprise_connection_id}","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["enterprise_connection_id"],"properties":{"enterprise_connection_id":{"type":"string","description":"The ID of the enterprise connection to delete"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:clerk/list-enterprise-connection-test-runs":{"get":{"operationId":"security_clerk_list_enterprise_connection_test_runs","summary":"List enterprise connection test runs","description":"GET /enterprise_connections/{enterprise_connection_id}/test_runs","tags":["security"],"parameters":[{"name":"enterprise_connection_id","in":"query","required":true,"description":"The ID of the enterprise connection","schema":{"type":"string","description":"The ID of the enterprise connection"}},{"name":"status","in":"query","required":false,"description":"Filter test runs by status (may be repeated)","schema":{"type":"array","description":"Filter test runs by status (may be repeated)"}},{"name":"limit","in":"query","required":false,"description":"Applies a limit to the number of results returned. Can be used for paginating the results together with `offset`.","schema":{"type":"integer","default":10,"description":"Applies a limit to the number of results returned. Can be used for paginating the results together with `offset`."}},{"name":"offset","in":"query","required":false,"description":"Skip the first `offset` results when paginating. Needs to be an integer greater or equal to zero. To be used in conjunction with `limit`.","schema":{"type":"integer","default":0,"description":"Skip the first `offset` results when paginating. Needs to be an integer greater or equal to zero. To be used in conjunction with `limit`."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/security:clerk/create-enterprise-connection-test-run":{"post":{"operationId":"security_clerk_create_enterprise_connection_test_run","summary":"Create an enterprise connection test run","description":"POST /enterprise_connections/{enterprise_connection_id}/test_runs","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["enterprise_connection_id"],"properties":{"enterprise_connection_id":{"type":"string","description":"The ID of the enterprise connection"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:clerk/create-testing-token":{"post":{"operationId":"security_clerk_create_testing_token","summary":"Retrieve a new testing token","description":"POST /testing_tokens","tags":["security"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:clerk/instance-get-organization-memberships":{"get":{"operationId":"security_clerk_instance_get_organization_memberships","summary":"Get a list of all organization memberships within an instance.","description":"GET /organization_memberships","tags":["security"],"parameters":[{"name":"order_by","in":"query","required":false,"description":"Sorts organizations memberships by phone_number, email_address, created_at, first_name, last_name or username. By prepending one of those…","schema":{"type":"string","description":"Sorts organizations memberships by phone_number, email_address, created_at, first_name, last_name or username. By prepending one of those…"}},{"name":"limit","in":"query","required":false,"description":"Applies a limit to the number of results returned. Can be used for paginating the results together with `offset`.","schema":{"type":"integer","default":10,"description":"Applies a limit to the number of results returned. Can be used for paginating the results together with `offset`."}},{"name":"offset","in":"query","required":false,"description":"Skip the first `offset` results when paginating. Needs to be an integer greater or equal to zero. To be used in conjunction with `limit`.","schema":{"type":"integer","default":0,"description":"Skip the first `offset` results when paginating. Needs to be an integer greater or equal to zero. To be used in conjunction with `limit`."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/security:clerk/list-waitlist-entries":{"get":{"operationId":"security_clerk_list_waitlist_entries","summary":"List all waitlist entries","description":"GET /waitlist_entries","tags":["security"],"parameters":[{"name":"limit","in":"query","required":false,"description":"Applies a limit to the number of results returned. Can be used for paginating the results together with `offset`.","schema":{"type":"integer","default":10,"description":"Applies a limit to the number of results returned. Can be used for paginating the results together with `offset`."}},{"name":"offset","in":"query","required":false,"description":"Skip the first `offset` results when paginating. Needs to be an integer greater or equal to zero. To be used in conjunction with `limit`.","schema":{"type":"integer","default":0,"description":"Skip the first `offset` results when paginating. Needs to be an integer greater or equal to zero. To be used in conjunction with `limit`."}},{"name":"query","in":"query","required":false,"description":"Filter waitlist entries by `email_address` or `id`","schema":{"type":"string","description":"Filter waitlist entries by `email_address` or `id`"}},{"name":"status","in":"query","required":false,"description":"Filter waitlist entries by their status","schema":{"type":"string","enum":["pending","invited","completed","rejected"],"description":"Filter waitlist entries by their status"}},{"name":"order_by","in":"query","required":false,"description":"Specify the order of results. Supported values are: - `created_at` - `email_address` - `invited_at` Use `+` for ascending or `-` for…","schema":{"type":"string","default":"-created_at","description":"Specify the order of results. Supported values are: - `created_at` - `email_address` - `invited_at` Use `+` for ascending or `-` for…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/security:clerk/create-waitlist-entry":{"post":{"operationId":"security_clerk_create_waitlist_entry","summary":"Create a waitlist entry","description":"POST /waitlist_entries","tags":["security"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:clerk/delete-waitlist-entry":{"post":{"operationId":"security_clerk_delete_waitlist_entry","summary":"Delete a pending waitlist entry","description":"DELETE /waitlist_entries/{waitlist_entry_id}","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["waitlist_entry_id"],"properties":{"waitlist_entry_id":{"type":"string","description":"The ID of the waitlist entry to delete"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:clerk/invite-waitlist-entry":{"post":{"operationId":"security_clerk_invite_waitlist_entry","summary":"Invite a waitlist entry","description":"POST /waitlist_entries/{waitlist_entry_id}/invite","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["waitlist_entry_id"],"properties":{"waitlist_entry_id":{"type":"string","description":"The ID of the waitlist entry to invite"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:clerk/reject-waitlist-entry":{"post":{"operationId":"security_clerk_reject_waitlist_entry","summary":"Reject a waitlist entry","description":"POST /waitlist_entries/{waitlist_entry_id}/reject","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["waitlist_entry_id"],"properties":{"waitlist_entry_id":{"type":"string","description":"The ID of the waitlist entry to reject"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:clerk/get-commerce-plan-list":{"get":{"operationId":"security_clerk_get_commerce_plan_list","summary":"List all commerce plans","description":"GET /commerce/plans","tags":["security"],"parameters":[{"name":"paginated","in":"query","required":false,"description":"Whether to paginate the results. If true, the results will be paginated. If false, the results will not be paginated.","schema":{"type":"boolean","description":"Whether to paginate the results. If true, the results will be paginated. If false, the results will not be paginated."}},{"name":"limit","in":"query","required":false,"description":"Applies a limit to the number of results returned. Can be used for paginating the results together with `offset`.","schema":{"type":"integer","default":10,"description":"Applies a limit to the number of results returned. Can be used for paginating the results together with `offset`."}},{"name":"offset","in":"query","required":false,"description":"Skip the first `offset` results when paginating. Needs to be an integer greater or equal to zero. To be used in conjunction with `limit`.","schema":{"type":"integer","default":0,"description":"Skip the first `offset` results when paginating. Needs to be an integer greater or equal to zero. To be used in conjunction with `limit`."}},{"name":"payer_type","in":"query","required":false,"description":"Filter plans by payer type","schema":{"type":"string","enum":["user","org"],"description":"Filter plans by payer type"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/security:clerk/get-commerce-subscription-item-list":{"get":{"operationId":"security_clerk_get_commerce_subscription_item_list","summary":"List all subscription items","description":"GET /commerce/subscription_items","tags":["security"],"parameters":[{"name":"paginated","in":"query","required":false,"description":"Whether to paginate the results. If true, the results will be paginated. If false, the results will not be paginated.","schema":{"type":"boolean","description":"Whether to paginate the results. If true, the results will be paginated. If false, the results will not be paginated."}},{"name":"limit","in":"query","required":false,"description":"Applies a limit to the number of results returned. Can be used for paginating the results together with `offset`.","schema":{"type":"integer","default":10,"description":"Applies a limit to the number of results returned. Can be used for paginating the results together with `offset`."}},{"name":"offset","in":"query","required":false,"description":"Skip the first `offset` results when paginating. Needs to be an integer greater or equal to zero. To be used in conjunction with `limit`.","schema":{"type":"integer","default":0,"description":"Skip the first `offset` results when paginating. Needs to be an integer greater or equal to zero. To be used in conjunction with `limit`."}},{"name":"status","in":"query","required":false,"description":"Filter subscription items by status","schema":{"type":"string","enum":["active","ended","past_due","upcoming","free_trial"],"description":"Filter subscription items by status"}},{"name":"payer_type","in":"query","required":false,"description":"Filter subscription items by payer type","schema":{"type":"string","enum":["user","org"],"description":"Filter subscription items by payer type"}},{"name":"plan_id","in":"query","required":false,"description":"Filter subscription items by plan ID","schema":{"type":"string","description":"Filter subscription items by plan ID"}},{"name":"include_free","in":"query","required":false,"description":"Whether to include free plan subscription items","schema":{"type":"boolean","default":false,"description":"Whether to include free plan subscription items"}},{"name":"query","in":"query","required":false,"description":"Search query to filter subscription items by email, user first name, user last name, or organization name. Supports partial matching.","schema":{"type":"string","description":"Search query to filter subscription items by email, user first name, user last name, or organization name. Supports partial matching."}},{"name":"user_id","in":"query","required":false,"description":"Filter subscription items by user ID","schema":{"type":"string","description":"Filter subscription items by user ID"}},{"name":"organization_id","in":"query","required":false,"description":"Filter subscription items by organization ID","schema":{"type":"string","description":"Filter subscription items by organization ID"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/security:clerk/cancel-commerce-subscription-item":{"post":{"operationId":"security_clerk_cancel_commerce_subscription_item","summary":"Cancel a subscription item","description":"DELETE /commerce/subscription_items/{subscription_item_id}","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["subscription_item_id"],"properties":{"subscription_item_id":{"type":"string","description":"The ID of the subscription item to cancel"},"end_now":{"type":"boolean","default":false,"description":"Whether to cancel the subscription immediately (true) or at the end of the current billing period (false, default)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:clerk/extend-billing-subscription-item-free-trial":{"post":{"operationId":"security_clerk_extend_billing_subscription_item_free_trial","summary":"Extend free trial for a subscription item","description":"POST /billing/subscription_items/{subscription_item_id}/extend_free_trial","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["subscription_item_id","body"],"properties":{"subscription_item_id":{"type":"string","description":"The ID of the subscription item to extend the free trial for"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:clerk/create-billing-price-transition":{"post":{"operationId":"security_clerk_create_billing_price_transition","summary":"Create a price transition for a subscription item","description":"POST /billing/subscription_items/{subscription_item_id}/price_transition","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["subscription_item_id","body"],"properties":{"subscription_item_id":{"type":"string","description":"The ID of the subscription item to transition"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:clerk/apply-billing-subscription-item-discount":{"post":{"operationId":"security_clerk_apply_billing_subscription_item_discount","summary":"Apply a discount to a subscription item","description":"POST /billing/subscription_items/{subscription_item_id}/discounts","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["subscription_item_id","body"],"properties":{"subscription_item_id":{"type":"string","description":"The ID of the subscription item to apply the discount to"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:clerk/remove-billing-subscription-item-discount":{"post":{"operationId":"security_clerk_remove_billing_subscription_item_discount","summary":"Remove a discount from a subscription item","description":"DELETE /billing/subscription_items/{subscription_item_id}/discounts/{discount_id}","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["subscription_item_id","discount_id"],"properties":{"subscription_item_id":{"type":"string","description":"The ID of the subscription item to remove the discount from"},"discount_id":{"type":"string","description":"The ID of the discount to remove"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:clerk/list-organization-permissions":{"get":{"operationId":"security_clerk_list_organization_permissions","summary":"Get a list of all organization permissions","description":"GET /organization_permissions","tags":["security"],"parameters":[{"name":"query","in":"query","required":false,"description":"Returns organization permissions with ID, name, or key that match the given query. Uses exact match for permission ID and partial match…","schema":{"type":"string","description":"Returns organization permissions with ID, name, or key that match the given query. Uses exact match for permission ID and partial match…"}},{"name":"order_by","in":"query","required":false,"description":"Allows to return organization permissions in a particular order. At the moment, you can order the returned permissions by their…","schema":{"type":"string","description":"Allows to return organization permissions in a particular order. At the moment, you can order the returned permissions by their…"}},{"name":"limit","in":"query","required":false,"description":"Applies a limit to the number of results returned. Can be used for paginating the results together with `offset`.","schema":{"type":"integer","default":10,"description":"Applies a limit to the number of results returned. Can be used for paginating the results together with `offset`."}},{"name":"offset","in":"query","required":false,"description":"Skip the first `offset` results when paginating. Needs to be an integer greater or equal to zero. To be used in conjunction with `limit`.","schema":{"type":"integer","default":0,"description":"Skip the first `offset` results when paginating. Needs to be an integer greater or equal to zero. To be used in conjunction with `limit`."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/security:clerk/create-organization-permission":{"post":{"operationId":"security_clerk_create_organization_permission","summary":"Create a new organization permission","description":"POST /organization_permissions","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:clerk/get-organization-permission":{"get":{"operationId":"security_clerk_get_organization_permission","summary":"Get an organization permission","description":"GET /organization_permissions/{permission_id}","tags":["security"],"parameters":[{"name":"permission_id","in":"query","required":true,"description":"The ID of the permission to retrieve","schema":{"type":"string","description":"The ID of the permission to retrieve"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/security:clerk/update-organization-permission":{"post":{"operationId":"security_clerk_update_organization_permission","summary":"Update an organization permission","description":"PATCH /organization_permissions/{permission_id}","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["permission_id","body"],"properties":{"permission_id":{"type":"string","description":"The ID of the permission to update"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:clerk/delete-organization-permission":{"post":{"operationId":"security_clerk_delete_organization_permission","summary":"Delete an organization permission","description":"DELETE /organization_permissions/{permission_id}","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["permission_id"],"properties":{"permission_id":{"type":"string","description":"The ID of the permission to delete"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:clerk/list-role-sets":{"get":{"operationId":"security_clerk_list_role_sets","summary":"Get a list of role sets","description":"GET /role_sets","tags":["security"],"parameters":[{"name":"query","in":"query","required":false,"description":"Returns role sets with ID, name, or key that match the given query. Uses exact match for role set ID and partial match for name and key.","schema":{"type":"string","description":"Returns role sets with ID, name, or key that match the given query. Uses exact match for role set ID and partial match for name and key."}},{"name":"order_by","in":"query","required":false,"description":"Allows to return role sets in a particular order. At the moment, you can order the returned role sets by their `created_at`, `name`, or…","schema":{"type":"string","default":"-created_at","description":"Allows to return role sets in a particular order. At the moment, you can order the returned role sets by their `created_at`, `name`, or…"}},{"name":"limit","in":"query","required":false,"description":"Applies a limit to the number of results returned. Can be used for paginating the results together with `offset`.","schema":{"type":"integer","default":10,"description":"Applies a limit to the number of results returned. Can be used for paginating the results together with `offset`."}},{"name":"offset","in":"query","required":false,"description":"Skip the first `offset` results when paginating. Needs to be an integer greater or equal to zero. To be used in conjunction with `limit`.","schema":{"type":"integer","default":0,"description":"Skip the first `offset` results when paginating. Needs to be an integer greater or equal to zero. To be used in conjunction with `limit`."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/security:clerk/create-role-set":{"post":{"operationId":"security_clerk_create_role_set","summary":"Create a role set","description":"POST /role_sets","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:clerk/get-role-set":{"get":{"operationId":"security_clerk_get_role_set","summary":"Retrieve a role set","description":"GET /role_sets/{role_set_key_or_id}","tags":["security"],"parameters":[{"name":"role_set_key_or_id","in":"query","required":true,"description":"The key or ID of the role set","schema":{"type":"string","description":"The key or ID of the role set"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/security:clerk/update-role-set":{"post":{"operationId":"security_clerk_update_role_set","summary":"Update a role set","description":"PATCH /role_sets/{role_set_key_or_id}","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["role_set_key_or_id","body"],"properties":{"role_set_key_or_id":{"type":"string","description":"The key or ID of the role set to update"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:clerk/replace-role-set":{"post":{"operationId":"security_clerk_replace_role_set","summary":"Replace a role set","description":"POST /role_sets/{role_set_key_or_id}/replace","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["role_set_key_or_id","body"],"properties":{"role_set_key_or_id":{"type":"string","description":"The key or ID of the role set to replace"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:clerk/add-roles-to-role-set":{"post":{"operationId":"security_clerk_add_roles_to_role_set","summary":"Add roles to a role set","description":"POST /role_sets/{role_set_key_or_id}/roles","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["role_set_key_or_id","body"],"properties":{"role_set_key_or_id":{"type":"string","description":"The key or ID of the role set"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:clerk/replace-role-in-role-set":{"post":{"operationId":"security_clerk_replace_role_in_role_set","summary":"Replace a role in a role set","description":"POST /role_sets/{role_set_key_or_id}/roles/replace","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["role_set_key_or_id","body"],"properties":{"role_set_key_or_id":{"type":"string","description":"The key or ID of the role set"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:clerk/create-admin-portal-link-token":{"post":{"operationId":"security_clerk_create_admin_portal_link_token","summary":"Create an Admin Portal Link Token","description":"POST /admin_portal_link_tokens","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:clerk/revoke-admin-portal-link-token":{"post":{"operationId":"security_clerk_revoke_admin_portal_link_token","summary":"Revoke an Admin Portal Link Token","description":"POST /admin_portal_link_tokens/{adminPortalLinkTokenID}/revoke","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["adminPortalLinkTokenID","body"],"properties":{"adminPortalLinkTokenID":{"type":"string"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:clerk/get-api-keys":{"get":{"operationId":"security_clerk_get_api_keys","summary":"Get API Keys","description":"GET /api_keys","tags":["security"],"parameters":[{"name":"type","in":"query","required":false,"schema":{"type":"string","default":"api_key"}},{"name":"subject","in":"query","required":true,"schema":{"type":"string"}},{"name":"include_invalid","in":"query","required":false,"schema":{"type":"string","enum":["true","false"],"default":"false"}},{"name":"limit","in":"query","required":false,"schema":{"type":"number","default":10}},{"name":"offset","in":"query","required":false,"schema":{"type":"number","default":0}},{"name":"query","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/security:clerk/create-api-key":{"post":{"operationId":"security_clerk_create_api_key","summary":"Create an API Key","description":"POST /api_keys","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:clerk/get-api-key":{"get":{"operationId":"security_clerk_get_api_key","summary":"Get an API Key by ID","description":"GET /api_keys/{apiKeyID}","tags":["security"],"parameters":[{"name":"apiKeyID","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/security:clerk/update-api-key":{"post":{"operationId":"security_clerk_update_api_key","summary":"Update an API Key","description":"PATCH /api_keys/{apiKeyID}","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["apiKeyID","body"],"properties":{"apiKeyID":{"type":"string"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:clerk/delete-api-key":{"post":{"operationId":"security_clerk_delete_api_key","summary":"Delete an API Key","description":"DELETE /api_keys/{apiKeyID}","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["apiKeyID"],"properties":{"apiKeyID":{"type":"string"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:clerk/get-api-key-secret":{"get":{"operationId":"security_clerk_get_api_key_secret","summary":"Get an API Key Secret","description":"GET /api_keys/{apiKeyID}/secret","tags":["security"],"parameters":[{"name":"apiKeyID","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/security:clerk/revoke-api-key":{"post":{"operationId":"security_clerk_revoke_api_key","summary":"Revoke an API Key","description":"POST /api_keys/{apiKeyID}/revoke","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["apiKeyID","body"],"properties":{"apiKeyID":{"type":"string"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:clerk/verify-api-key":{"post":{"operationId":"security_clerk_verify_api_key","summary":"Verify an API Key","description":"POST /api_keys/verify","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:clerk/get-m2-mtokens":{"get":{"operationId":"security_clerk_get_m2_mtokens","summary":"Get M2M Tokens","description":"GET /m2m_tokens","tags":["security"],"parameters":[{"name":"subject","in":"query","required":true,"schema":{"type":"string"}},{"name":"revoked","in":"query","required":false,"schema":{"type":"boolean","default":false}},{"name":"expired","in":"query","required":false,"schema":{"type":"boolean","default":false}},{"name":"limit","in":"query","required":false,"schema":{"type":"number","default":10}},{"name":"offset","in":"query","required":false,"schema":{"type":"number","default":0}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/security:clerk/create-m2-mtoken":{"post":{"operationId":"security_clerk_create_m2_mtoken","summary":"Create a M2M Token","description":"POST /m2m_tokens","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:clerk/revoke-m2-mtoken":{"post":{"operationId":"security_clerk_revoke_m2_mtoken","summary":"Revoke a M2M Token","description":"POST /m2m_tokens/{m2m_token_id}/revoke","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["m2m_token_id","body"],"properties":{"m2m_token_id":{"type":"string"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:clerk/verify-m2-mtoken":{"post":{"operationId":"security_clerk_verify_m2_mtoken","summary":"Verify a M2M Token","description":"POST /m2m_tokens/verify","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:clerk/verify-oauth-access-token":{"post":{"operationId":"security_clerk_verify_oauth_access_token","summary":"Verify an OAuth Access Token","description":"POST /oauth_applications/access_tokens/verify","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}