Update and Get User Details

Updates and gets user details.

Gets user details.

Path Parameters

  • userIdstringrequired

    Unique Identifier (UUID) for OpsRamp user

  • tenantIdstringrequired

    Describes the clientId or mspId of the tenant

Responses

  • loginNamestring

    User login name.

  • lastNamestring

    User last name

  • firstNamestring

    User first name.

  • emailstring

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

  • idstring

  • changePasswordboolean

  • designationstring

    User designation.

  • addressstring

    User address.

  • citystring

    City name.

  • statestring

    State name.

  • zipstring

    Zip code.

  • countrystring

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

  • altEmailstring

  • phoneNumberstring

    User phone number.

  • mobileNumberstring

    User mobile number.

  • timeZoneobject

    Time zone of the country. Use the Get Timezones API to get the list of timezones.

  • userNotificationsarray

    Email to which the alert and report notifications are sent.

  • rolesarray

    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.

  • userGroupsarray

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

  • passwordstring

    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

  • userAccountTypestring

    User account type: - REGULAR - BUSINESS

    Enum:
    REGULARBUSINESS
  • userGroupTypestring

    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

    Enum:
    ALLNONE
  • authTypestring

  • statusstring

  • orgIdstring

  • profileImageobject

  • organizationNamestring

  • createdTimestring

  • updatedTimestring

  • lockedboolean

    The user locked status

Loading Examples...

Updates user details.

Path Parameters

  • userIdstringrequired

    Unique Identifier (UUID) for OpsRamp user

  • tenantIdstringrequired

    Describes the clientId or mspId of the tenant

Request Body

application/json

  • loginNamestring

    User login name.

  • lastNamestring

    User last name

  • firstNamestring

    User first name.

  • emailstring

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

  • idstring

  • changePasswordboolean

  • designationstring

    User designation.

  • addressstring

    User address.

  • citystring

    City name.

  • statestring

    State name.

  • zipstring

    Zip code.

  • countrystring

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

  • altEmailstring

  • phoneNumberstring

    User phone number.

  • mobileNumberstring

    User mobile number.

  • timeZoneobject

    Time zone of the country. Use the Get Timezones API to get the list of timezones.

  • userNotificationsarray

    Email to which the alert and report notifications are sent.

  • rolesarray

    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.

  • userGroupsarray

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

  • passwordstring

    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

  • userAccountTypestring

    User account type: - REGULAR - BUSINESS

    Enum:
    REGULARBUSINESS
  • userGroupTypestring

    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

    Enum:
    ALLNONE
  • authTypestring

  • statusstring

  • orgIdstring

  • profileImageobject

  • organizationNamestring

  • createdTimestring

  • updatedTimestring

Loading Examples...

Responses

  • loginNamestring

    User login name.

  • lastNamestring

    User last name

  • firstNamestring

    User first name.

  • emailstring

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

  • idstring

  • changePasswordboolean

  • designationstring

    User designation.

  • addressstring

    User address.

  • citystring

    City name.

  • statestring

    State name.

  • zipstring

    Zip code.

  • countrystring

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

  • altEmailstring

  • phoneNumberstring

    User phone number.

  • mobileNumberstring

    User mobile number.

  • timeZoneobject

    Time zone of the country. Use the Get Timezones API to get the list of timezones.

  • userNotificationsarray

    Email to which the alert and report notifications are sent.

  • rolesarray

    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.

  • userGroupsarray

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

  • passwordstring

    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

  • userAccountTypestring

    User account type: - REGULAR - BUSINESS

    Enum:
    REGULARBUSINESS
  • userGroupTypestring

    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

    Enum:
    ALLNONE
  • authTypestring

  • statusstring

  • orgIdstring

  • profileImageobject

  • organizationNamestring

  • createdTimestring

  • updatedTimestring

Loading Examples...