curl --request POST \
--url 'https://api.noresponse.org/v1/workspaces/tnt_01JA2Z8K6Q4V7W9XBCDEFGHJKM/streams/test' \
--header "Authorization: Bearer $NORESPONSE_API_KEY" \
--header 'Content-Type: application/json' \
--data '{
"endpoint_id": "whe_01JA2Z8K6Q4V7W9XBCDEFGHJKM",
"actions": [
"key.created",
"member.access_changed"
]
}'
import { NoResponse } from "@noresponse/node";
const noResponse = new NoResponse({
apiKey: process.env["NORESPONSE_API_KEY"] ?? "",
});
async function run() {
const result = await noResponse.audit.configureStream({
workspaceId: "tnt_01JA2Z8K6Q4V7W9XBCDEFGHJKM",
environment: "test",
body: {
endpointId: "whe_01JA2Z8K6Q4V7W9XBCDEFGHJKM",
actions: [
"key.created",
"member.access_changed",
],
},
});
console.log(result);
}
run();
from noresponse import NoResponse
import os
with NoResponse(
api_key=os.getenv("NORESPONSE_API_KEY", ""),
) as no_response:
res = no_response.audit.configure_stream(workspace_id="tnt_01JA2Z8K6Q4V7W9XBCDEFGHJKM", environment="test", endpoint_id="whe_01JA2Z8K6Q4V7W9XBCDEFGHJKM", actions=[
"key.created",
"member.access_changed",
])
# Handle response
print(res)
package main
import(
"context"
"os"
noresponse "github.com/noresponsehq/go/v12"
"github.com/noresponsehq/go/v12/models/components"
"log"
)
func main() {
ctx := context.Background()
s := noresponse.New(
noresponse.WithSecurity(os.Getenv("NORESPONSE_API_KEY")),
)
res, err := s.Audit.ConfigureStream(ctx, "tnt_01JA2Z8K6Q4V7W9XBCDEFGHJKM", components.EnvironmentTest, components.AuditStreamRequest{
EndpointID: "whe_01JA2Z8K6Q4V7W9XBCDEFGHJKM",
Actions: []string{
"key.created",
"member.access_changed",
},
})
if err != nil {
log.Fatal(err)
}
if res != nil {
// handle response
}
}
package hello.world;
import java.lang.Exception;
import java.util.List;
import org.noresponse.NoResponse;
import org.noresponse.models.errors.AuthenticationException;
import org.noresponse.models.errors.BadRequestException;
import org.noresponse.models.errors.ConflictException;
import org.noresponse.models.errors.NotFoundException;
import org.noresponse.models.errors.PermissionDeniedException;
import org.noresponse.models.errors.RateLimitException;
import org.noresponse.models.operations.ConfigureAuditStreamResponse;
import org.noresponse.models.shared.AuditStreamRequest;
import org.noresponse.models.shared.Environment;
public class Application {
public static void main(String[] args) throws Exception {
NoResponse sdk = NoResponse.builder()
.apiKey(System.getenv().getOrDefault("NORESPONSE_API_KEY", ""))
.build();
ConfigureAuditStreamResponse res = sdk.audit().configureStream()
.workspaceId("tnt_01JA2Z8K6Q4V7W9XBCDEFGHJKM")
.environment(Environment.TEST)
.body(AuditStreamRequest.builder()
.endpointId("whe_01JA2Z8K6Q4V7W9XBCDEFGHJKM")
.actions(List.of(
"key.created",
"member.access_changed"))
.build())
.call();
if (res.auditStreamList().isPresent()) {
System.out.println(res.auditStreamList().get());
}
}
}
using NoResponse;
using NoResponse.Models.Shared;
using System;
using System.Collections.Generic;
var sdk = new NoResponseClient(apiKey: Environment.GetEnvironmentVariable("NORESPONSE_API_KEY"));
var res = await sdk.Audit.ConfigureStreamAsync(
workspaceId: "tnt_01JA2Z8K6Q4V7W9XBCDEFGHJKM",
environment: NoResponse.Models.Shared.Environment.Test,
body: new AuditStreamRequest() {
EndpointId = "whe_01JA2Z8K6Q4V7W9XBCDEFGHJKM",
Actions = new List<string>() {
"key.created",
"member.access_changed",
},
}
);
// handle response
<?php
declare(strict_types=1);
require 'vendor/autoload.php';
use NoResponse;
use NoResponse\Models\Shared;
$sdk = NoResponse\NoResponseClient::builder()
->setSecurity(
getenv('NORESPONSE_API_KEY') ?: ''
)
->build();
$body = new Shared\AuditStreamRequest(
endpointId: 'whe_01JA2Z8K6Q4V7W9XBCDEFGHJKM',
actions: [
'key.created',
'member.access_changed',
],
);
$response = $sdk->audit->configureStream(
workspaceId: 'tnt_01JA2Z8K6Q4V7W9XBCDEFGHJKM',
environment: Shared\Environment::Test,
body: $body
);
$result = $response->result;
// handle response
require 'noresponse'
Models = ::NoResponse::Models
s = ::NoResponse::NoResponseClient.new(
api_key: ENV.fetch('NORESPONSE_API_KEY', '')
)
res = s.audit.configure_stream(workspace_id: 'tnt_01JA2Z8K6Q4V7W9XBCDEFGHJKM', environment: Models::Shared::Environment::TEST, body: Models::Shared::AuditStreamRequest.new(
endpoint_id: 'whe_01JA2Z8K6Q4V7W9XBCDEFGHJKM',
actions: [
'key.created',
'member.access_changed',
]
))
unless res.nil?
# handle response
end
{
"items": [
{
"endpoint_id": "<string>",
"environment": "live",
"actions": [
"<string>"
],
"created_at": "2023-11-07T05:31:56Z",
"endpoint_state": "unverified",
"last_attempt_at": "2023-11-07T05:31:56Z",
"last_delivered_at": "2023-11-07T05:31:56Z"
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 400,
"detail": "<string>",
"code": "invalid_request",
"request_id": "<string>",
"instance": "<string>",
"invalid_params": [
{
"field": "<string>",
"reason": "<string>",
"example": "<string>"
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 401,
"detail": "<string>",
"code": "unauthorized",
"request_id": "<string>",
"instance": "<string>",
"invalid_params": [
{
"field": "<string>",
"reason": "<string>",
"example": "<string>"
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 403,
"detail": "<string>",
"code": "workspace_forbidden",
"request_id": "<string>",
"instance": "<string>",
"invalid_params": [
{
"field": "<string>",
"reason": "<string>",
"example": "<string>"
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 404,
"detail": "<string>",
"code": "not_found",
"request_id": "<string>",
"instance": "<string>",
"invalid_params": [
{
"field": "<string>",
"reason": "<string>",
"example": "<string>"
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 409,
"detail": "<string>",
"code": "export_conflict",
"request_id": "<string>",
"instance": "<string>",
"invalid_params": [
{
"field": "<string>",
"reason": "<string>",
"example": "<string>"
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 413,
"detail": "<string>",
"code": "payload_too_large",
"request_id": "<string>",
"instance": "<string>",
"invalid_params": [
{
"field": "<string>",
"reason": "<string>",
"example": "<string>"
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 415,
"detail": "<string>",
"code": "unsupported_media_type",
"request_id": "<string>",
"instance": "<string>",
"invalid_params": [
{
"field": "<string>",
"reason": "<string>",
"example": "<string>"
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 429,
"detail": "<string>",
"code": "export_limit_reached",
"request_id": "<string>",
"instance": "<string>",
"invalid_params": [
{
"field": "<string>",
"reason": "<string>",
"example": "<string>"
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 503,
"detail": "<string>",
"code": "service_unavailable",
"request_id": "<string>",
"instance": "<string>",
"invalid_params": [
{
"field": "<string>",
"reason": "<string>",
"example": "<string>"
}
]
}Configure an audit stream
Creates or updates a subscription for an existing, verified webhook endpoint. Register and verify the endpoint before making this call.
Send its endpoint_id and up to 32 action names. An empty actions array accepts every action in the selected environment.
The stream sends immutable audit.event bodies from subscription creation onward. Use an audit export for available earlier events.
Deliveries can repeat and arrive out of order. Deduplicate on the webhook id and verify the signature before processing the body.
Requires audit_manage, in the key’s own workspace and environment.
curl --request POST \
--url 'https://api.noresponse.org/v1/workspaces/tnt_01JA2Z8K6Q4V7W9XBCDEFGHJKM/streams/test' \
--header "Authorization: Bearer $NORESPONSE_API_KEY" \
--header 'Content-Type: application/json' \
--data '{
"endpoint_id": "whe_01JA2Z8K6Q4V7W9XBCDEFGHJKM",
"actions": [
"key.created",
"member.access_changed"
]
}'
import { NoResponse } from "@noresponse/node";
const noResponse = new NoResponse({
apiKey: process.env["NORESPONSE_API_KEY"] ?? "",
});
async function run() {
const result = await noResponse.audit.configureStream({
workspaceId: "tnt_01JA2Z8K6Q4V7W9XBCDEFGHJKM",
environment: "test",
body: {
endpointId: "whe_01JA2Z8K6Q4V7W9XBCDEFGHJKM",
actions: [
"key.created",
"member.access_changed",
],
},
});
console.log(result);
}
run();
from noresponse import NoResponse
import os
with NoResponse(
api_key=os.getenv("NORESPONSE_API_KEY", ""),
) as no_response:
res = no_response.audit.configure_stream(workspace_id="tnt_01JA2Z8K6Q4V7W9XBCDEFGHJKM", environment="test", endpoint_id="whe_01JA2Z8K6Q4V7W9XBCDEFGHJKM", actions=[
"key.created",
"member.access_changed",
])
# Handle response
print(res)
package main
import(
"context"
"os"
noresponse "github.com/noresponsehq/go/v12"
"github.com/noresponsehq/go/v12/models/components"
"log"
)
func main() {
ctx := context.Background()
s := noresponse.New(
noresponse.WithSecurity(os.Getenv("NORESPONSE_API_KEY")),
)
res, err := s.Audit.ConfigureStream(ctx, "tnt_01JA2Z8K6Q4V7W9XBCDEFGHJKM", components.EnvironmentTest, components.AuditStreamRequest{
EndpointID: "whe_01JA2Z8K6Q4V7W9XBCDEFGHJKM",
Actions: []string{
"key.created",
"member.access_changed",
},
})
if err != nil {
log.Fatal(err)
}
if res != nil {
// handle response
}
}
package hello.world;
import java.lang.Exception;
import java.util.List;
import org.noresponse.NoResponse;
import org.noresponse.models.errors.AuthenticationException;
import org.noresponse.models.errors.BadRequestException;
import org.noresponse.models.errors.ConflictException;
import org.noresponse.models.errors.NotFoundException;
import org.noresponse.models.errors.PermissionDeniedException;
import org.noresponse.models.errors.RateLimitException;
import org.noresponse.models.operations.ConfigureAuditStreamResponse;
import org.noresponse.models.shared.AuditStreamRequest;
import org.noresponse.models.shared.Environment;
public class Application {
public static void main(String[] args) throws Exception {
NoResponse sdk = NoResponse.builder()
.apiKey(System.getenv().getOrDefault("NORESPONSE_API_KEY", ""))
.build();
ConfigureAuditStreamResponse res = sdk.audit().configureStream()
.workspaceId("tnt_01JA2Z8K6Q4V7W9XBCDEFGHJKM")
.environment(Environment.TEST)
.body(AuditStreamRequest.builder()
.endpointId("whe_01JA2Z8K6Q4V7W9XBCDEFGHJKM")
.actions(List.of(
"key.created",
"member.access_changed"))
.build())
.call();
if (res.auditStreamList().isPresent()) {
System.out.println(res.auditStreamList().get());
}
}
}
using NoResponse;
using NoResponse.Models.Shared;
using System;
using System.Collections.Generic;
var sdk = new NoResponseClient(apiKey: Environment.GetEnvironmentVariable("NORESPONSE_API_KEY"));
var res = await sdk.Audit.ConfigureStreamAsync(
workspaceId: "tnt_01JA2Z8K6Q4V7W9XBCDEFGHJKM",
environment: NoResponse.Models.Shared.Environment.Test,
body: new AuditStreamRequest() {
EndpointId = "whe_01JA2Z8K6Q4V7W9XBCDEFGHJKM",
Actions = new List<string>() {
"key.created",
"member.access_changed",
},
}
);
// handle response
<?php
declare(strict_types=1);
require 'vendor/autoload.php';
use NoResponse;
use NoResponse\Models\Shared;
$sdk = NoResponse\NoResponseClient::builder()
->setSecurity(
getenv('NORESPONSE_API_KEY') ?: ''
)
->build();
$body = new Shared\AuditStreamRequest(
endpointId: 'whe_01JA2Z8K6Q4V7W9XBCDEFGHJKM',
actions: [
'key.created',
'member.access_changed',
],
);
$response = $sdk->audit->configureStream(
workspaceId: 'tnt_01JA2Z8K6Q4V7W9XBCDEFGHJKM',
environment: Shared\Environment::Test,
body: $body
);
$result = $response->result;
// handle response
require 'noresponse'
Models = ::NoResponse::Models
s = ::NoResponse::NoResponseClient.new(
api_key: ENV.fetch('NORESPONSE_API_KEY', '')
)
res = s.audit.configure_stream(workspace_id: 'tnt_01JA2Z8K6Q4V7W9XBCDEFGHJKM', environment: Models::Shared::Environment::TEST, body: Models::Shared::AuditStreamRequest.new(
endpoint_id: 'whe_01JA2Z8K6Q4V7W9XBCDEFGHJKM',
actions: [
'key.created',
'member.access_changed',
]
))
unless res.nil?
# handle response
end
{
"items": [
{
"endpoint_id": "<string>",
"environment": "live",
"actions": [
"<string>"
],
"created_at": "2023-11-07T05:31:56Z",
"endpoint_state": "unverified",
"last_attempt_at": "2023-11-07T05:31:56Z",
"last_delivered_at": "2023-11-07T05:31:56Z"
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 400,
"detail": "<string>",
"code": "invalid_request",
"request_id": "<string>",
"instance": "<string>",
"invalid_params": [
{
"field": "<string>",
"reason": "<string>",
"example": "<string>"
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 401,
"detail": "<string>",
"code": "unauthorized",
"request_id": "<string>",
"instance": "<string>",
"invalid_params": [
{
"field": "<string>",
"reason": "<string>",
"example": "<string>"
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 403,
"detail": "<string>",
"code": "workspace_forbidden",
"request_id": "<string>",
"instance": "<string>",
"invalid_params": [
{
"field": "<string>",
"reason": "<string>",
"example": "<string>"
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 404,
"detail": "<string>",
"code": "not_found",
"request_id": "<string>",
"instance": "<string>",
"invalid_params": [
{
"field": "<string>",
"reason": "<string>",
"example": "<string>"
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 409,
"detail": "<string>",
"code": "export_conflict",
"request_id": "<string>",
"instance": "<string>",
"invalid_params": [
{
"field": "<string>",
"reason": "<string>",
"example": "<string>"
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 413,
"detail": "<string>",
"code": "payload_too_large",
"request_id": "<string>",
"instance": "<string>",
"invalid_params": [
{
"field": "<string>",
"reason": "<string>",
"example": "<string>"
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 415,
"detail": "<string>",
"code": "unsupported_media_type",
"request_id": "<string>",
"instance": "<string>",
"invalid_params": [
{
"field": "<string>",
"reason": "<string>",
"example": "<string>"
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 429,
"detail": "<string>",
"code": "export_limit_reached",
"request_id": "<string>",
"instance": "<string>",
"invalid_params": [
{
"field": "<string>",
"reason": "<string>",
"example": "<string>"
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 503,
"detail": "<string>",
"code": "service_unavailable",
"request_id": "<string>",
"instance": "<string>",
"invalid_params": [
{
"field": "<string>",
"reason": "<string>",
"example": "<string>"
}
]
}Authorizations
Your API key, sent as Authorization: Bearer <key>. A key is nrk_live_ or nrk_test_, a 26-character key id, _ and a 43-character secret. Account, audit and usage data stay within the key's environment. Dedicated team scopes apply across the workspace.
assess creates and reads assessments, records outcomes and reports key usage. investigate reads accounts, assessment history and request diagnostics without export or enforcement access. The legacy history scope also permits account exports, submitted identifiers and enforcement reports. delete permits account and assessment deletion.
evidence or detailed adds detailed merged evidence and submitted identifiers where the operation permits them. Neither grants access to the underlying resource alone. exports permits exports with the underlying account or audit scope. audit reads audit events and usage reads usage. audit_manage manages audit streams and retention, and includes audit-read and export authority.
webhooks manages webhook endpoints. integrations manages hosted auth-provider integrations. management manages keys, settings, lists, reviews and policy evaluations in the key's environment. New keys cannot exceed the issuer's effective permissions.
settings reads configuration, previews policy and list changes, runs evaluations and changes retention. Publishing decision policy or changing lists requires settings and policy_publish together, or the legacy management scope.
groups creates and reads groups, adds people, starts and cancels screenings and records decisions on people, in the key's environment.
members reads the workspace directory. members_manage also administers non-owner members and invitations. These scopes require a live key issued by a current owner with access to both environments. They grant access across the workspace. management does not grant team access. API keys cannot change owners or accept invitations.
A missing, unknown, revoked or expired key answers 401. A valid key without a required scope answers 403.
Path Parameters
The workspace id. A workspace the acting user is not an active member of answers 404, as do another workspace than an API key's own, a malformed id and a test environment's id. The workspace id, which is also its live environment's workspace id; the test environment's is the same id with:test appended. A workspace created through the API is tnt_ and a 26-character ULID.
^[A-Za-z0-9][A-Za-z0-9_.-]{0,122}$