Retrieve a User by username.

get https://qa.connect.calamp.com/connect/services/users/username/{username}

Responses

Response body

object

_self

object

Represents a resource in the system

href

string

required

The URI of the resource this Link represents.

rel

string

required

Relation to the resource represented by the Link, within the context of the containing resource. While a Link represents a specific resource in the system, the 'rel' property defines the type of the association between the containing resource and the linked resource.Except for the 'self', 'first', 'last', 'next', 'prev' relations, generally it is the type of the resource at the other end of the association. E.g. 'asset', 'device', 'pegBehavior, 'role', 'primary-operator', etc.

status

string

Status of the resource represented by this Link.

Enabled Disabled Suspended Deleted Pending_Delete

title

string

Some descriptive text about the Link. Generally name of the resource represented by this Link.

associationStatus

string

Association Status of the resource this link represent with the main(top-level) resource

PENDING DISSOCIATING

source

object

Represents a resource in the system

int64

Required for PUT requests with resource object in the request body. Forbidden for POST requests with resource object in the request body. Will result in an HTTP 400 - Bad Request response if provided in POST request.

username

string

required

Unmodifiable after creation. Maxlength:64 characters

account

object

required

Represents a resource in the system

href

string

required

The URI of the resource this Link represents.

rel

string

required

status

string

Status of the resource represented by this Link.

Enabled Disabled Suspended Deleted Pending_Delete

title

string

Some descriptive text about the Link. Generally name of the resource represented by this Link.

associationStatus

string

Association Status of the resource this link represent with the main(top-level) resource

PENDING DISSOCIATING

source

object

Represents a resource in the system

status

string

Enabled Disabled Suspended Deleted Pending_Delete

firstName

string

First Name of contact. Maxlength:64 characters

lastName

string

Last Name of Contact. Maxlength:64 characters

roles

array of objects

required

List of Roles assigned to this User.

roles*

object

href

string

required

The URI of the resource this Link represents.

rel

string

required

status

string

Status of the resource represented by this Link.

Enabled Disabled Suspended Deleted Pending_Delete

title

string

Some descriptive text about the Link. Generally name of the resource represented by this Link.

associationStatus

string

Association Status of the resource this link represent with the main(top-level) resource

PENDING DISSOCIATING

source

object

Represents a resource in the system

applications

array of objects

List of Applications that this User has access to. Read-only.

applications

object

href

string

required

The URI of the resource this Link represents.

rel

string

required

status

string

Status of the resource represented by this Link.

Enabled Disabled Suspended Deleted Pending_Delete

title

string

Some descriptive text about the Link. Generally name of the resource represented by this Link.

associationStatus

string

Association Status of the resource this link represent with the main(top-level) resource

PENDING DISSOCIATING

source

object

Represents a resource in the system

accountType

string

Default value is 'AUTO'. Maxlength:12 characters. Deprecated.

activationDate

date

yyyy-MM-dd'T'HH:mm:ss.SSSZ. Last time this Device was activated. Maintained by system based on status change. Read-only

addresses

array of objects

List of addresses for the User.

addresses

object

country

string

Name of the country. Max length = 64 characters

block

string

subdistrict

string

subblock

string

houseNumber

string

street2

string

The street2 address. Max length = 128 characters

city

string

required

Required along with StateProvinceCd if a Zip is not provided. Max length = 64 characters

stateProvince

string

Name of the state/province. Max length = 64 characters

countryCd

string

The international country code. If not specified, default 'US' is used. Max length = 3 characters

zip

string

required

Either this field or the City+State fields should be provided for a valid address. Max length = 10 characters

street

string

The street address, including house number. Max length = 128 characters

district

string

stateProvinceCd

string

Required along with City if a Zip is not provided. Max Length = 8 characters.

addressType

string

required

BILLING MAILING SHIPPING

authActivities

array of objects

List of User's latest auth activities.

authActivities

object

account

object

required

Represents a resource in the system

application

object

required

Represents a resource in the system

action

string

Type of User's auth activity.

activityTimestamp

date

yyyy-MM-dd'T'HH:mm:ss.SSSZ. Date/Time when this auth activity occurred.

createdOn

date

yyyy-MM-dd'T'HH:mm:ss.SSSZ. Generated and managed by the service. Read-only.

crmId

string

Crm id of the user. Maxlength:32 characters

deletionDate

date

yyyy-MM-dd'T'HH:mm:ss.SSSZ. Last time this Device was deleted. Maintained by system based on status change. Read-only

description

string

Description of the user. Max Length = 255 characters

string

Valid value required if 'notify' property is set to true on contact. Maxlength:256 characters

extendedAttribute

object

Represents an Extended Attribute in the system

value

string

required

Supplemental data. The application can store any string here as meta-data for a given resource. Max size = 1MB

createdOn

date-time

yyyy-MM-dd'T'HH:mm:ss.SSSZ. When was this extendedAttribute created.

application

object

Represents a resource in the system

lastModifiedOn

date-time

yyyy-MM-dd'T'HH:mm:ss.SSSZ. When was this extendedAttribute last modified.

groups

array of objects

Links to Groups to which the resource belongs.

groups

object

href

string

required

The URI of the resource this Link represents.

rel

string

required

status

string

Status of the resource represented by this Link.

Enabled Disabled Suspended Deleted Pending_Delete

title

string

Some descriptive text about the Link. Generally name of the resource represented by this Link.

associationStatus

string

Association Status of the resource this link represent with the main(top-level) resource

PENDING DISSOCIATING

source

object

Represents a resource in the system

lastModifiedOn

date

yyyy-MM-dd'T'HH:mm:ss.SSSZ. Generated and managed by the server. Read-only

password

string

required

Required for new User creation. This attribute is never returned in response. To just change password /users/{id}/password endpoint can be used too. Maxlength:64 characters

passwordUpdated

boolean

To check the password is updated or not.

phoneNumbers

array of objects

List of phoneNumbers for the Contact.

phoneNumbers

object

extension

string

The an extension to be dialed after main number. Max length = 6 characters

phoneNumber

string

required

Max length = 32 characters

phoneType

string

required

WORK CELL FAX TOLL_FREE

string

Represents the PIN of the user.

preferences

array of objects

Preferences stored for current User-Application pairing.

preferences

object

configuration

string

required

Max size of 4000 characters.

application

object

required

Represents a resource in the system

systemDefined

boolean

systemOfUnits

object

Measurement unit used by this user. Allowed values: ['Device', 'SI', 'Metric', 'US', 'Mixed', 'Imperial'].

value

string

The value of unit of measure.

source

object

Represents a resource in the system

tempPassword

string

Temporary password of the user. Maxlength:64 characters

terminationDate

date

yyyy-MM-dd'T'HH:mm:ss.SSSZ. When this User should be disabled. If the value is in the past, the User will be disabled immediately.Read-only

timeZone

string

The time zone of the User. Maxlength:64 characters

unitOfMeasure

string

Measurement unit used by this user. Read-Only. @Deprecated. Maxlength:32 characters

version

int64

Defaults to 0

Read-only. Managed by the service. Required for PUT, ignored for POST.

400

Invalid request.

403

Not authorized for this operation.

404

User not found.

500

Server error

Language

Credentials


xxxxxxxxxx
1
curl --request GET \
2
     --url https://qa.connect.calamp.com/connect/services/users/username/username \
3
     --header 'accept: */*'

Click Try It! to start a request and see the response here! Or choose an example:

*/*

200successful operation