Share via

Permissions - Update

Service:
Azure AI Services
API Version:
2.0

Replaces the current user access list with the new list sent in the body. If an empty list is sent, all access to other users will be removed.

PUT {Endpoint}/luis/api/v2.0/apps/{appId}/permissions

URI Parameters

Name In Required Type Description
appId
 path True

string (uuid)

The application ID.
Endpoint
 path True

string

Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com).

Request Header

Name Required Type Description
Ocp-Apim-Subscription-Key True

string

Request Body

Name Type Description
emails

string[]

The email address of the users.

Responses

Name Type Description
200 OK

OperationStatus

Successful operation.
Other Status Codes

ErrorResponse

Error Response.

Security

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Examples

Successful Replaces Users From Access List

Sample request

PUT {Endpoint}/luis/api/v2.0/apps/363187f1-c573-46b3-bc4c-ae01d686e68e/permissions


{
  "emails": [
    "guest@outlook.com",
    "invited.user@live.com"
  ]
}

Sample response

Status code:
200 
{
  "code": "Success",
  "message": "Operation Successful"
}

Definitions

Name Description
CollaboratorsArray
ErrorResponse

Error response when invoking an operation on the API.
OperationStatus

Response of an Operation status.
OperationStatusType

Status Code.

CollaboratorsArray

Object
Name Type Description
emails

string[]

The email address of the users.

ErrorResponse

Object

Error response when invoking an operation on the API.

Name Type Description
errorType

string

OperationStatus

Object

Response of an Operation status.

Name Type Description
code

OperationStatusType

Status Code.
message

string

Status details.

OperationStatusType

Enumeration

Status Code.

Value Description
Failed
FAILED
Success