Permissions - Add

Reference

Service:: Azure AI Services

API Version:: 2.0

Adds a user to the allowed list of users to access this LUIS application. Users are added using their email address.

POST {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
email	string	The email address of the user.

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 Add User To Access List

Sample request

HTTP

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


{
  "email": "guest@outlook.com"
}

Sample response

Status code:: 200

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

Definitions

Name	Description
ErrorResponse	Error response when invoking an operation on the API.
OperationStatus	Response of an Operation status.
OperationStatusType	Status Code.
UserCollaborator

ErrorResponse

Error response when invoking an operation on the API.

Name	Type	Description
errorType	string

OperationStatus

Response of an Operation status.

Name	Type	Description
code	OperationStatusType	Status Code.
message	string	Status details.

OperationStatusType

Status Code.

Name	Type	Description
FAILED	string
Failed	string
Success	string

UserCollaborator

Name	Type	Description
email	string	The email address of the user.

Share via