Google Cloud KMS Organizations API

The Organizations API from Google Cloud KMS — 2 operation(s) for organizations.

GitHub OpenAPI

Operations 3

GET /v1/organizations/{organizationsId}/kajPolicyConfig Get kaj policy config organizations #
PATCH /v1/organizations/{organizationsId}/kajPolicyConfig Update kaj policy config organizations #
GET /v1/organizations/{organizationsId}/protectedResources:search Search protectedResources #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/google-cloud-kms:google-cloud-kms-organizations-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

google-cloud-kms-organizations-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Google Cloud Kms Organizations API
  version: v1
  contact:
    name: Google
    url: https://developers.google.com/
  termsOfService: https://developers.google.com/terms
  description: 'Operations tagged Organizations across 2 of this provider''s published API definitions: google-cloud-kms-cloudkms-organizations-api-openapi.yml, google-cloud-kms-kmsinventory-organizations-api-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://cloudkms.googleapis.com
- url: https://kmsinventory.googleapis.com
tags:
- name: Organizations
paths:
  /v1/organizations/{organizationsId}/kajPolicyConfig:
    get:
      operationId: cloudkms.organizations.getKajPolicyConfig
      summary: Get kaj policy config organizations
      description: Gets the KeyAccessJustificationsPolicyConfig for a given organization, folder, or project.
      parameters:
      - name: organizationsId
        in: path
        required: true
        description: Resource name segment (organizationsId).
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KeyAccessJustificationsPolicyConfig'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GoogleRpcError'
          description: 'Client error (google.rpc.Status: INVALID_ARGUMENT, PERMISSION_DENIED, NOT_FOUND ...)'
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GoogleRpcError'
          description: Error response (google.rpc.Status)
      security:
      - oauth2:
        - https://www.googleapis.com/auth/cloud-platform
        - https://www.googleapis.com/auth/cloudkms
      - apiKey: []
      tags:
      - Organizations
    patch:
      operationId: cloudkms.organizations.updateKajPolicyConfig
      summary: Update kaj policy config organizations
      description: Updates the KeyAccessJustificationsPolicyConfig for a given organization, folder, or project.
      parameters:
      - name: organizationsId
        in: path
        required: true
        description: Resource name segment (organizationsId).
        schema:
          type: string
      - name: updateMask
        in: query
        required: false
        description: Optional. Specifies the list of fields to update.
        schema:
          format: google-fieldmask
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/KeyAccessJustificationsPolicyConfig'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KeyAccessJustificationsPolicyConfig'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GoogleRpcError'
          description: 'Client error (google.rpc.Status: INVALID_ARGUMENT, PERMISSION_DENIED, NOT_FOUND ...)'
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GoogleRpcError'
          description: Error response (google.rpc.Status)
      security:
      - oauth2:
        - https://www.googleapis.com/auth/cloud-platform
        - https://www.googleapis.com/auth/cloudkms
      - apiKey: []
      tags:
      - Organizations
    servers:
    - url: https://cloudkms.googleapis.com
  /v1/organizations/{organizationsId}/protectedResources:search:
    get:
      operationId: kmsinventory.organizations.protectedResources.search
      summary: Search protectedResources
      description: Returns metadata about the resources protected by the given Cloud KMS CryptoKey in the given Cloud organization/project.
      parameters:
      - name: organizationsId
        in: path
        required: true
        description: Resource name segment (organizationsId).
        schema:
          type: string
      - name: cryptoKey
        in: query
        required: false
        description: Required. The resource name of the CryptoKey.
        schema:
          type: string
      - name: pageSize
        in: query
        required: false
        description: The maximum number of resources to return. The service may return fewer than this value. If unspecified, at most 500 resources will be returned. The maximum value is 500; values above 500 will be coerced to 500.
        schema:
          type: integer
          format: int32
      - name: pageToken
        in: query
        required: false
        description: A page token, received from a previous KeyTrackingService.SearchProtectedResources call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to KeyTrackingService.SearchProtectedResources must match the call that provided the page token.
        schema:
          type: string
      - name: resourceTypes
        in: query
        required: false
        description: 'Optional. A list of resource types that this request searches for. If empty, it will search all the [trackable resource types](https://cloud.google.com/kms/docs/view-key-usage#tracked-resource-types). Regular expressions are also supported. For example: * `compute.googleapis.com.*` snapshots resources whose type starts with `compute.googleapis.com`. * `.*Image` snapshots resources whose type ends with `Image`. * `.*Image.*` snapshots resources whose type contains `Image`. See [RE2](https://github.com/google/re2/wiki/Syntax) for all supported regular expression syntax. If the regular expression does not match any supported resource type, an INVALID_ARGUMENT error will be returned.'
        schema:
          type: array
          items:
            type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GoogleCloudKmsInventoryV1SearchProtectedResourcesResponse'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GoogleRpcError'
          description: 'Client error (google.rpc.Status: INVALID_ARGUMENT, PERMISSION_DENIED, NOT_FOUND ...)'
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GoogleRpcError'
          description: Error response (google.rpc.Status)
      security:
      - oauth2:
        - https://www.googleapis.com/auth/cloud-platform
      - apiKey: []
      tags:
      - Organizations
    servers:
    - url: https://kmsinventory.googleapis.com
