Versions Compared

Old Version 3

changes.mady.by.user Stonebranch

Saved on

compared with

New Version 4

changes.mady.by.user Stonebranch

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...


Description

URI

http://host_name/uc/resources/user/list

HTTP Method

GET

Description

Retrieves information on all Users.

Example URI

http://localhost:8080/uc/resources/user/list

Authentication

HTTP Basic

Produces Content-Type

application/xml, application/json

Example

See List Users: XML and JSON Examples.

User Properties

See #User Properties.

User Permission Properties

See User Permission Properties.

User Role Properties

See User Role Properties.

Optionally Include Personal Access Tokens on User Payloads: List User

...

API

The User Read and List API’s optionally allows to display the tokens using the query parameter. The default value is false and user has to pass the parameter to view the token details.


 Description

URI

http://host_name/uc/resources/user/list

HTTP Method

GET

Description

List the user tokens

Example URI

http://localhost:9090/uc/resources/user/list?username=test&showTokens=true

http://localhost:9090/uc/resources/user/list?userid=1234567&showTokens=false

Authentication

HTTP Basic

Produces Content-Type

Application/XML, Application/JSON

Consumes Content-Type


Example Responses

  • Status 200

    • Successful user details

  • Status 400

    • Error message.

  • Status 403

    • Operation prohibited due to security constraints.

  • Status 404

    • A user with name “{name}” does not exist.

    • A user with id "{uuid}" does not exist.

  • Status 500

    • Unexpected request failure. See log(s) for more details.

Optinally Include Personal Access Tokens on List User Payloads: Query Parameters

The following request parameters will be needed for the service.

Property

UI Field Name

Description

Specifications

Required

Mutually Exclusive With

userid

N/A

UUID of the user

UUID of the user

Y

username

username

N/A

User Name

String value of User name

Y

userid

showTokens

N/A

Show tokens

Boolean

  • True - Includes the Token details

  • False (Default) - Empty Token List

N


Anchor
List Users XML and JSON Examples
List Users XML and JSON Examples
List Users: XML and JSON Examples

...

Anchor
Read a User URI Parameters
Read a User URI Parameters
Read a User: URI Parameters

Name

Description

Specifications

Required

Mutually Exclusive With

userid

Unique ID for this User.


Y
(unless username
is specified)

username

username

Name used within the Controller to identify this User.

Maximum 40 alphanumerics.

Y
(unless userid
is specified)

userid

Optionally Include Personal Access Tokens on User Payloads: Read User

...

API

The User Read and List API’s optionally allows to display the tokens using the query parameter. The default value is false and user has to pass the parameter to view the token details.


 Description

URI

http://host_name/uc/resources/user

HTTP Method

GET

Description

List the user tokens

Example URI

http://localhost:9090/uc/resources/user?username=test&showTokens=true

http://localhost:9090/uc/resources/user?userid=1234567&showTokens=false

Authentication

HTTP Basic

Produces Content-Type

Application/XML, Application/JSON

Consumes Content-Type


Example Responses

  • Status 200

    • Successful user details

  • Status 400

    • Error message.

  • Status 403

    • Operation prohibited due to security constraints.

  • Status 404

    • A user with name “{name}” does not exist.

    • A user with id "{uuid}" does not exist.

  • Status 500

    • Unexpected request failure. See log(s) for more details.

Optinally Include Personal Access Tokens on Read a User Payloads: Query Parameters

The following request parameters will be needed for the service.

Property

UI Field Name

Description

Specifications

Required

Mutually Exclusive With

userid

N/A

UUID of the user

UUID of the user

Y

username

username

N/A

User Name

String value of User name

Y

userid

showTokens

N/A

Show tokens

Boolean

  • True - Includes the Token details

  • False (Default) - Empty Token List

N



Anchor
Revoke Personal Access Token
Revoke Personal Access Token
Revoke Personal Access Token

...