How can we help?

Searching:

0 results found

Users/Get (List)

GET /odata/Users/

Description

Gets a list of all the users of the application specified in this request, in the appId property, as described below. If the appId specifies a Master Application, then the users of that Master Application and the users of all the sub-Applications of that Application are returned.

To get the details of a specific user, refer to Users/Get (Specific).

See the following for request and response details ‒

See Also

Request ‒ Users/Get (List)

Property Type Description Mandatory
appId String A unique Application identifier that is automatically generated by Axonize. This is the identifier of the Application to which this user is assigned.

This identifier is automatically generated by Axonize when the Application/Post request is used.

The Token or the Client ID/Client Secret used as the authentication in the request header specifies the application(s) to which this user is allowed access.

Y

Example JSON Users/Get (List) Request

curl -X GET \

  https://api.stg.axonize.com/odata/users/ \

  -H ‘Authorization: Token’ \

  -H ‘Content-Type: application/json’ \

  -H ‘appId: 801A048A-9F23-429F-BF0D-B6D35B22771E’

Response ‒ Users/Get (List)

For each user, the response provides the properties in Users/Post.

 

Example JSON Users/Get (List) Response

Status 200 ‒ OK

{

    “@odata.context”: “http://stg-axonizeapi-axonize.stg-ase-axonize.p.azurewebsites.net/odata/$metadata#Users”,

    “value”: [

        {

            “email”: “axonize@axonize.com”,

            “username”: “testuser”,

            “tenantId”: “5851631d4e41925b98f01234”,

            “role”: “admin”,

            “mobilePhone”: null,

            “cultureInfo”: null,

            “status”: “Activated”,

            “id”: “5851631f4e41925b98f01234”,

            “appId”: “801A048A-9F23-429F-BF0D-B6D35B22771E”,

            “createDate”: “0001-01-01T00:00:00Z”,

            “createUser”: null,

            “updateDate”: “0001-01-01T00:00:00Z”,

            “updateUser”: null

        },

        {

            “email”: “axonize1@axonize.com”,

            “username”: “testuser1”,

            “tenantId”: “5851631d4e41925b98f01234”,

            “role”: “admin”,

            “mobilePhone”: “+”,

            “cultureInfo”: null,

            “status”: “Activated”,

            “id”: “592139084d27e710e80f1234”,

            “appId”: “801A048A-9F23-429F-BF0D-B6D35B22771E”,

         “tokenId”: “ABD123”,

            “createDate”: “2017-05-21T06:51:52.771Z”,

            “createUser”: “5851631e4e41925b98f01234”,

            “updateDate”: “0001-01-01T00:00:00Z”,

            “updateUser”: null

        }

]

}