Export (0) Print
Expand All
me
to
Expand Minimize

user (UCWA)

Last modified: June 17, 2013

Applies to: Lync Server 2013

In this article
Web link
Resource description
Operations

Represents the entry point to the API using user credentials.

For more on web links, see Web links.

Name

Description

rel

The resource that this link points to. In JSON, this is the outer container.

href

The location of this resource on the server, and the target of an HTTP operation.

The user resource indicates that the application plans to use the API on behalf of a user. If an application attempts to use this resource without credentials, the server will respond with a 401 Not Authorized and authentication hints in the WWW-Authenticate Header. Once credentials are acquired, this resource will point the application to the applications (UCWA) resource. In some cases, once credentials are acquired, the server may serve a redirect (UCWA) resource indicating that the user is homed on another server. The application should follow this resource to the new server. Credentials may need to be resubmitted.

Properties

None

Links

This resource can have the following relationships.

Link

Description

self

The link to the current resource.

applications (UCWA)

Represents the entry point for registering this application with the server.

redirect (UCWA)

Represents a pointer to a different server that the application should use for future requests.

xframe (UCWA)

Represents the cross-domain frame used for web-based applications.

GET

Returns a representation of the entrypoint to the API using user credentials.

Request body

None

Response body

The response from a GET request contains the properties and links shown in the Properties and Links sections at the top of this page.

Synchronous errors

The errors below, if any, are specific to this resource. Generic errors that can apply to any resource are covered in Generic synchronous errors.

Examples

JSON Request

Get https://fe1.contoso.com:443/autodiscover/autodiscoverservice.svc/root/user HTTP/1.1
Authorization: Bearer cwt=PHNhbWw6QXNzZXJ0aW9uIHhtbG5...uZm8
Host: fe1.contoso.com
Accept: application/json

JSON Response

This sample is given only as an illustration of response syntax. The semantic content is not guaranteed to correspond to a valid scenario.

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 288
{
  "rel" : "user",
  "_links" : {
    "self" : {
      "href" : "/autodiscover/autodiscoverservice.svc/root/user"
    },
    "applications" : {
      "href" : "/ucwa/v1/applications"
    },
    "redirect" : {
      "href" : "/autodiscover/autodiscoverservice.svc/root/user/redirect"
    },
    "xframe" : {
      "href" : "/autodiscover/autodiscoverservice.svc/root/xframe"
    }
  }
}

XML Request

Get https://fe1.contoso.com:443/autodiscover/autodiscoverservice.svc/root/user HTTP/1.1
Authorization: Bearer cwt=PHNhbWw6QXNzZXJ0aW9uIHhtbG5...uZm8
Host: fe1.contoso.com
Accept: application/xml

XML Response

This sample is given only as an illustration of response syntax. The semantic content is not guaranteed to correspond to a valid scenario.

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: 436
<?xml version="1.0" encoding="utf-8"?>
<resource rel="user" href="/autodiscover/autodiscoverservice.svc/root/user" xmlns="http://schemas.microsoft.com/rtc/2012/03/ucwa">
  <link rel="applications" href="/ucwa/v1/applications" />
  <link rel="redirect" href="/autodiscover/autodiscoverservice.svc/root/user/redirect" />
  <link rel="xframe" href="/autodiscover/autodiscoverservice.svc/root/xframe" />
  <property name="rel">user</property>
</resource>

Show:
© 2014 Microsoft