Module Values.CreateWorkspaceApiKeyRequestSource

Creates a Grafana API key for the workspace. This key can be used to authenticate requests sent to the workspace's HTTP API. See https://docs.aws.amazon.com/grafana/latest/userguide/Using-Grafana-APIs.html for available APIs and example requests. In workspaces compatible with Grafana version 9 or above, use workspace service accounts instead of API keys. API keys will be removed in a future release.

Sourcetype nonrec t = {
  1. keyName : ApiKeyName.t;
    (*

    Specifies the name of the key. Keynames must be unique to the workspace.

    *)
  2. keyRole : String_.t;
    (*

    Specifies the permission level of the key. Valid values: ADMIN|EDITOR|VIEWER

    *)
  3. secondsToLive : CreateWorkspaceApiKeyRequestSecondsToLiveInteger.t;
    (*

    Specifies the time in seconds until the key expires. Keys can be valid for up to 30 days.

    *)
  4. workspaceId : WorkspaceId.t;
    (*

    The ID of the workspace to create an API key.

    *)
}
Sourceval context_ : string
Sourceval make : keyName:ApiKeyName.t -> keyRole:String_.t -> secondsToLive:CreateWorkspaceApiKeyRequestSecondsToLiveInteger.t -> workspaceId:WorkspaceId.t -> unit -> t
Sourceval to_value : t -> [> `Structure of (string * [> `Integer of CreateWorkspaceApiKeyRequestSecondsToLiveInteger.t | `String of ApiKeyName.t ]) list ]
Sourceval to_query : t -> Awso.Client.Query.t
Sourceval of_xml : Awso.Xml.t -> t
Sourceval of_string : string -> t
Sourceval of_json : Yojson.Safe.t -> t
Sourceval to_json : t -> Yojson.Safe.t