Users and API Keys

Create org API key

Changed on

Mints an org API key. The plaintext token is returned once and never stored.

post/orgs/{orgID}/api-keys

Request

  • Base URL: https://api.omnara.com/v1
  • URL: https://api.omnara.com/v1/orgs/{orgID}/api-keys
  • Auth: API key in cookie __Host-omnara_session and API key in header X-Omnara-Csrf

Request body

namestring required

Human-readable name. Spaces and punctuation are allowed; leading or trailing whitespace and invisible or control characters are not.

org_role'admin' | 'member' required

The key's org role. Org API keys can never hold the owner role.

Response

Org API key created.

tokenstring required

Opaque bearer credential.

Changes

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      removed the authentication_unavailable enum value from the response property for the response status

    • info

      removed the authentication_unavailable enum value from the response property for the response status

    • info

      removed the authentication_unavailable enum value from the response property for the response status

    • info

      removed the authentication_unavailable enum value from the response property for the response status

    • info

      removed the authentication_unavailable enum value from the response property for the response status

    • info

      removed the authentication_unavailable enum value from the response property for the response status

    • info

      removed the authentication_unavailable enum value from the response property for the response status

    • info

      removed the conflict enum value from the response property for the response status

    • info

      removed the conflict enum value from the response property for the response status

    • info

      removed the conflict enum value from the response property for the response status

    • info

      removed the conflict enum value from the response property for the response status

    • info

      removed the conflict enum value from the response property for the response status

    • info

      removed the conflict enum value from the response property for the response status

    • info

      removed the conflict enum value from the response property for the response status

    • info

      removed the csrf_check_failed enum value from the response property for the response status

    • info

      removed the csrf_check_failed enum value from the response property for the response status

    • info

      removed the csrf_check_failed enum value from the response property for the response status

    • info

      removed the csrf_check_failed enum value from the response property for the response status

    • info

      removed the csrf_check_failed enum value from the response property for the response status

    • info

      removed the csrf_check_failed enum value from the response property for the response status

    • info

      removed the csrf_check_failed enum value from the response property for the response status

    • info

      removed the daemon_runtime_unregistered enum value from the response property for the response status

    • info

      removed the daemon_runtime_unregistered enum value from the response property for the response status

    • info

      removed the daemon_runtime_unregistered enum value from the response property for the response status

    • info

      removed the daemon_runtime_unregistered enum value from the response property for the response status

    • info

      removed the daemon_runtime_unregistered enum value from the response property for the response status

    • info

      removed the daemon_runtime_unregistered enum value from the response property for the response status

    • info

      removed the daemon_runtime_unregistered enum value from the response property for the response status

    • info

      removed the forbidden enum value from the response property for the response status

    • info

      removed the forbidden enum value from the response property for the response status

    • info

      removed the forbidden enum value from the response property for the response status

    • info

      removed the forbidden enum value from the response property for the response status

    • info

      removed the forbidden enum value from the response property for the response status

    • info

      removed the forbidden enum value from the response property for the response status

    • info

      removed the forbidden enum value from the response property for the response status

    • info

      removed the gone enum value from the response property for the response status

    • info

      removed the gone enum value from the response property for the response status

    • info

      removed the gone enum value from the response property for the response status

    • info

      removed the gone enum value from the response property for the response status

    • info

      removed the gone enum value from the response property for the response status

    • info

      removed the gone enum value from the response property for the response status

    • info

      removed the gone enum value from the response property for the response status

    • info

      removed the idempotency_key_conflict enum value from the response property for the response status

    • info

      removed the idempotency_key_conflict enum value from the response property for the response status

    • info

      removed the idempotency_key_conflict enum value from the response property for the response status

    • info

      removed the idempotency_key_conflict enum value from the response property for the response status

    • info

      removed the idempotency_key_conflict enum value from the response property for the response status

    • info

      removed the idempotency_key_conflict enum value from the response property for the response status

    • info

      removed the idempotency_key_conflict enum value from the response property for the response status

    • info

      removed the internal_error enum value from the response property for the response status

    • info

      removed the internal_error enum value from the response property for the response status

    • info

      removed the internal_error enum value from the response property for the response status

    • info

      removed the internal_error enum value from the response property for the response status

    • info

      removed the internal_error enum value from the response property for the response status

    • info

      removed the internal_error enum value from the response property for the response status

    • info

      removed the internal_error enum value from the response property for the response status

    • info

      removed the invalid_request enum value from the response property for the response status

    • info

      removed the invalid_request enum value from the response property for the response status

    • info

      removed the invalid_request enum value from the response property for the response status

    • info

      removed the invalid_request enum value from the response property for the response status

    • info

      removed the invalid_request enum value from the response property for the response status

    • info

      removed the invalid_request enum value from the response property for the response status

    • info

      removed the invalid_request enum value from the response property for the response status

    • info

      removed the managed_work_admission_denied enum value from the response property for the response status

    • info

      removed the managed_work_admission_denied enum value from the response property for the response status

    • info

      removed the managed_work_admission_denied enum value from the response property for the response status

    • info

      removed the managed_work_admission_denied enum value from the response property for the response status

    • info

      removed the managed_work_admission_denied enum value from the response property for the response status

    • info

      removed the managed_work_admission_denied enum value from the response property for the response status

    • info

      removed the not_found enum value from the response property for the response status

    • info

      removed the not_found enum value from the response property for the response status

    • info

      removed the not_found enum value from the response property for the response status

    • info

      removed the not_found enum value from the response property for the response status

    • info

      removed the not_found enum value from the response property for the response status

    • info

      removed the not_found enum value from the response property for the response status

    • info

      removed the not_found enum value from the response property for the response status

    • info

      removed the not_wake_capable enum value from the response property for the response status

    • info

      removed the not_wake_capable enum value from the response property for the response status

    • info

      removed the not_wake_capable enum value from the response property for the response status

    • info

      removed the not_wake_capable enum value from the response property for the response status

    • info

      removed the not_wake_capable enum value from the response property for the response status

    • info

      removed the not_wake_capable enum value from the response property for the response status

    • info

      removed the not_wake_capable enum value from the response property for the response status

    • info

      removed the pending_work enum value from the response property for the response status

    • info

      removed the pending_work enum value from the response property for the response status

    • info

      removed the pending_work enum value from the response property for the response status

    • info

      removed the pending_work enum value from the response property for the response status

    • info

      removed the pending_work enum value from the response property for the response status

    • info

      removed the pending_work enum value from the response property for the response status

    • info

      removed the pending_work enum value from the response property for the response status

    • info

      removed the rate_limited enum value from the response property for the response status

    • info

      removed the rate_limited enum value from the response property for the response status

    • info

      removed the rate_limited enum value from the response property for the response status

    • info

      removed the rate_limited enum value from the response property for the response status

    • info

      removed the rate_limited enum value from the response property for the response status

    • info

      removed the rate_limited enum value from the response property for the response status

    • info

      removed the rate_limited enum value from the response property for the response status

    • info

      removed the request_too_large enum value from the response property for the response status

    • info

      removed the request_too_large enum value from the response property for the response status

    • info

      removed the request_too_large enum value from the response property for the response status

    • info

      removed the request_too_large enum value from the response property for the response status

    • info

      removed the request_too_large enum value from the response property for the response status

    • info

      removed the request_too_large enum value from the response property for the response status

    • info

      removed the request_too_large enum value from the response property for the response status

    • info

      removed the service_unavailable enum value from the response property for the response status

    • info

      removed the service_unavailable enum value from the response property for the response status

    • info

      removed the service_unavailable enum value from the response property for the response status

    • info

      removed the service_unavailable enum value from the response property for the response status

    • info

      removed the service_unavailable enum value from the response property for the response status

    • info

      removed the service_unavailable enum value from the response property for the response status

    • info

      removed the service_unavailable enum value from the response property for the response status

    • info

      removed the state_transition_conflict enum value from the response property for the response status

    • info

      removed the state_transition_conflict enum value from the response property for the response status

    • info

      removed the state_transition_conflict enum value from the response property for the response status

    • info

      removed the state_transition_conflict enum value from the response property for the response status

    • info

      removed the state_transition_conflict enum value from the response property for the response status

    • info

      removed the state_transition_conflict enum value from the response property for the response status

    • info

      removed the state_transition_conflict enum value from the response property for the response status

    • info

      removed the unauthorized enum value from the response property for the response status

    • info

      removed the unauthorized enum value from the response property for the response status

    • info

      removed the unauthorized enum value from the response property for the response status

    • info

      removed the unauthorized enum value from the response property for the response status

    • info

      removed the unauthorized enum value from the response property for the response status

    • info

      removed the unauthorized enum value from the response property for the response status

    • info

      removed the unauthorized enum value from the response property for the response status

    • info

      removed the unprocessable enum value from the response property for the response status

    • info

      removed the unprocessable enum value from the response property for the response status

    • info

      removed the unprocessable enum value from the response property for the response status

    • info

      removed the unprocessable enum value from the response property for the response status

    • info

      removed the unprocessable enum value from the response property for the response status

    • info

      removed the unprocessable enum value from the response property for the response status

    • info

      removed the unprocessable enum value from the response property for the response status

    • info

      removed the unsupported_media_type enum value from the response property for the response status

    • info

      removed the unsupported_media_type enum value from the response property for the response status

    • info

      removed the unsupported_media_type enum value from the response property for the response status

    • info

      removed the unsupported_media_type enum value from the response property for the response status

    • info

      removed the unsupported_media_type enum value from the response property for the response status

    • info

      removed the unsupported_media_type enum value from the response property for the response status

    • info

      removed the unsupported_media_type enum value from the response property for the response status

    • info

      removed the upstream_error enum value from the response property for the response status

    • info

      removed the upstream_error enum value from the response property for the response status

    • info

      removed the upstream_error enum value from the response property for the response status

    • info

      removed the upstream_error enum value from the response property for the response status

    • info

      removed the upstream_error enum value from the response property for the response status

    • info

      removed the upstream_error enum value from the response property for the response status

    • info

      removed the upstream_error enum value from the response property for the response status

    • info

      removed the validation_failed enum value from the response property for the response status

    • info

      removed the validation_failed enum value from the response property for the response status

    • info

      removed the validation_failed enum value from the response property for the response status

    • info

      removed the validation_failed enum value from the response property for the response status

    • info

      removed the validation_failed enum value from the response property for the response status

    • info

      removed the validation_failed enum value from the response property for the response status

    • info

      removed the validation_failed enum value from the response property for the response status

    This list may be incomplete.

    • info

      endpoint added