Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

StartUserAccessTasks

Starts the tasks to search user access status for a specific email address.

The tasks are stopped when the user access status data is found. The tasks are terminated when the API calls to the application time out.

Request Syntax


POST /useraccess/start HTTP/1.1
Content-type: application/json

{
   "appBundleIdentifier": "string",
   "email": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

appBundleIdentifier

The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1011.

Pattern: arn:.+$|^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}

Required: Yes

email

The email address of the target user.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 320.

Pattern: [a-zA-Z0-9.!#$%&’*+/=?^_`{|}~-]+@[a-zA-Z0-9-]+(?:\.[a-zA-Z0-9-]+)*

Required: Yes

Response Syntax


HTTP/1.1 201
Content-type: application/json

{
   "userAccessTasksList": [ 
      { 
         "app": "string",
         "error": { 
            "errorCode": "string",
            "errorMessage": "string"
         },
         "taskId": "string",
         "tenantId": "string"
      }
   ]
}

Response Elements

If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

userAccessTasksList

Contains a list of user access task information.

Type: Array of UserAccessTaskItem objects

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You are not authorized to perform this operation.

HTTP Status Code: 403

InternalServerException

The request processing has failed because of an unknown error, exception, or failure with an internal server.

HTTP Status Code: 500

ResourceNotFoundException

The specified resource does not exist.

HTTP Status Code: 404

ThrottlingException

The request rate exceeds the limit.

HTTP Status Code: 429

ValidationException

The request has invalid or missing parameters.

HTTP Status Code: 400