WOLFRAM

Wolfram Language & System Documentation Center

PermissionsKey["key"]

represents a permissions key that can be used to authorize access to cloud resources.

Details
Details and Options Details and Options
Examples  
Basic Examples  
Scope  
See Also
Related Guides
Related Workflows
History
Cite this Page

PermissionsKey

PermissionsKey["key"]

represents a permissions key that can be used to authorize access to cloud resources.

Details

  • PermissionsKey objects are created by assigning permissions with a PermissionsKey to a cloud object.
  • In cloud access functions, Authentication->PermissionsKey["key"] provides a permissions key credential.
  • In a web request, a query _key=key in the URL can be used to provide a permissions key credential.
  • DeleteObject[PermissionsKey[…]] removes a PermissionsKey object.

Examples

open all close all

Basic Examples  (1)

Create a cloud API with a permissions key:

Wolfram Language code: obj = CloudDeploy[APIFunction[{"n" -> Integer}, #n ^ 2&], Permissions -> {PermissionsKey["thekey"] -> "Execute"}]

Execute the API using the permissions key for authentication:

Wolfram Language code: URLExecute[obj, {"n" -> 123}, Authentication -> PermissionsKey["thekey"]]

Execute the API explicitly giving the permissions key in the URL parameters:

Wolfram Language code: URLExecute[obj, {"n" -> 123, "_key" -> "thekey"}]

Scope  (1)

Remove permissions keys from any cloud objects that are using them:

Wolfram Language code: CloudDeploy[Delayed[RandomInteger[2 ^ 128]], Permissions -> PermissionsKey["altkey"] -> "Execute"]
Wolfram Language code: DeleteObject[PermissionsKey["altkey"]]

Set a permissions key that is universally unique:

Wolfram Language code: SetPermissions[CloudPut[42], PermissionsKey[CreateUUID[]] -> "Read"]
Wolfram Research (2016), PermissionsKey, Wolfram Language function, https://reference.wolfram.com/language/ref/PermissionsKey.html (updated 2017).

Text

Wolfram Research (2016), PermissionsKey, Wolfram Language function, https://reference.wolfram.com/language/ref/PermissionsKey.html (updated 2017).

CMS

Wolfram Language. 2016. "PermissionsKey." Wolfram Language & System Documentation Center. Wolfram Research. Last Modified 2017. https://reference.wolfram.com/language/ref/PermissionsKey.html.

APA

Wolfram Language. (2016). PermissionsKey. Wolfram Language & System Documentation Center. Retrieved from https://reference.wolfram.com/language/ref/PermissionsKey.html

BibTeX

@misc{reference.wolfram_2026_permissionskey, author="Wolfram Research", title="{PermissionsKey}", year="2017", howpublished="\url{https://reference.wolfram.com/language/ref/PermissionsKey.html}", note=[Accessed: 12-June-2026]}

BibLaTeX

@online{reference.wolfram_2026_permissionskey, organization={Wolfram Research}, title={PermissionsKey}, year={2017}, url={https://reference.wolfram.com/language/ref/PermissionsKey.html}, note=[Accessed: 12-June-2026]}