Users

Set the stream access level

Set the stream access levels for the stream of API key with keyid.

If access level for stream is not set the default("*") access level is used. If default("*") access level is also not set the GeoFabric access level is used.

Note: Requires administrator permissions.

put/_api/user/{user}/database/{geofabric}/stream/{stream}

Request

The document declares no server URL.
Auth
- API key in header Authorization
- or HTTP bearer
TypeScript
https://skmtc.dev/macrometa/apis/macrometa-api-reference/docs/_api/user/:user/database/:geofabric/stream/:stream/put.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

userstring string required

The id of the user.

geofabricstring string required

The name of the database.

streamstring string required

The name of the stream.

Request body

grantstring required

Use "rw" to set the GeoFabric access level to Administrate.
Use "ro" to set the GeoFabric access level to Access.
Use "none" to set the database access level to No access.

Example request

{
  "grant": "rw"
}

Response

Successfully set stream access level.

unknown required

Example response

{
  "code": 200,
  "error": false,
  "c8globals.testStream": "ro"
}

Changes

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