User Endpoint

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

K2 blackpearl Developers Reference4.7

Video	Links	Learn	Support
No videos found for this article K2 on YouTube No Additional links found for this article No self-learning content for this article Try some scenarios... No relevant support links available for this article