{
  "opencollection": "1.0.0",
  "info": {
    "name": "Alianza End User API",
    "version": "2"
  },
  "items": [
    {
      "info": {
        "name": "End User",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get end user list",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.d2.alianza.com/v2/partition/:partitionId/account/:accountId/user",
            "headers": [
              {
                "name": "X-AUTH-TOKEN",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "partitionId",
                "value": "",
                "type": "path",
                "description": "ID of partition"
              },
              {
                "name": "accountId",
                "value": "",
                "type": "path",
                "description": "ID of account"
              },
              {
                "name": "limitedData",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Use to retrieve a list of end users. limitedData is provided to enable large result sets retreived without long retrieval times"
        },
        {
          "info": {
            "name": "Create end user",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.d2.alianza.com/v2/partition/:partitionId/account/:accountId/user",
            "headers": [
              {
                "name": "X-AUTH-TOKEN",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "partitionId",
                "value": "",
                "type": "path",
                "description": "ID of partition"
              },
              {
                "name": "accountId",
                "value": "",
                "type": "path",
                "description": "ID of account"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Use to create a end user"
        },
        {
          "info": {
            "name": "Prevalidate the end user's email address before saving the end user",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.d2.alianza.com/v2/partition/:partitionId/account/:accountId/user/prevalidate/email/:email",
            "headers": [
              {
                "name": "X-AUTH-TOKEN",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "partitionId",
                "value": "",
                "type": "path",
                "description": "ID of partition"
              },
              {
                "name": "accountId",
                "value": "",
                "type": "path",
                "description": "ID of account"
              },
              {
                "name": "email",
                "value": "",
                "type": "path"
              },
              {
                "name": "userId",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Use to prevalidate the email address. If the user hasn't been created yet, use as is. If the User already exists, provide qualified query param `userId`"
        },
        {
          "info": {
            "name": "End User activation",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.d2.alianza.com/v2/partition/:partitionId/account/:accountId/user/activation",
            "headers": [
              {
                "name": "X-AUTH-TOKEN",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "partitionId",
                "value": "",
                "type": "path",
                "description": "ID of partition"
              },
              {
                "name": "accountId",
                "value": "",
                "type": "path",
                "description": "ID of account"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "(DEPRECATED) Use to create a new end user/device/csr to an existing account"
        },
        {
          "info": {
            "name": "Retrieve end user",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.d2.alianza.com/v2/partition/:partitionId/account/:accountId/user/:userId",
            "headers": [
              {
                "name": "X-AUTH-TOKEN",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "partitionId",
                "value": "",
                "type": "path",
                "description": "ID of partition"
              },
              {
                "name": "accountId",
                "value": "",
                "type": "path",
                "description": "ID of account"
              },
              {
                "name": "userId",
                "value": "",
                "type": "path",
                "description": "ID of end-user"
              },
              {
                "name": "idType",
                "value": "",
                "type": "query",
                "description": "Defines if the Id is the userid for the username"
              }
            ]
          },
          "docs": "Use to retrieve a end user"
        },
        {
          "info": {
            "name": "Update end user",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.d2.alianza.com/v2/partition/:partitionId/account/:accountId/user/:userId",
            "headers": [
              {
                "name": "X-AUTH-TOKEN",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "partitionId",
                "value": "",
                "type": "path",
                "description": "ID of partition"
              },
              {
                "name": "accountId",
                "value": "",
                "type": "path",
                "description": "ID of account"
              },
              {
                "name": "userId",
                "value": "",
                "type": "path",
                "description": "ID of end-user"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Use to update a end user"
        },
        {
          "info": {
            "name": "Update end user",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.d2.alianza.com/v2/partition/:partitionId/account/:accountId/user/:userId",
            "headers": [
              {
                "name": "X-AUTH-TOKEN",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "partitionId",
                "value": "",
                "type": "path",
                "description": "ID of partition"
              },
              {
                "name": "accountId",
                "value": "",
                "type": "path",
                "description": "ID of account"
              },
              {
                "name": "userId",
                "value": "",
                "type": "path",
                "description": "ID of end-user"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Use to update a end user"
        },
        {
          "info": {
            "name": "Delete end user",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.d2.alianza.com/v2/partition/:partitionId/account/:accountId/user/:userId",
            "headers": [
              {
                "name": "X-AUTH-TOKEN",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "partitionId",
                "value": "",
                "type": "path",
                "description": "ID of partition"
              },
              {
                "name": "accountId",
                "value": "",
                "type": "path",
                "description": "ID of account"
              },
              {
                "name": "userId",
                "value": "",
                "type": "path",
                "description": "ID of end-user"
              }
            ]
          },
          "docs": "Use to delete a end user"
        },
        {
          "info": {
            "name": "Send welcome email to user",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.d2.alianza.com/v2/partition/:partitionId/account/:accountId/user/:userId/send-welcome-email",
            "headers": [
              {
                "name": "X-AUTH-TOKEN",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "partitionId",
                "value": "",
                "type": "path",
                "description": "ID of partition"
              },
              {
                "name": "accountId",
                "value": "",
                "type": "path",
                "description": "ID of account"
              },
              {
                "name": "userId",
                "value": "",
                "type": "path",
                "description": "ID of end-user"
              }
            ]
          },
          "docs": "Use to send a welcome email to the user"
        },
        {
          "info": {
            "name": "Change Calling Plan",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.d2.alianza.com/v2/partition/:partitionId/account/:accountId/user/:userId/callingplanproduct/:callingPlanProductId",
            "headers": [
              {
                "name": "X-AUTH-TOKEN",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "partitionId",
                "value": "",
                "type": "path",
                "description": "ID of partition"
              },
              {
                "name": "accountId",
                "value": "",
                "type": "path",
                "description": "ID of account"
              },
              {
                "name": "userId",
                "value": "",
                "type": "path",
                "description": "ID of end-user"
              },
              {
                "name": "callingPlanProductId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "DEPRECATED USE account/{accountId}/callingplan INSTEAD -- Will add a pending calling plan.  If a pending calling plan already exists it will remove it and set the new calling plan"
        },
        {
          "info": {
            "name": "Change Calling Plan Immediately",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.d2.alianza.com/v2/partition/:partitionId/account/:accountId/user/:userId/callingplanswap",
            "headers": [
              {
                "name": "X-AUTH-TOKEN",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "partitionId",
                "value": "",
                "type": "path",
                "description": "ID of partition"
              },
              {
                "name": "accountId",
                "value": "",
                "type": "path",
                "description": "ID of account"
              },
              {
                "name": "userId",
                "value": "",
                "type": "path",
                "description": "ID of end-user"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "DEPRECATED USE account/{accountId}/callingplan INSTEAD -- Will swap the active calling plan immediately for the specified calling plan"
        },
        {
          "info": {
            "name": " Cancel Pending Callingplan",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.d2.alianza.com/v2/partition/:partitionId/account/:accountId/user/:userId/cancelpendingcallingplan",
            "headers": [
              {
                "name": "X-AUTH-TOKEN",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "partitionId",
                "value": "",
                "type": "path",
                "description": "ID of partition"
              },
              {
                "name": "accountId",
                "value": "",
                "type": "path",
                "description": "ID of account"
              },
              {
                "name": "userId",
                "value": "",
                "type": "path",
                "description": "ID of end-user"
              }
            ]
          },
          "docs": "DEPRECATED USE account/{accountId}/callingplan INSTEAD -- Will cancel any pending calling plan"
        },
        {
          "info": {
            "name": "Retrieve end user voicemail",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.d2.alianza.com/v2/partition/:partitionId/account/:accountId/user/:userId/voicemail",
            "headers": [
              {
                "name": "X-AUTH-TOKEN",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "partitionId",
                "value": "",
                "type": "path",
                "description": "ID of partition"
              },
              {
                "name": "accountId",
                "value": "",
                "type": "path",
                "description": "ID of account"
              },
              {
                "name": "userId",
                "value": "",
                "type": "path",
                "description": "ID of end-user"
              }
            ]
          },
          "docs": "Use to retrieve a end user's voicemail"
        },
        {
          "info": {
            "name": "Unlock end user voicemail",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.d2.alianza.com/v2/partition/:partitionId/account/:accountId/user/:userId/unlockvm",
            "headers": [
              {
                "name": "X-AUTH-TOKEN",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "partitionId",
                "value": "",
                "type": "path",
                "description": "ID of partition"
              },
              {
                "name": "accountId",
                "value": "",
                "type": "path",
                "description": "ID of account"
              },
              {
                "name": "userId",
                "value": "",
                "type": "path",
                "description": "ID of end-user"
              },
              {
                "name": "resetPin",
                "value": "",
                "type": "query",
                "description": "New voicemail Pin"
              }
            ]
          },
          "docs": "Use to unlock a end user's voicemail"
        },
        {
          "info": {
            "name": "Reset end user password",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.d2.alianza.com/v2/partition/:partitionId/account/:accountId/user/:userId/resetpassword",
            "headers": [
              {
                "name": "X-AUTH-TOKEN",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "partitionId",
                "value": "",
                "type": "path",
                "description": "ID of partition"
              },
              {
                "name": "accountId",
                "value": "",
                "type": "path",
                "description": "ID of account"
              },
              {
                "name": "userId",
                "value": "",
                "type": "path",
                "description": "ID of end-user"
              }
            ]
          },
          "docs": "Use to reset the password of a end user"
        },
        {
          "info": {
            "name": "Repurpose an existing user to be a different user (end user swap)",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.d2.alianza.com/v2/partition/:partitionId/account/:accountId/user/:userId/repurpose",
            "headers": [
              {
                "name": "X-AUTH-TOKEN",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "partitionId",
                "value": "",
                "type": "path",
                "description": "ID of partition"
              },
              {
                "name": "accountId",
                "value": "",
                "type": "path",
                "description": "ID of account"
              },
              {
                "name": "userId",
                "value": "",
                "type": "path",
                "description": "ID of end-user"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Use to reuse a user for a new user"
        }
      ]
    }
  ],
  "bundled": true
}