User Endpoint

This content applies to legacy components (such as K2 Studio and K2 for Visual Studio), legacy assemblies, legacy services or legacy functionality. If you have upgraded from K2 blackpearl 4.7 to K2 Five, these items may still be available in your environment. These legacy items may not be available in new installations of K2 Five. These legacy items may also not be available, supported, or behave as described, in future updates or versions of K2. Please see the legacy component support policy for more information about support for these components.

The user resource is read-only and can be accessed via the api/user endpoint.

Schema examples for the User Endpoint

JSON

{
    "Username": "k2:denallix\\bob",
    "Fqn": "k2:denallix\\bob",
    "Email": "bob@denallix.com",
    "Manager": "k2:denallix\\codi",
    "DisplayName": "Bob",
    "Properties": null
}

XML

<User
    xmlns:i="http://www.w3.org/2001/XMLSchema-instance"
    xmlns="http://schemas.k2.com/2013/web/rest/identity.xsd">
  <DisplayName>Bob</DisplayName>
  <Email>bob@denallix.com</Email>
  <Fqn>k2:denallix\bob</Fqn>
  <Manager>k2:k2workflow\codi</Manager>
  <Properties i:nil="true"/>
  <Username>k2:denallix\bob</Username>
</User>

Using the OData GET method with the User Endpoint

The standard OData query string options can be used in conjunction with the api/user endpoint. See the following article for the standard OData query string options:

http://www.odata.org/documentation/odata-v2-documentation/uri-conventions/#4_Query_String_Options

Using the GET method with the User Endpoint

A specific user can be returned via the api/user/{FQN} endpoint. For example:

  • api/user/aad:bob@denallix.com
  • api/user/k2:denallix\bob