Scopes

Scopes are permissions required to perform actions in a specified Deepgram Project. Scopes can be associated with Keys or Users. When associated with a Key, Scopes determine the actions that the Key can be used to perform in the Key’s associated Project. When associated with a Member, Scopes determine what the user can do in their assigned Project. For more information, see Working with Roles.

Get Member Scopes

Lists the specified project scopes assigned to the specified member. If the authenticated account has access to the members:read:scopes, admins:read:scopes, and owners:read:scopes project scopes, it will retrieve project scopes for any member of the specified project. Otherwise, it will retrieve project scopes for only the authenticated account.

Required account scope(s): account:read, project:read. Required project scope(s): project:read. Optional project scope(s): members:read:scopes, admins:read:scopes, owners:read:scopes.

Path Parameters

project_id: uuid

Identifier of the project that contains the member for whom you want to get scopes.

member_id: uuid

Unique identifier of the member for whom you want to get scopes.

Responses

Status	Description
200 Success	Scopes found.

Response Schema

scopes: array

Array of scopes associated with the member.

endpoint

GET /projects/{project_id}/members/{member_id}/scopes

Get Member Scopes

curl --request GET \
	--url 'https://api.deepgram.com/v1/projects/{project_id}/members/{member_id}/scopes' \
	--header 'Authorization: Token <YOUR_DEEPGRAM_API_KEY>' \
	--header 'content-type: application/json'

const http = require("https");

const options = {
	method: "GET",
	hostname: "api.deepgram.com",
	port: null,
	path: "/v1/projects/{project_id}/members/{member_id}/scopes",
	headers: {
		Authorization: "Token <YOUR_DEEPGRAM_API_KEY>",
		"content-type": "application/json",
	},
};

const req = http.request(options, function (res) {
	const chunks = [];

	res.on("data", function (chunk) {
		chunks.push(chunk);
	});

	res.on("end", function () {
		const body = Buffer.concat(chunks);
		console.log(body.toString());
	});
});

req.end();

import http.client

conn = http.client.HTTPSConnection("api.deepgram.com")

headers = {
		'Authorization': "Token <YOUR_DEEPGRAM_API_KEY>",
		'content-type': "application/json"
		}

