...
Info |
---|
The first thing you will need is a client Id and a client password, which you can request from the IIM team. |
...
- You want to install the IdentityModel package from the NuGet feed into your client project.
This will enable you to shortcut some of the URL mapping and discovery in the OAuth workflow. The following will do this work for you
Code Block language c# theme Confluence firstline 1 title Discovery of IDs IdentityServer Metadata Code Example linenumbers true collapse true // discover endpoints from metadata var disco = await DiscoveryClient.GetAsync("https://warden.data.uwaterloo.ca"); if (disco.IsError) { Console.WriteLine(disco.Error); return; }
Next you'll pass your credentials to the token server and receive back a JSON response that will include your authorization token.
Code Block language c# theme Confluence firstline 1 title Getting Token from IdentityServer Code Example linenumbers true collapse true var tokenClient = new TokenClient(disco.TokenEndpoint, "your_client_id", "your_client_password"); var tokenResponse = await tokenClient.RequestClientCredentialsAsync("sourceapi"); if (tokenResponse.IsError) { Console.WriteLine(tokenResponse.Error); return; } Console.WriteLine(tokenResponse.Json);
- Now with your valid token you'll be able to make calls against the API to get data.
To send the access token to the API you typically use the HTTP Authorization header. This is done using the SetBearerToken extension method.
Code Block language c# theme Confluence firstline 1 title Calling the API with Token Code Example linenumbers true collapse true var client = new HttpClient(); client.SetBearerToken(tokenResponse.AccessToken); var response = await client.GetAsync("https://api.data.uwaterloo.ca/api/v1/terms"); if (!response.IsSuccessStatusCode) { Console.WriteLine(response.StatusCode); } else { var content = await response.Content.ReadAsStringAsync(); Console.WriteLine(content); }
...
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
static void Main(string[] args) { // Create client to get Identity Server Response var client = new HttpClient(); client.DefaultRequestHeaders.Accept.Clear(); client.DefaultRequestHeaders.Accept.Add(new MediaTypeWithQualityHeaderValue("application/json")); // Add required information to retrieve token (you will need to use your credentials) var content = new FormUrlEncodedContent(new[] { new KeyValuePair<string, string>("scope", "sourceapi"), new KeyValuePair<string, string>("grant_type", "client_credentials"), new KeyValuePair<string, string>("client_id", "your_client_id"), new KeyValuePair<string, string>("client_secret", "your_client_secret") }); // Get response from a POST var response = client.PostAsync("https://warden.data.uwaterloo.ca/connect/token", content).Result; response.EnsureSuccessStatusCode(); // For our purposes we'll get the return as string (that is valid JSON) and then deserialize into an object var jsonResponseString = response.Content.ReadAsStringAsync().Result; var jsonObject = JsonConvert.DeserializeObject<JwtResponseBlock>(jsonResponseString); client.Dispose(); // Query the API by setting the Authorization header value with the token we got client = new HttpClient(); client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", jsonObject.access_token); // Retrieve Term informatino from API as an example var termsJsonString = client.GetStringAsync("https://api.data.uwaterloo.ca/api/v1/terms").Result; } private class JwtResponseBlock { public string access_token { get; set; } } |
PHP with helper library
Anchor | ||||
---|---|---|---|---|
|
For PHP please see this GitHub repository of an OpenID client. Example 4 using Client Credentials is what you are looking to use, you can also see how the implementation is done if you wish to code it yourself.
Ruby
Anchor | ||||
---|---|---|---|---|
|
Thank you to James from FEDS for this contribution.
...