Endpoint
/api/v2/tenants/{orgId}/users/{userId}

Gets user details.

Path Parameters
orgId
string

mspId defined for the tenant

userId
string

Unique Identifier (UUID) for OpsRamp user

Responses

OK

address
string

(Optional) User address.

altEmail
string

authType
string

changePassword
boolean

city
string

(Optional) City name.

country
string

Country name. To get the list of countries, use Get Countries API.

createdTime
string

designation
string

(Optional) User designation.

email
string

Email of the user. (Alert and report notifications are sent to the email address.)

firstName
string

User first name.

id
string

lastName
string

User last name

loginName
string

User login name.

mobileNumber
string

(Optional) User mobile number.

orgId
string

organizationName
string

password
string

Password must have a minimum of 7 characters with at least: - One number (0-9) - One special character (#,!, $,*) - One lowercase (a-z) - One uppercase (A-Z) character

phoneNumber
string

(Optional) User phone number.

profileImage
object

profileImage.logoPath
profileImage.thumbPath
profileImage.tinyThumbPath
roles
array

(Optional) Defines permission sets to user and user groups on devices and device groups. Assign roles to a user. See Search Roles API to get roles created under a partner or client.

roles.id
roles.name
state
string

(Optional) State name.

status
string

timeZone
object

Time zone of the country. Use the Get Timezones API to get the list of timezones. Example: "timeZone": { "code": "EST"}

timeZone.code
timeZone.id
timeZone.label
timeZone.name
updatedTime
string

userAccountType
string

(Optional) User account type: - REGULAR - BUSINESS

userGroupType
string

(Optional) Assign users to all user groups, or specific users groups. A user can also be an individual user, NOT being part of any user group. Supported Values: ALL, NONE - If a user should be part of all user groups, provide userGroupType: ALL - If a user should be part of a specific user group, provide user group name. Example:"userGroups": [{ "name": "Luminalto Admins" }] - If a user should NOT be part of any user group, provide userGroupType: NONE

userGroups
array

(Optional) Assign users to specific user groups. Provide name of the user group.Use Search User Groups API to get details of user groups.

userGroups.name
userGroups.uniqueId
userNotifications
array

(Optional) Email to which the alert and report notifications are sent.

userNotifications.notifyInputType
userNotifications.notifyMethod
userNotifications.notifyRecurringReport
userNotifications.notifyType
zip
string

(Optional) Zip code.

{
  "address": "300 BOYLSTON AVE E",
  "altEmail": "scarletjohn@gmail.com",
  "authType": "LOCAL",
  "city": "SEATTLE",
  "country": "USA",
  "createdTime": "2016-07-23T16:30:49+0000",
  "designation": "Operations Admin User",
  "email": "scarlet@gmail.com",
  "firstName": "Scarlet",
  "id": "USR0000000014",
  "lastName": "John",
  "loginName": "ScarletJohn",
  "mobileNumber": "833-731-1540",
  "orgId": "client_8",
  "organizationName": "Ops Lab",
  "permissions": [
    "ADMINISTRATION",
    "LAUNCH_POWER_CYCLE",
    "REPORTS_VIEW",
    "MONITORS_VIEW",
    "PATCH_APPROVAL_MANAGE",
    "DEVICE_VIEW",
    "REPORTS_VIEW",
    "TICKETS_MANAGE",
    "DEVICE_VIEW",
    "SERVICE_CATALOG_VIEW",
    "ADMINISTRATION",
    "REPORTS_VIEW",
    "CLIENT",
    "CLIENT_ADMIN"
  ],
  "phoneNumber": "206-232-4543 Extn 1",
  "profileImage": {
    "logoPath": "https://yourdomain.com/img/nophoto.gif",
    "thumbPath": "https://yourdomain.com/img/nophoto.gif",
    "tinyThumbPath": "https://yourdomain.com/img/wall_img1.gif"
  },
  "roles": [
    {
      "id": 4,
      "name": "Client Administrator"
    },
    {
      "id": 5,
      "name": "Client User"
    },
    {
      "id": 9,
      "name": "End User View"
    },
    {
      "id": 10,
      "name": "ACS Client Administrator"
    },
    {
      "id": 14,
      "name": "AM Link Client Administrator"
    },
    {
      "id": 32,
      "name": "AM Link Client User"
    }
  ],
  "state": "WA",
  "status": "active",
  "timeZone": {
    "code": "GMT",
    "id": "12",
    "label": "Greenwich Mean Time",
    "name": "GMT"
  },
  "twoFactor": {
    "provider": "TOTP"
  },
  "twoFactorAuthentication": true,
  "updatedTime": "2017-11-15T12:17:02+0000",
  "userAccountType": "REGULAR",
  "userGroups": [
    {
      "createdTime": "2016-06-23T16:46:02+0000",
      "description": "All Luminalto Admins",
      "email": "luminaltoadmins@gmail.com",
      "name": "Luminalto Admins",
      "uniqueId": "USRGRP-ab5afe06-0cca-9b8f-6053-357531f7d9ff",
      "updatedTime": "2017-07-06T10:59:17+0000"
    },
    {
      "createdTime": "2016-07-23T16:46:41+0000",
      "description": "All operations admins",
      "email": "opsadmin@gmail.com",
      "name": "Operations Lab Escalation Users",
      "uniqueId": "USRGRP-13cfc012-bb01-bbe3-6ed9-c46a192d0567",
      "updatedTime": "2017-10-06T06:40:51+0000"
    }
  ],
  "userNotifications": [
    {
      "notifyInputType": "Primary Email",
      "notifyMethod": "Email",
      "notifyRecurringReport": false,
      "notifyType": "Account Information"
    },
    {
      "notifyMethod": "No Notify",
      "notifyRecurringReport": false,
      "notifyType": "Alert Notification"
    },
    {
      "notifyMethod": "No Notify",
      "notifyRecurringReport": false,
      "notifyType": "Report Notification"
    }
  ],
  "zip": "98102"
}
Endpoint
/api/v2/tenants/{orgId}/users/{userId}

Updates user details.

Path Parameters
orgId
string

mspId defined for the tenant

userId
string

Unique Identifier (UUID) for OpsRamp user

address
string

(Optional) User address.

altEmail
string

authType
string

changePassword
boolean

city
string

(Optional) City name.

country
string

Country name. To get the list of countries, use Get Countries API.

createdTime
string

designation
string

(Optional) User designation.

email
string

Email of the user. (Alert and report notifications are sent to the email address.)

firstName
string

User first name.

id
string

lastName
string

User last name

loginName
string

User login name.

mobileNumber
string

(Optional) User mobile number.

orgId
string

organizationName
string

password
string

Password must have a minimum of 7 characters with at least: - One number (0-9) - One special character (#,!, $,*) - One lowercase (a-z) - One uppercase (A-Z) character

phoneNumber
string

(Optional) User phone number.

profileImage
object

profileImage.logoPath
profileImage.thumbPath
profileImage.tinyThumbPath
roles
array

(Optional) Defines permission sets to user and user groups on devices and device groups. Assign roles to a user. See Search Roles API to get roles created under a partner or client.

roles.id
roles.name
state
string

(Optional) State name.

status
string

timeZone
object

Time zone of the country. Use the Get Timezones API to get the list of timezones. Example: "timeZone": { "code": "EST"}

timeZone.code
timeZone.id
timeZone.label
timeZone.name
updatedTime
string

userAccountType
string

(Optional) User account type: - REGULAR - BUSINESS

userGroupType
string

(Optional) Assign users to all user groups, or specific users groups. A user can also be an individual user, NOT being part of any user group. Supported Values: ALL, NONE - If a user should be part of all user groups, provide userGroupType: ALL - If a user should be part of a specific user group, provide user group name. Example:"userGroups": [{ "name": "Luminalto Admins" }] - If a user should NOT be part of any user group, provide userGroupType: NONE

userGroups
array

(Optional) Assign users to specific user groups. Provide name of the user group.Use Search User Groups API to get details of user groups.

userGroups.name
userGroups.uniqueId
userNotifications
array

(Optional) Email to which the alert and report notifications are sent.

userNotifications.notifyInputType
userNotifications.notifyMethod
userNotifications.notifyRecurringReport
userNotifications.notifyType
zip
string

(Optional) Zip code.

{
  "address": "300 BOYLSTON AVE E",
  "altEmail": "scarletjohn@gmail.com",
  "city": "SEATTLE",
  "country": "United States",
  "designation": "Architect",
  "email": "scarlet@gmail.com",
  "firstName": "Scarlet",
  "lastName": "John",
  "loginName": "Scarlet.John",
  "mobileNumber": "206-232-4543",
  "password": "ChangeMe@1234",
  "phoneNumber": "206-232-4543",
  "roles": [
    {
      "name": "ACS Client Administrator"
    },
    {
      "name": "FULL PERMISSIONS-CLIENT"
    }
  ],
  "state": "WA",
  "timeZone": {
    "code": "EST"
  },
  "userGroups": [
    {
      "name": "ACS Admins"
    },
    {
      "name": "Design Department"
    }
  ],
  "userNotifications": [
    {
      "notifyInputType": "Primary Email",
      "notifyMethod": "Email",
      "notifyRecurringReport": true,
      "notifyType": "Account Information"
    },
    {
      "notifyInputType": "Alternate Email",
      "notifyMethod": "No Notify",
      "notifyRecurringReport": false,
      "notifyType": "Alert Notification"
    },
    {
      "notifyInputType": "Primary Email",
      "notifyMethod": "Email",
      "notifyRecurringReport": true,
      "notifyType": "Report Notification"
    }
  ],
  "zip": "98102"
}

Responses

OK