Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 8 Next »

The IRWS V2 documentation is not complete as of 2015-11-30. Please contact iam-support@uw.edu if you have questions about V2 usage.

Overview

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

  • The UW Payroll system needs to add an employee affiliation to an existing UW NetID (e.g. a student has been hired as an employee and needs an employee identity associated with their UW NetID)
  • You need to read affiliation details associated with a UW NetID
  • You want to set a Private Access Code (PAC) for a user so they can obtain a UW NetID  

Requirements

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

  • HTTPS
  • Authentication with X.509 certificates
  • HTTP GET, PUT, POST, and DELETE requests
  • JSON content type only

Access

Access Requests

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. 

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:

  • A DNS name and static IP address.  
  • A certificate issued by the UW Services CA

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

Your application's certificate must be authorized.  You can request authorization by emailing iam-support@uw.edu.  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, ...]

  • This is a standard header that works as expected for IRWS.
  • IRWS V2 accepts payloads and returns content only in JSON format.
  • Specifying an unsupported content type will return a 406 return code.
  • If your ACCEPT header doesn't include any content types, IRWS will use the default content type for the resource.
  • Example: Accept: application/json

Act-As: application name

  • Act-As allows authorized clients to act as another client.
  • Contact us at iam-support@uw.edu for help with configuring Act-As..

Application-Name: application/userid

  • Application-Name specifies the label associated with a clients requests in the logs.
  • Contact us at iam-support@uw.edu for help with selecting your application name.

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

  • Doing a GET on a resource will generally return all attributes in that resource, which can be a long list. If a client is only interested in a small subset of attributes, this header can be used to limit the return payload to those attributes.
  • Example: Attribute-List: lname fname wp_email

If-Match: [etag]

  • This is a standard header that works as expected for IRWS.
  • Example: Etag: 20150425080640Z

Option-List: [imprecise pretend pretty reflect]

  • 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 and availability are provided in the previous section. 

  • -type=[json]
  • -actas=name=[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.  

ResourceDescription
Account The Account resource allows an authorized client to create, read, update, delete, and perform other actions related to account entities. 
CategoryThe Category resource allows an authorized client to...
DsubscriptionThe Dsubscription resource allows an authorized client to...
NameThe Name resource allows an authorized client to read and update source-independent names associated with person entities.
PdsentryThe PDS Entry resource allows an authorized client to read Person Directory data.
PersonThe Person resource allows an authorized client to create, read, update, delete, and perform other actions related to person entities.  
RegidThe Regid resource allows an authorized client to manipulate attributes associated with regids.
SocialThe Social resource allows an authorized client to create, read, and update social identities. 
SubscriptionThe Subscription resource allows an authorized client to...

 

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.  

Return Code
Description
Payload
200OK (the GET, PUT, or POST was successful)Resource (JSON)
400Invalid identifier type providedError (JSON)
401  
403  
404Identifier provided did not match any recordsError (JSON)

405

Method Not AllowedError (JSON)
406Content type not supported  
409  
412  
500Internal Server ErrorNone

501

Not ImplementedNone
503Service UnavailableNone
901  
902  
903  
904  

 

 

 

Sample Code

Sample code will be provided as resources allow.

 

  • No labels