Moogsoft Docs

getUserInfo

A Graze API GET request that returns information about a specified user.

Back to Graze API EndPoint Reference.

Request arguments

Endpoint getUserInfo takes the following request arguments:

Name

Type

Required

Description

auth_token

String

Yes

A valid auth_token returned from the authenticate request. See the authenticate endpoint for more information.

user_id

Number

Yes

ID of the the user to return information about.

username

String

Yes

A valid username.

Response

Endpoint getUserInfo returns the following response:

Successful requests return a JSON object containing the following:

Name

Type

Description

user_id

Number

User ID.

full_name

String

Full name of the user.

Examples

The following examples demonstrate typical use of endpoint getUserInfo:

Request example

Example cURL request to return the information associated with user ID 57:

curl -G -u graze:graze -k -v "https://localhost/graze/v1/getUserInfo" --data-urlencode "user_id=57"

Response example

Example response returning the user information related to user ID 57:

{"full_name":"Lonnie Holmes","user_id":57}