External Account Providers

This endpoint is used to manage external accounts provided to clients of OutStem

Endpoint URL

QA: (Must use the VPN, data in this environment is reset at midnight): https://server.qa.outstem.io/bin/api/outreach/v2/external/provider-accounts

PROD (Must use the VPN):

https://server.outstem.io/bin/api/outreach/v2/external/provider-accounts

POST Request

Body:

{
	provider_key: string,
	provider: string, 
  domain: string,
  group: string (optional), 
	supported_properties: (optional) {
			readonly: string[] (optional)
		}
	accounts: [
			{
        login: string,
        password: string,
        valid_start: YYYY-MM-DD string (optional),
        valid_end: YYYY-MM-DD string (optional),
			  supported_properties: (optional) {}
	   }, 
 	 ]
 }

Example

{
	provider_key: ‘example provider’
	provider: ‘uOttawa’,
  domain: ‘uOttawa’,
  group: ‘Summer 2020’,
	supported_properties: {
			readonly: [
				‘incident_id’, 
				‘en_pronounceable’, 
				‘fr_pronounceable’
			]
		}
	accounts: [
			{
        login: ‘example user’,
        password: ‘example password’,
        valid_start: ‘2018-10-10’,
        valid_end: ‘2018-12-12’
			  supported_properties: {	
			  	incident_id: ‘ABCD-123’,
        	en_pronounceable: ‘example en’,
          fr_pronounceable: ‘example fr’
        }
	    }, 
    ]
 }

GET Request

Request Parameters:

• provider: string

• provider_key: string

• domain: string

• group: string (optional parameter)

• unassigned: boolean (optional parameter, default false)

Result format:

unassigned = true

[{
login (text),
password (text),
invalid (boolean),
properties: {
  incident_id (text), 
  ... (any other metadata)
},
valid_start (date),
valid_end (date)
comments (text),
group (text) (optional),
}]

unassigned = false

[{
login (text),
invalid (boolean),
dropped (boolean, true if student has dropped out of the event),
properties: {
  incident_id (text), … (any other metadata)
},
camper_id (int),
first (text),
last (text),
starts (date),
ends (date),
comments (text),
group (text) (optional),
}]