conn.request("GET", "/v1/projects/{project_id}/members/{member_id}/scopes", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

var client = new RestClient("https://api.deepgram.com/v1/projects/{project_id}/members/{member_id}/scopes");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Token <YOUR_DEEPGRAM_API_KEY>");
request.AddHeader("content-type", "application/json");
IRestResponse response = client.Execute(request);

require 'uri'
require 'net/http'
require 'openssl'

url = URI("https://api.deepgram.com/v1/projects/{project_id}/members/{member_id}/scopes")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Token <YOUR_DEEPGRAM_API_KEY>'
request["content-type"] = 'application/json'

response = http.request(request)
puts response.read_body

<?php

$curl = curl_init();

curl_setopt_array($curl, [
	CURLOPT_URL => "https://api.deepgram.com/v1/projects/{project_id}/members/{member_id}/scopes",
	CURLOPT_RETURNTRANSFER => true,
	CURLOPT_ENCODING => "",
	CURLOPT_MAXREDIRS => 10,
	CURLOPT_TIMEOUT => 30,
	CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
	CURLOPT_CUSTOMREQUEST => "GET",
	CURLOPT_HTTPHEADER => [
		"Authorization: Token <YOUR_DEEPGRAM_API_KEY>",
		"content-type: application/json"
	],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
	echo "cURL Error #:" . $err;
} else {
	echo $response;
}

Response

{
	"scopes": ["string"]
}

Update Scope

Updates the specified project scopes assigned to the specified member.

If the specified member has the scope member or the scope being added is member, the requesting account must have the scope members:write:scopes. If the specified member has the scope admin or the scope being added is admin, the requesting account must have the scope admins:write:scopes. If the specified member has the scope owner or the scope being added is owner, the requesting account must have the scope owners:write:scopes.

If the scope being added is member, admin, or owner, it will replace the existing member, admin, or owner scope of the specified member unless the specified member is the only member with the owner scope. In this case, the request will fail.

If the scope being added is not member, admin, or owner, then the requesting account must also have the scope that it is trying to add to the specified member. For example, if the requesting account tries to add the project:write:settings project scope to a specified member, but the requesting account itself does not have the scope project:write:settings, then the request will fail.

Required account scope(s): project:write. Optional project scope(s): See the description.

Path Parameters

project_id: uuid

Unique identifier of the project that contains the specified member and scope that you want to update.

member_id: uuid

Unique identifier of the member for whom you want to update the scope.

Request Body Schema

scope: string

Scope for the specified member and project.

Responses

Status	Description
200 Success	Scope updated.

Response Schema

message: string

Success message.

endpoint

PUT /projects/{project_id}/members/{member_id}/scopes

Update Scope

curl --request PUT \
	--url 'https://api.deepgram.com/v1/projects/{project_id}/members/{member_id}/scopes' \
	--header 'Authorization: Token <YOUR_DEEPGRAM_API_KEY>' \
	--header 'content-type: application/json' \
	--data '{"scope":"string"}'

const http = require("https");

const options = {
	method: "PUT",
	hostname: "api.deepgram.com",
	port: null,
	path: "/v1/projects/{project_id}/members/{member_id}/scopes",
	headers: {
		"content-type": "application/json",
		Authorization: "Token <YOUR_DEEPGRAM_API_KEY>",
	},
};

const req = http.request(options, function (res) {
	const chunks = [];

	res.on("data", function (chunk) {
		chunks.push(chunk);
	});

	res.on("end", function () {
		const body = Buffer.concat(chunks);
		console.log(body.toString());
	});
});

req.write(JSON.stringify({ scope: "string" }));
req.end();

import http.client

conn = http.client.HTTPSConnection("api.deepgram.com")

payload = "{\"scope\":\"string\"}"

headers = {
		'content-type': "application/json",
		'Authorization': "Token <YOUR_DEEPGRAM_API_KEY>"
		}

conn.request("PUT", "/v1/projects/{project_id}/members/{member_id}/scopes", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

var client = new RestClient("https://api.deepgram.com/v1/projects/{project_id}/members/{member_id}/scopes");
var request = new RestRequest(Method.PUT);
request.AddHeader("content-type", "application/json");
request.AddHeader("Authorization", "Token <YOUR_DEEPGRAM_API_KEY>");
request.AddParameter("application/json", "{\"scope\":\"string\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

require 'uri'
require 'net/http'
require 'openssl'

url = URI("https://api.deepgram.com/v1/projects/{project_id}/members/{member_id}/scopes")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Put.new(url)
request["content-type"] = 'application/json'
request["Authorization"] = 'Token <YOUR_DEEPGRAM_API_KEY>'
request.body = "{\"scope\":\"string\"}"

response = http.request(request)
puts response.read_body

<?php

$curl = curl_init();

curl_setopt_array($curl, [
	CURLOPT_URL => "https://api.deepgram.com/v1/projects/{project_id}/members/{member_id}/scopes",
	CURLOPT_RETURNTRANSFER => true,
	CURLOPT_ENCODING => "",
	CURLOPT_MAXREDIRS => 10,
	CURLOPT_TIMEOUT => 30,
	CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
	CURLOPT_CUSTOMREQUEST => "PUT",
	CURLOPT_POSTFIELDS => "{\"scope\":\"string\"}",
	CURLOPT_HTTPHEADER => [
		"Authorization: Token <YOUR_DEEPGRAM_API_KEY>",
		"content-type: application/json"
	],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
	echo "cURL Error #:" . $err;
} else {
	echo $response;
}

Response

{
	"message": "string"
}

Scopes

Get Member Scopes

Path Parameters

Responses

Response Schema

Update Scope

Path Parameters

Request Body Schema

Responses

Response Schema

Share your feedback