For overview, etc see Identity Registration Web Service REST API V2. This information is unchanged for IRWS v3.

For the IRWS v3 Swagger specification see .. link

 

 

 

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

 

Overview

This guide describes the Identity Registration Web Service (IRWS) API V3.  Documentation for IRWS V2 is also available .  IRWS 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.

Example Use Cases

Requirements

An SSL client certificate is required for access (see section Certificate Authentication below). The application that uses this service must support:

Access

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 currently dedicated to Workday integration development and testing. It is only available to Workday integration partners. 

Prerequisites

Due to the sensitive nature of the information in IRWS, there are several layers of access control. The requirements for access are generally more stringent than for other services on campus.

To access IRWS you need:

DNS Name and Static IP Address

These are available from UW Network Operations by emailing help@uw.edu.  See  Information on DNS Names  and   Information on Static IP Addresses .  Generally, you can request both in the same email to Network Operations.  Make sure to request that your UW NetID be associated with the DNS name so you can request certificates for it, and that the IP address reverse resolve to the DNS name.  See the example request below.  

I would like to request a Static IP address and associated DNS name.  
The IP address of my machine right now is xx.xx.xx.xx.  I would like 
the DNS name example.pavesci.washington.edu.  
Please associate my UW NetID with the DNS name so I can request 
certificates for it.  Lastly, the IP address should reverse resolve to the DNS name.  

Certificate Authentication

Authentication is by certificates issued from the UW Services CA, and by hostname (DNS name) or IP address.  The IP address of the client is verified in addition to the certificate.  Connections will automatically be allowed if the IP address of the client reverse resolves to the subject name of the certificate presented.  For special cases, you can request additional hostnames or IP addresses be allowed to authenticate with the certificate (if a hostname is specified, the IP address of the client must reverse resolve to the hostname given). 

Certificate Authorization

To request access to IRWS you must open a support request in UW Connect. Please send an email to help@uw.edu. Try to be specific about what application you are working on, what you are trying to do, and what resources you need access to. To speed up routing, you can include "Please route to the Identity and Access Management team" in your request. Your certificate may not be authorized for all of the functions described in this documentation.

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.

Accept: [content type1,content type2, ...]

Act-As: application name

Application-Name: application/userid

Attribute-List: [attribute1 attribute2 attribute3 ...]

If-Match: [etag]

Option-List: [imprecise pretend pretty 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 and availability are provided in the previous section. 

Swagger Documentation

Swagger documentation for IRWS V3 can be found at: Identity Registration Web Service REST API V3

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. 

 

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.