Versions Compared

Key

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

Table of Contents


Note

The IRWS V2 v2 documentation is not exhaustive. Please contact iam-support@uw.edu if you have questions about V2 v2 usage.

Overview

This guide describes the Identity Registration Web Service (IRWS) API V2.  IRWS V2 v2 is deprecated and all new customers should use IRWS V3v3 insteadIRWS can be used to to register an identity with the Identity Registry.  IRWS offers a "RESTful" programmatic interface. It exposes Identity Registry source information as addressable resources via the uniform HTTP interface; authorized clients may retrieve (GET), create (PUT), update (POST) and delete (DELETE) representations of these resources through the REST API.

Request IRWS Access

IRWS

...

v2 Swagger Documentation

Swagger documentation for IRWS V2 v2 can be found at: Identity Registration Web Service REST API V2v2.

Base URL 

All interactions with IRWS are through the following base URLs. Customer testing is generally done in the Eval environment. The Dev environment is reserved for the IAM development team. 

Excerpt Include
_IRWS_Base URLs V2
_IRWS_Base URLs V2
nopaneltrue

Supported HTTP Request Headers

IRWS supports a set of standard and custom HTTP headers that can be used by a client to express options. All the listed request headers are optional and all can be combined.

...

  • imprecise - Overrides default PUT behavior to behave like a POST if the record already exists. This is the default behavior for some resources.
  • pretend - Reports what would happen if the request was carried out, but the changes are not committed. Useful for testing.
  • pretty - By default, IRWS returns a payload as a single line of text. For human readability you can specify this option to get a pretty-printed representation of the data.
  • reflect - Useful for PUTs and POSTS, specifying reflect will cause IRWS to return the current state of the resource. This is the default behavior for the source and social resources.
  • Example: Option-List: imprecise reflect

Supported URI Parameters

HTTP headers are the preferred way for an application to express the IRWS options it needs. For convenience, some of the options described above can be communicated via parameters in the URI. This may be useful for user interactive testing with a browser or the curl utility. All parameters are optional and different options may be combined in one URI. Definitions are provided in the previous section. 

  • -type=[json]
  • -actas=permit=[application name]
  • -attribute=[attribute1+attribute2...]
  • -imprecise
  • -pretend
  • -pretty
  • -reflect
  • Examples:
    • GET https://mango-eval.u.washington.edu:646/registry-eval/v1/person/uwhr/123456789&-type=json&-attribute=lname+fname+wp_email&-pretty 

Resources

Identity records are associated with a resource. A GET on the base URL will return a list of all top-level resources for which your client is authorized. Documentation is provided for the resources listed in the table below.  

Excerpt Include
_IRWS_Resources V2
_IRWS_Resources V2
nopaneltrue

Return Codes

IRWS uses standard HTTP return codes, as well as a few special ones. Most errors will return a JSON payload with the error class containing the code and message properties.  

...