API Keys

Set the managed key access level

Sets the access level for the managed key name in the GeoFabric geofabric for an API key with keyid.

Requires a JSON object with these properties:

  • grant: Use "rw" to set the managed key level access to Read/Write. Use "ro" to set the managed key level access to Read Only. Use "none" to set the managed key worker level access to No access.

  • managed keyr: Use "*" to set default access level for all managed keys.

If access level for the managed key is not set, then the default("*") access level is used. If the default("*") access level is also not set, then the GeoFabric access level is used.

Note: Requires administrator permissions.

put/_api/key/{keyid}/database/{geofabric}/managedkey/{managed-key-name}

Request

Path parameters

keyidstring string required

The ID of the API key querying the GeoFabric.

geofabricstring string required

The name of the GeoFabric.

managed-key-namestring string required

The name of the managed key.

Request body

grantstring required
  • Use "rw" to set the managed key level access to Read/Write.
  • Use "ro" to set the managed key level access to Read Only.
  • Use "none" to set the managed key level access to No access.

Example request

{
  "grant": "rw"
}

Response

Successfully changed access permissions.

unknown required

Example response

{
  "code": 200,
  "error": false,
  "_system/testManagedKey": "ro"
}

Changes

No recorded changes to this operation across all 1 revision of this API.