Search

1.14. http://localhost:7080/rest/user : Api that deals with user related stuff

download PDF

Defining class: org.rhq.enterprise.server.rest.UserHandlerBean

Produces: application/json, application/xml, text/plain, text/html

Methods

  • GET /user/favorites/resource

    Description

    Return a list of favorite resources of the caller

    Supports returning a gzip'ed Content-Encoding

    This method has no parameters

    Return type: ResourceWithType (multi)

  • GET /user/favorites/group

    Description

    Return a list of favorite groups of the caller

    Supports returning a gzip'ed Content-Encoding

    This method has no parameters

    Return type: GroupRest (multi)

  • PUT /user/favorites/resource/{id}

    Description

    Add a resource as favorite for the caller
    Parameters:
    NameP.TypeDescriptionRequiredTypeAllowed valuesDefault value
    id Path Id of the resource true int all

    Return type: void

  • PUT /user/favorites/group/{id}

    Description

    Add a group as favorite for the caller
    Parameters:
    NameP.TypeDescriptionRequiredTypeAllowed valuesDefault value
    id Path Id of the group true int all

    Return type: void

  • DELETE /user/favorites/resource/{id}

    Description

    Remove a resource from favorites

    Notes

    This operation is by default idempotent, returning 204.If you want to check if the resource was a favorite, you need to pass the 'validate' query parameter.

    Parameters:
    NameP.TypeDescriptionRequiredTypeAllowed valuesDefault value
    id Path Id of the resource true int all
    validate Query Validate if the resource is a favorite false boolean all false

    Return type: void

    Error codes:
    CodeReason
    204 Resource was removed or was no favorite with validation not set
    404 Resource was no favorite and validate was set
  • DELETE /user/favorites/group/{id}

    Description

    Remove a group from favorites

    Notes

    This operation is by default idempotent, returning 204.If you want to check if the group was a favorite, you need to pass the 'validate' query parameter.

    Parameters:
    NameP.TypeDescriptionRequiredTypeAllowed valuesDefault value
    id Path Id of the group true int all
    validate Query Validate if the group is a favorite false boolean all false

    Return type: void

    Error codes:
    CodeReason
    204 Group was removed or was no favorite with validation not set
    404 Group was no favorite and validate was set
  • GET /user/{id}

    Description

    Get info about a user
    Parameters:
    NameP.TypeDescriptionRequiredTypeAllowed valuesDefault value
    id Path Login of the user true String all

    Return type: UserRest

Red Hat logoGithubRedditYoutubeTwitter

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

We help Red Hat users innovate and achieve their goals with our products and services with content they can trust.

Making open source more inclusive

Red Hat is committed to replacing problematic language in our code, documentation, and web properties. For more details, see the Red Hat Blog.

About Red Hat

We deliver hardened solutions that make it easier for enterprises to work across platforms and environments, from the core datacenter to the network edge.

© 2024 Red Hat, Inc.