components:
  schemas:
    GoogleRpcError:
      type: object
      description: The error envelope every Google API returns.
      properties:
        error:
          type: object
          properties:
            code:
              type: integer
            message:
              type: string
            status:
              type: string
            details:
              type: array
              items:
                type: object
    KeyAccessJustificationsPolicyConfig:
      description: Represents a singleton configuration for Key Access Justifications policies.
      properties:
        defaultKeyAccessJustificationPolicy:
          $ref: '#/components/schemas/KeyAccessJustificationsPolicy'
          description: Optional. Specifies the default key access justifications (KAJ) policy used when a CryptoKey is created in this folder. This is only used when a Key Access Justifications policy is not provided in the CreateCryptoKeyRequest. This overrides any default policies in its ancestry. If this field is unset, or is set but contains an empty allowed_access_reasons list, no default Key Access Justifications (KAJ) policy configuration is active. In this scenario, all newly created keys will default to an "allow-all" policy.
        name:
          description: Identifier. Represents the resource name for this KeyAccessJustificationsPolicyConfig in the format of "{organizations|folders|projects}/*/kajPolicyConfig".
          type: string
        defaultPolicyAvailable:
          type: boolean
          readOnly: true
          description: Output only. Indicates whether this parent resource is available to default policy feature. Please consult [the prerequisite of default policy feature](https://cloud.google.com/assured-workloads/key-access-justifications/docs/set-default-policy#before) for more details.
      type: object
    KeyAccessJustificationsPolicy:
      type: object
      properties:
        allowedAccessReasons:
          items:
            type: string
            enum:
            - REASON_UNSPECIFIED
            - CUSTOMER_INITIATED_SUPPORT
            - GOOGLE_INITIATED_SERVICE
            - THIRD_PARTY_DATA_REQUEST
            - GOOGLE_INITIATED_REVIEW
            - CUSTOMER_INITIATED_ACCESS
            - GOOGLE_INITIATED_SYSTEM_OPERATION
            - REASON_NOT_EXPECTED
            - MODIFIED_CUSTOMER_INITIATED_ACCESS
            - MODIFIED_GOOGLE_INITIATED_SYSTEM_OPERATION
            - GOOGLE_RESPONSE_TO_PRODUCTION_ALERT
            - CUSTOMER_AUTHORIZED_WORKFLOW_SERVICING
          type: array
          description: The list of allowed reasons for access to a CryptoKey. Note that empty allowed_access_reasons has a different meaning depending on where this message appears. If this is under KeyAccessJustificationsPolicyConfig, it means allow-all. If this is under CryptoKey, it means deny-all.
      description: A KeyAccessJustificationsPolicy specifies zero or more allowed AccessReason values for encrypt, decrypt, and sign operations on a CryptoKey or KeyAccessJustificationsPolicyConfig (the default Key Access Justifications policy).
    GoogleCloudKmsInventoryV1ProtectedResource:
      properties:
        resourceType:
          description: 'Example: `compute.googleapis.com/Disk`'
          type: string
        createTime:
          description: Output only. The time at which this resource was created. The granularity is in seconds. Timestamp.nanos will always be 0.
          readOnly: true
          type: string
          format: google-datetime
        name:
          description: 'The full resource name of the resource. Example: `//compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1`.'
          type: string
        cryptoKeyVersion:
          description: The name of the Cloud KMS [CryptoKeyVersion](https://cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.cryptoKeys.cryptoKeyVersions?hl=en) used to protect this resource via CMEK. This field is empty if the Google Cloud product owning the resource does not provide key version data to Asset Inventory. If there are multiple key versions protecting the resource, then this is same value as the first element of crypto_key_versions.
          type: string
        location:
          description: Location can be `global`, regional like `us-east1`, or zonal like `us-west1-b`.
          type: string
        cloudProduct:
          description: 'The Cloud product that owns the resource. Example: `compute`'
          type: string
        projectId:
          type: string
          description: The ID of the project that owns the resource.
        cryptoKeyVersions:
          items:
            type: string
          description: The names of the Cloud KMS [CryptoKeyVersion](https://cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.cryptoKeys.cryptoKeyVersions?hl=en) used to protect this resource via CMEK. This field is empty if the Google Cloud product owning the resource does not provide key versions data to Asset Inventory. The first element of this field is stored in crypto_key_version.
          type: array
        project:
          description: 'Format: `projects/{PROJECT_NUMBER}`.'
          type: string
        labels:
          description: A key-value pair of the resource's labels (v1) to their values.
          additionalProperties:
            type: string
          type: object
      type: object
      description: Metadata about a resource protected by a Cloud KMS key.
    GoogleCloudKmsInventoryV1SearchProtectedResourcesResponse:
      properties:
        protectedResources:
          type: array
          description: Protected resources for this page.
          items:
            $ref: '#/components/schemas/GoogleCloudKmsInventoryV1ProtectedResource'
        nextPageToken:
          description: A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
          type: string
      type: object
      description: Response message for KeyTrackingService.SearchProtectedResources.
  securitySchemes:
    apiKey:
      type: apiKey
      in: query
      name: key
      description: API key; accepted by methods that do not need user data.
    oauth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://accounts.google.com/o/oauth2/auth
          tokenUrl: https://oauth2.googleapis.com/token
          scopes:
            https://www.googleapis.com/auth/cloud-platform: See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account.
            https://www.googleapis.com/auth/cloudkms: View and manage your keys and secrets stored in Cloud Key Management Service
externalDocs:
  url: https://cloud.google.com/kms/
x-refined-from:
- google-cloud-kms-cloudkms-organizations-api-openapi.yml
- google-cloud-kms-kmsinventory-organizations-api-openapi.yml
x-provenance:
  method: harvested
  publisher: Google
  source: https://cloudkms.googleapis.com/$discovery/rest?version=v1
  note: converted by discovery-to-openapi.py from Google's Discovery document (revision 20261106)