https://docs.au.xarios.cloud/enterprise-portal/en-us/api/reference/accounts/customers/users/ Recent content in Customer Users on Enterprise Hugo -- gohugo.io https://docs.au.xarios.cloud/enterprise-portal/en-us/api/reference/accounts/customers/users/usersgetall/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.au.xarios.cloud/enterprise-portal/en-us/api/reference/accounts/customers/users/usersgetall/ Get All # Gets all Users for a Customer tenant. GET /v1.0/accounts/{ACCOUNT_TENANT_ID}/customers/{CUSTOMER_TENANT_ID}/users Example # This request will get all the Users of the given Customer tenant. Request # GET https://api.au.myreports.cloud/api/v1.0/accounts/{ACCOUNT_TENANT_ID}/customers/{CUSTOMER_TENANT_ID}/users HTTP/1.1 Authorization: Bearer {TOKEN} Response # HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 Content-Length: xx { "page_size": 2, "data": [{ "id": "{USER_ID_1}", "displayName": "User 1", "email": "user1@example.com", "primaryTenant": "{CUSTOMER_TENANT_ID}", "isParent": false }, { "id": "{USER_ID_2}", "displayName": "User 2", "email": "user2@example. https://docs.au.xarios.cloud/enterprise-portal/en-us/api/reference/accounts/customers/users/usersgetuser/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.au.xarios.cloud/enterprise-portal/en-us/api/reference/accounts/customers/users/usersgetuser/ Get User # Gets an existing User from a Customer tenant. GET /v1.0/accounts/{ACCOUNT_TENANT_ID}/customers/{CUSTOMER_TENANT_ID}/users/{USER_ID} Example # This request will get the specific User within the Customer tenant. Request # GET https://api.au.myreports.cloud/api/v1.0/accounts/{ACCOUNT_TENANT_ID}/customers/{CUSTOMER_TENANT_ID}/users/{USER_ID} HTTP/1.1 Authorization: Bearer {TOKEN} Response # HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 Content-Length: xx { "data": { "id": "{USER_ID}", "displayName": "Customer 1", "email": "user1@example.com", "primaryTenant": "{CUSTOMER_TENANT_ID}", "isParent": false, "roles": [ "customer.user", "customer.user.supervisorl3" ] }, "status": "success", "timestamp": "2019-01-01T10:00:00. https://docs.au.xarios.cloud/enterprise-portal/en-us/api/reference/accounts/customers/users/userspost/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.au.xarios.cloud/enterprise-portal/en-us/api/reference/accounts/customers/users/userspost/ Create User # Creates a new User assigned to a Customer tenant. POST /v1.0/accounts/{ACCOUNT_TENANT_ID}/customers/{CUSTOMER_TENANT_ID}/users Remarks # Whenever a new User is created they will be given the "customer.user" role that allows them to login to the Customer portal. This will also send out an activation email to the address provided as soon as the User is created. Example # This request will create a new User with the following details: https://docs.au.xarios.cloud/enterprise-portal/en-us/api/reference/accounts/customers/users/userspatch/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.au.xarios.cloud/enterprise-portal/en-us/api/reference/accounts/customers/users/userspatch/ Patch User # Updates a specific set of properties of a User. This uses the JSON Patch format for any changes. PATCH /v1.0/accounts/{ACCOUNT_TENANT_ID}/customers/{CUSTOMER_TENANT_ID}/users/{USER_ID} Hand Left warning When patching the roles against a user, be careful if using the REPLACE operation. With the replace operation, the user's current roles will be replaced with the values provided in the patch request. Any role not provided in the patch request will be removed from the user (with the exception of the PBX user role which is synchronized from the PBX). https://docs.au.xarios.cloud/enterprise-portal/en-us/api/reference/accounts/customers/users/userdevices/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.au.xarios.cloud/enterprise-portal/en-us/api/reference/accounts/customers/users/userdevices/ Update User Device # This endpoint allows existing devices to be assigned (or removed) as softphone devices for a user for ~.UcClient.~ Desktop, Mobile & WebRTC. Assign a Device PUT /v1.0/accounts/{ACCOUNT_TENANT_ID}/customers/{CUSTOMER_TENANT_ID}/users/{USER_ID}/devices/pbx/{DEVICE_ID}/assign Unassign a Device PUT /v1.0/accounts/{ACCOUNT_TENANT_ID}/customers/{CUSTOMER_TENANT_ID}/users/{USER_ID}/devices/pbx/{DEVICE_ID}/unassign The Body of the request needs to contain a single JSON property to indicate which type of client the device is being assigned to: { "clientType": "desktop" } Valid clientType values: https://docs.au.xarios.cloud/enterprise-portal/en-us/api/reference/accounts/customers/users/usersdelete/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.au.xarios.cloud/enterprise-portal/en-us/api/reference/accounts/customers/users/usersdelete/ Delete User # Deletes an existing User from the Customer tenant. If this is a user's non primary tenant, it will remove them only from this tenant. They will still have access to any other Customer they are assigned. If this is the user's primary tenant, it will remove them from ALL other Customer tenants and delete the User account. Request # DELETE /v1.0/accounts/{ACCOUNT_TENANT_ID}/customers/{CUSTOMER_TENANT_ID}/users/{USER_ID} Example # This request will delete the specific User within the Customer tenant. https://docs.au.xarios.cloud/enterprise-portal/en-us/api/reference/accounts/customers/users/userssendactivationlink/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.au.xarios.cloud/enterprise-portal/en-us/api/reference/accounts/customers/users/userssendactivationlink/ Send New User Email # Sends a Welcome email link to an existing User. POST /v1.0/accounts/{ACCOUNT_TENANT_ID}/customers/{CUSTOMER_TENANT_ID}/users/{USER_ID}/sendActivationEmail Document note This will be done automatically if the sendNewUserEmail property is enabled on the customer account. Example # This request will get send an activations link to this User within the Customer tenant. Hand Left warning Activation emails can only be sent from the User's primary tenant. https://docs.au.xarios.cloud/enterprise-portal/en-us/api/reference/accounts/customers/users/userssenducemail/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.au.xarios.cloud/enterprise-portal/en-us/api/reference/accounts/customers/users/userssenducemail/ Send Unified Communications Welcome Email # Sends a welcome email to a user when they are enabled to use a unified communications client. POST /v1.0/accounts/{ACCOUNT_TENANT_ID}/customers/{CUSTOMER_TENANT_ID}/users/{USER_ID}/sendUConnectActivationEmail Document note This will be done automatically if the sendConnectWelcomeEmail property is enabled on the customer account. Example # This request will get send an activations link to this User within the Customer tenant. Hand Left warning