> ## Documentation Index
> Fetch the complete documentation index at: https://docs.noresponse.org/llms.txt
> Use this file to discover all available pages before exploring further.

# Restrict an API key.

> Replaces the explicit restrictions on an active key. Restrictions take effect on its next request and survive rotation. The issuer must be able to grant the resulting access in the key environment. A restricted caller cannot remove its own restrictions or grant unrestricted access to another key. Changes are audited without recording the secret.



## OpenAPI

````yaml /openapi.json patch /v1/workspaces/{workspace_id}/keys/{key_id}
openapi: 3.1.0
info:
  title: NoResponse API
  version: '1'
  description: >-
    NoResponse is an identity and people risk engine. Create workspace people,
    start investigations, read complete source evidence and retain job history.
    Groups organize people for screening and contextual review. Account
    assessment uses the same engine for account creation, login and purchase
    decisions.


    Authenticate every request with your API key as `Authorization: Bearer
    nrk_...`. Call the API only from your backend.


    Guides, SDKs and webhook verification are at
    [docs.noresponse.org](https://docs.noresponse.org/). Every error is an RFC
    9457 problem document; see
    [Errors](https://docs.noresponse.org/reference/errors).
servers:
  - url: https://api.noresponse.org
    description: Production
security:
  - tenantBearer: []
tags:
  - name: people
    x-displayName: People
    x-group: People
    description: >-
      Retain people in one workspace environment, with submitted identity,
      expiry and source evidence.
  - name: investigations
    x-displayName: Investigations
    x-group: Investigations
    description: >-
      Start person investigations, read job history and record context-specific
      review decisions.
  - name: assess
    x-displayName: Assessments
    x-group: Assessments
    description: Create, read and list assessments, and report outcomes.
  - name: accounts
    x-displayName: Accounts
    x-group: Accounts
    description: >-
      Each of your accounts holds one current risk, and its assessments are its
      history.
  - name: usage
    x-displayName: Key usage
    x-group: Key usage
    description: >-
      Report usage of the API keys that your account creation gate issued, so a
      shared or stolen key raises its account's risk.
  - name: keys
    x-displayName: API keys
    x-group: API keys
    description: >-
      Rotate your own API key and, with the `management` scope, create, list and
      revoke the keys of its environment.
  - name: settings
    x-displayName: Settings
    x-group: Settings
    description: >-
      Read and preview environment settings, run evaluations, and publish
      reviewed policy with separate permissions.
  - name: lists
    x-displayName: Lists
    x-group: Lists
    description: >-
      Preview, allow or block accounts that use an email or email domain.
      Publishing changes requires policy authority.
  - name: integrations
    x-displayName: Integrations
    x-group: Integrations
    description: >-
      Hosted endpoints that answer your WorkOS, Auth0 or Supabase sign-up and
      sign-in hooks.
  - name: webhooks
    x-displayName: Webhooks
    x-group: Webhooks
    description: Your webhook endpoints, and the signed events NoResponse sends to them.
  - name: workspaces
    x-displayName: Workspaces
    x-group: Workspaces
    description: >-
      Manage non-owner team access, read usage and audit events, configure audit
      streams, and export retained account or audit data.
  - name: requests
    x-displayName: Request diagnostics
    x-group: Request diagnostics
    description: Search retained request attempts and summarize their status and latency.
  - name: groups
    x-displayName: Groups
    x-group: Groups
    description: >-
      Screen a group's people: create the group, upload its list of people,
      start screenings and record a decision on each person.
  - name: reviews
    x-displayName: Reviews
    x-group: Reviews
    description: >-
      Investigate accounts with assignments, comments, linked evidence, saved
      filters and recorded resolutions.
paths:
  /v1/workspaces/{workspace_id}/keys/{key_id}:
    patch:
      tags:
        - keys
      summary: Restrict an API key.
      description: >-
        Replaces the explicit restrictions on an active key. Restrictions take
        effect on its next request and survive rotation. The issuer must be able
        to grant the resulting access in the key environment. A restricted
        caller cannot remove its own restrictions or grant unrestricted access
        to another key. Changes are audited without recording the secret.
      operationId: updateKeyAccess
      parameters:
        - $ref: '#/components/parameters/WorkspaceId'
        - $ref: '#/components/parameters/KeyId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/KeyAccessRequest'
      responses:
        '200':
          $ref: '#/components/responses/KeyUpdated'
        '400':
          $ref: '#/components/responses/InvalidControlRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/ControlForbidden'
        '404':
          $ref: '#/components/responses/WorkspaceNotFound'
        '413':
          $ref: '#/components/responses/PayloadTooLarge'
        '415':
          $ref: '#/components/responses/UnsupportedMediaType'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
      security:
        - tenantBearer: []
      x-codeSamples:
        - lang: curl
          label: cURL
          source: |
            curl --request PATCH \
              --url 'https://api.noresponse.org/v1/workspaces/tnt_01JA2Z8K6Q4V7W9XBCDEFGHJKM/keys/01JA2ZE4K5M6N7P8Q9R0S1T2V3' \
              --header "Authorization: Bearer $NORESPONSE_API_KEY" \
              --header 'Content-Type: application/json' \
              --data '{
              "denied_actions": [
                "policy.publish"
              ]
            }'
        - lang: typescript
          label: TypeScript
          source: |
            import { NoResponse } from "@noresponse/node";

            const noResponse = new NoResponse({
              apiKey: process.env["NORESPONSE_API_KEY"] ?? "",
            });

            async function run() {
              const result = await noResponse.keys.updateAccess({
                workspaceId: "tnt_01JA2Z8K6Q4V7W9XBCDEFGHJKM",
                keyId: "01JA2ZE4K5M6N7P8Q9R0S1T2V3",
                body: {
                  deniedActions: [
                    "policy.publish",
                  ],
                },
              });

              console.log(result);
            }

            run();
        - lang: python
          label: Python
          source: |
            from noresponse import NoResponse
            import os


            with NoResponse(
                api_key=os.getenv("NORESPONSE_API_KEY", ""),
            ) as no_response:

                res = no_response.keys.update_access(workspace_id="tnt_01JA2Z8K6Q4V7W9XBCDEFGHJKM", key_id="01JA2ZE4K5M6N7P8Q9R0S1T2V3", denied_actions=[
                    "policy.publish",
                ])

                # Handle response
                print(res)
        - lang: go
          label: Go
          source: "package main\n\nimport(\n\t\"context\"\n\t\"os\"\n\tnoresponse \"github.com/noresponsehq/go/v14\"\n\t\"github.com/noresponsehq/go/v14/models/components\"\n\t\"log\"\n)\n\nfunc main() {\n    ctx := context.Background()\n\n    s := noresponse.New(\n        noresponse.WithSecurity(os.Getenv(\"NORESPONSE_API_KEY\")),\n    )\n\n    res, err := s.Keys.UpdateAccess(ctx, \"tnt_01JA2Z8K6Q4V7W9XBCDEFGHJKM\", \"01JA2ZE4K5M6N7P8Q9R0S1T2V3\", components.KeyAccessRequest{\n        DeniedActions: []components.KeyAccessRequestDeniedAction{\n            components.KeyAccessRequestDeniedActionPolicyPublish,\n        },\n    })\n    if err != nil {\n        log.Fatal(err)\n    }\n    if res != nil {\n        // handle response\n    }\n}\n"
        - lang: java
          label: Java
          source: |
            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.UpdateKeyAccessResponse;
            import org.noresponse.models.shared.KeyAccessRequest;
            import org.noresponse.models.shared.KeyAccessRequestDeniedAction;

            public class Application {

                public static void main(String[] args) throws Exception {

                    NoResponse sdk = NoResponse.builder()
                            .apiKey(System.getenv().getOrDefault("NORESPONSE_API_KEY", ""))
                        .build();

                    UpdateKeyAccessResponse res = sdk.keys().updateAccess()
                            .workspaceId("tnt_01JA2Z8K6Q4V7W9XBCDEFGHJKM")
                            .keyId("01JA2ZE4K5M6N7P8Q9R0S1T2V3")
                            .body(KeyAccessRequest.builder()
                                .deniedActions(List.of(
                                    KeyAccessRequestDeniedAction.POLICY_PUBLISH))
                                .build())
                            .call();

                    if (res.key().isPresent()) {
                        System.out.println(res.key().get());
                    }
                }
            }
        - lang: csharp
          label: C#
          source: >
            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.Keys.UpdateAccessAsync(
                workspaceId: "tnt_01JA2Z8K6Q4V7W9XBCDEFGHJKM",
                keyId: "01JA2ZE4K5M6N7P8Q9R0S1T2V3",
                body: new KeyAccessRequest() {
                    DeniedActions = new List<KeyAccessRequestDeniedAction>() {
                        KeyAccessRequestDeniedAction.PolicyPublish,
                    },
                }
            );


            // handle response
        - lang: php
          label: PHP
          source: |
            <?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\KeyAccessRequest(
                deniedActions: [
                    Shared\KeyAccessRequestDeniedAction::PolicyPublish,
                ],
            );

            $response = $sdk->keys->updateAccess(
                workspaceId: 'tnt_01JA2Z8K6Q4V7W9XBCDEFGHJKM',
                keyId: '01JA2ZE4K5M6N7P8Q9R0S1T2V3',
                body: $body

            );

            $result = $response->result;
            // handle response
        - lang: ruby
          label: Ruby
          source: >
            require 'noresponse'


            Models = ::NoResponse::Models

            s = ::NoResponse::NoResponseClient.new(
              api_key: ENV.fetch('NORESPONSE_API_KEY', '')
            )

            res = s.keys.update_access(workspace_id:
            'tnt_01JA2Z8K6Q4V7W9XBCDEFGHJKM', key_id:
            '01JA2ZE4K5M6N7P8Q9R0S1T2V3', body:
            Models::Shared::KeyAccessRequest.new(
              denied_actions: [
                Models::Shared::KeyAccessRequestDeniedAction::POLICY_PUBLISH,
              ]
            ))


            unless res.nil?
              # handle response
            end
components:
  parameters:
    WorkspaceId:
      name: workspace_id
      in: path
      required: true
      schema:
        type: string
        pattern: ^[A-Za-z0-9][A-Za-z0-9_.-]{0,122}$
        description: >-
          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.
      description: >-
        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.
    KeyId:
      name: key_id
      in: path
      required: true
      schema:
        type: string
        pattern: ^[0-7][0-9A-HJKMNP-TV-Z]{25}$
        description: The key's public id, a 26-character ULID.
      description: >-
        The key's id. A key of another workspace answers 404, as does a key of
        the other environment to an API key.
  schemas:
    KeyAccessRequest:
      title: API key access request
      type: object
      additionalProperties: false
      required:
        - denied_actions
      properties:
        denied_actions:
          type: array
          maxItems: 3
          uniqueItems: true
          items:
            enum:
              - evidence.read
              - exports.read
              - policy.publish
          description: >-
            Explicit restrictions that override scope grants. An empty list
            restores the access supplied by the scopes. Rotation preserves these
            restrictions.
    Key:
      title: API key
      description: >-
        One API key of a workspace, as the console shows it. A key belongs to
        exactly one environment. Every other field is safe to show.
      type: object
      additionalProperties: false
      required:
        - id
        - workspace_id
        - environment
        - prefix
        - scopes
        - status
        - created_at
      properties:
        id:
          type: string
          pattern: ^[0-7][0-9A-HJKMNP-TV-Z]{25}$
          description: The key's public id, a 26-character ULID.
        workspace_id:
          type: string
          pattern: ^[A-Za-z0-9][A-Za-z0-9_.-]{0,122}$
          description: >-
            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.
        environment:
          enum:
            - live
            - test
          description: >-
            The environment the key belongs to. A live key assesses with live
            sources; a test key answers from the deterministic simulator.
        prefix:
          type: string
          pattern: ^nrk_(live|test)_[0-7][0-9A-HJKMNP-TV-Z]{25}$
          description: >-
            The public start of the credential, nrk_<environment>_<key id>,
            which identifies the key in logs and secret stores without its
            secret.
        scopes:
          type: array
          minItems: 1
          maxItems: 22
          uniqueItems: true
          items:
            enum:
              - assess
              - history
              - delete
              - webhooks
              - detailed
              - integrations
              - management
              - audit
              - usage
              - investigate
              - evidence
              - exports
              - audit_manage
              - settings
              - policy_publish
              - members
              - members_manage
              - groups
              - people
              - people_write
              - investigations
              - decisions
          description: The key's scopes, each at most once.
        status:
          enum:
            - active
            - expired
            - revoked
          description: >-
            active: the key authenticates. expired: a rotation's overlap window
            has ended (expires_at). revoked: the key was revoked (revoked_at)
            and answers 401.
        created_at:
          type: string
          format: date-time
        created_by:
          type: string
          minLength: 1
          maxLength: 256
          pattern: ^[!-~]{1,256}$
          description: >-
            The external user id of the member who created the key through the
            console, or the prefix (nrk_<environment>_<key id>) of the
            management key that created it. Absent for a key NoResponse issued
            or a rotation made.
        expires_at:
          type: string
          format: date-time
          description: >-
            The earlier of the explicit lifetime and any rotation overlap.
            Rotation preserves the original lifetime.
        revoked_at:
          type: string
          format: date-time
        revoked_by:
          type: string
          minLength: 1
          maxLength: 256
          pattern: ^[!-~]{1,256}$
          description: >-
            The external user id of the member who revoked the key through the
            console, or the prefix of the management key that revoked it. Absent
            when the key is not revoked or NoResponse revoked it.
        key:
          type: string
          pattern: >-
            ^nrk_(live|test)_[0-7][0-9A-HJKMNP-TV-Z]{25}_[A-Za-z0-9_-]{42}[AEIMQUYcgkosw048]$
          description: >-
            The credential, nrk_<environment>_<key id>_<secret>. Present only in
            the 201 answer that created the key.
        name:
          type: string
          minLength: 1
          maxLength: 100
          description: >-
            The optional display name supplied for this API key. Preserved on
            rotation.
        purpose:
          type: string
          minLength: 1
          maxLength: 200
          pattern: ^[^\x00-\x1f\x7f-\x9f]+$
          description: >-
            Optional operational purpose, at most 200 printable characters
            without leading or trailing whitespace. Do not put secrets or
            personal data here. Preserved on rotation and included in the
            creation request fingerprint; omitted for older credentials.
        kind:
          enum:
            - service
            - personal
        owner_user_id:
          type: string
          minLength: 1
          maxLength: 256
          pattern: ^[!-~]{1,256}$
          description: >-
            The issuing member's external identity for a personal key. Personal
            ownership is fixed and the key is revoked when that member loses
            authority. Service keys belong to the workspace and omit this field.
        rotated_to:
          type: string
          minLength: 1
          maxLength: 64
          description: >-
            Replacement public key identifier, or legacy when the successor
            predates recorded lineage. This field excludes the secret.
        last_used_at:
          type: string
          format: date-time
          description: >-
            Latest recorded authenticated request observation, updated at most
            once per minute. Capture is best effort after the response and
            includes authenticated requests refused by authorization or rate
            limits. Absence means unknown and does not prove the key was unused.
            It is independent of diagnostic retention and resets on the
            replacement key after rotation. This field retains no raw IP or
            user-agent.
        denied_actions:
          type: array
          maxItems: 3
          uniqueItems: true
          items:
            enum:
              - evidence.read
              - exports.read
              - policy.publish
          description: >-
            Explicit restrictions that override scope grants. An empty list
            restores the access supplied by the scopes. Rotation preserves these
            restrictions.
      $defs:
        key_purpose:
          type: string
          minLength: 1
          maxLength: 200
          pattern: ^[^\x00-\x1f\x7f-\x9f]+$
          description: >-
            Optional operational purpose, at most 200 printable characters
            without leading or trailing whitespace. Do not put secrets or
            personal data here. Preserved on rotation and included in the
            creation request fingerprint; omitted for older credentials.
        key_id:
          type: string
          pattern: ^[0-7][0-9A-HJKMNP-TV-Z]{25}$
          description: The key's public id, a 26-character ULID.
        key_environment:
          enum:
            - live
            - test
          description: >-
            The environment the key belongs to. A live key assesses with live
            sources; a test key answers from the deterministic simulator.
        key_scopes:
          type: array
          minItems: 1
          maxItems: 22
          uniqueItems: true
          items:
            enum:
              - assess
              - history
              - delete
              - webhooks
              - detailed
              - integrations
              - management
              - audit
              - usage
              - investigate
              - evidence
              - exports
              - audit_manage
              - settings
              - policy_publish
              - members
              - members_manage
              - groups
              - people
              - people_write
              - investigations
              - decisions
          description: The key's scopes, each at most once.
        denied_actions:
          type: array
          maxItems: 3
          uniqueItems: true
          items:
            enum:
              - evidence.read
              - exports.read
              - policy.publish
          description: >-
            Explicit restrictions that override scope grants. An empty list
            restores the access supplied by the scopes. Rotation preserves these
            restrictions.
    Problem:
      title: Problem details error
      description: >-
        RFC 9457 problem-details error body returned by every non-2xx API
        response, extended with a stable machine code and request id.
      type: object
      additionalProperties: false
      required:
        - type
        - title
        - status
        - detail
        - code
        - request_id
      properties:
        type:
          type: string
          format: uri-reference
        title:
          type: string
        status:
          type: integer
          minimum: 400
          maximum: 599
        detail:
          type: string
        instance:
          type: string
          format: uri-reference
        code:
          type: string
        request_id:
          type: string
          minLength: 1
        invalid_params:
          type: array
          items:
            type: object
            additionalProperties: false
            required:
              - field
              - reason
            properties:
              field:
                type: string
                minLength: 1
              reason:
                type: string
                minLength: 1
              example:
                type: string
                minLength: 1
  responses:
    KeyUpdated:
      description: >-
        The key with its updated restrictions. Changes take effect on its next
        request.
      headers:
        Cache-Control:
          schema:
            type: string
            const: no-store
          required: true
        X-Request-ID:
          description: The request correlation id, 32 lowercase hexadecimal characters.
          schema:
            type: string
            pattern: ^[0-9a-f]{32}$
            not:
              pattern: \n
          required: true
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Key'
    InvalidControlRequest:
      description: >-
        The body breaks its schema, or a console credential named no valid
        NR-Acting-User.
      headers:
        Cache-Control:
          schema:
            type: string
            const: no-store
          required: true
        X-Request-ID:
          description: The request correlation id, 32 lowercase hexadecimal characters.
          schema:
            type: string
            pattern: ^[0-9a-f]{32}$
            not:
              pattern: \n
          required: true
      content:
        application/problem+json:
          schema:
            allOf:
              - $ref: '#/components/schemas/Problem'
              - properties:
                  status:
                    const: 400
                  code:
                    enum:
                      - invalid_request
    Unauthorized:
      description: No API key, or one that is malformed, unknown, revoked or expired.
      headers:
        Cache-Control:
          schema:
            type: string
            const: no-store
          required: true
        WWW-Authenticate:
          schema:
            type: string
            const: Bearer realm="noresponse-assessments"
          required: true
        X-Request-ID:
          description: The request correlation id, 32 lowercase hexadecimal characters.
          schema:
            type: string
            pattern: ^[0-9a-f]{32}$
            not:
              pattern: \n
          required: true
      content:
        application/problem+json:
          schema:
            allOf:
              - $ref: '#/components/schemas/Problem'
              - properties:
                  status:
                    const: 401
                  code:
                    enum:
                      - unauthorized
    ControlForbidden:
      description: >-
        workspace_forbidden: an API key without the management scope, or any API
        key on a route other than the key, settings and list routes.
        role_forbidden: a console credential's acting user is an active member
        whose role does not grant the operation.
      headers:
        Cache-Control:
          schema:
            type: string
            const: no-store
          required: true
        X-Request-ID:
          description: The request correlation id, 32 lowercase hexadecimal characters.
          schema:
            type: string
            pattern: ^[0-9a-f]{32}$
            not:
              pattern: \n
          required: true
      content:
        application/problem+json:
          schema:
            allOf:
              - $ref: '#/components/schemas/Problem'
              - properties:
                  status:
                    const: 403
                  code:
                    enum:
                      - workspace_forbidden
                      - role_forbidden
    WorkspaceNotFound:
      description: >-
        No such workspace, member, invite, key or environment for the caller. A
        workspace the acting user is not an active member of answers this too,
        as do another workspace and the other environment to an API key, so no
        answer shows which workspaces exist.
      headers:
        Cache-Control:
          schema:
            type: string
            const: no-store
          required: true
        X-Request-ID:
          description: The request correlation id, 32 lowercase hexadecimal characters.
          schema:
            type: string
            pattern: ^[0-9a-f]{32}$
            not:
              pattern: \n
          required: true
      content:
        application/problem+json:
          schema:
            allOf:
              - $ref: '#/components/schemas/Problem'
              - properties:
                  status:
                    const: 404
                  code:
                    enum:
                      - not_found
    PayloadTooLarge:
      description: The body exceeds 32768 bytes. Refused before parsing.
      headers:
        Cache-Control:
          schema:
            type: string
            const: no-store
          required: true
        X-Request-ID:
          description: The request correlation id, 32 lowercase hexadecimal characters.
          schema:
            type: string
            pattern: ^[0-9a-f]{32}$
            not:
              pattern: \n
          required: true
      content:
        application/problem+json:
          schema:
            allOf:
              - $ref: '#/components/schemas/Problem'
              - properties:
                  status:
                    const: 413
                  code:
                    enum:
                      - payload_too_large
    UnsupportedMediaType:
      description: Content-Type is not application/json.
      headers:
        Cache-Control:
          schema:
            type: string
            const: no-store
          required: true
        X-Request-ID:
          description: The request correlation id, 32 lowercase hexadecimal characters.
          schema:
            type: string
            pattern: ^[0-9a-f]{32}$
            not:
              pattern: \n
          required: true
      content:
        application/problem+json:
          schema:
            allOf:
              - $ref: '#/components/schemas/Problem'
              - properties:
                  status:
                    const: 415
                  code:
                    enum:
                      - unsupported_media_type
    ServiceUnavailable:
      description: >-
        The assessment could not be admitted at all (overload, shutdown or a
        dependency down). An assessment that was admitted answers partial or
        pending instead of 503.
      headers:
        Cache-Control:
          schema:
            type: string
            const: no-store
          required: true
        Retry-After:
          description: >-
            Whole seconds to wait before polling or retrying. Required on 202,
            429 and 503.
          schema:
            type: string
            pattern: >-
              ^(?:[1-9]|[1-9][0-9]|[1-9][0-9]{2}|[12][0-9]{3}|3[0-5][0-9]{2}|3600)$
            description: Whole decimal seconds; wait at least this long.
          required: true
        X-Request-ID:
          description: The request correlation id, 32 lowercase hexadecimal characters.
          schema:
            type: string
            pattern: ^[0-9a-f]{32}$
            not:
              pattern: \n
          required: true
      content:
        application/problem+json:
          schema:
            allOf:
              - $ref: '#/components/schemas/Problem'
              - properties:
                  status:
                    const: 503
                  code:
                    enum:
                      - service_unavailable
  securitySchemes:
    tenantBearer:
      type: http
      scheme: bearer
      description: >-
        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.


        `people` reads people, groups and investigations with full evidence by
        default. `people_write` changes submitted people, groups and
        memberships. `investigations` starts or cancels jobs and screenings.
        `decisions` records reviews. `exports` with people-read access exports
        rosters. `delete` deletes people, groups and memberships. Existing
        `groups` keys retain non-destructive people access. Explicit
        `evidence.read` restrictions withhold collected records, posts, media,
        discovered identifiers and notes.


        `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.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.