REST APIs
These RESTful APIs accept/return JSON formatted data. Sample request/responses below are represented in JSON format. See API Conventions for further information.
All PRIVO Platform resources with the /api/... URI prefix are OAuth 2.0 protected and require authentication for access.
Common API Configuration Members for Use
| Property | Type | Description |
|---|---|---|
| sendParnetEmail | Boolean | Does system send consent email to parent email address provided? |
| sendRegistrationEmail | Boolean | Does system send consent email to User email address provided? |
| sendCongratulationsEmail | Boolean | Does system send post registration emails? |
| roleIdentifier | String | Identifier that defines a given role. Provided by PRIVO Administrator |
| emailVerified | Boolean | Trusted partner use to define email verified status. Requires PRIVO contract approval |
| minorRegistrations | Collection | Associated child accounts. |
| shadowAccount | Boolean | Shuld account start as shadow? |
| serviceId | String | Unique identifier assigned to User. |
| childServiceId | String | Unique identifier assigned to child User. |
| forceActivate | Boolean | Does the account get activated immediately? Requires PRIVO contract approval |
| features | Collection | Feature section to define featureIdentifier(s). |
| featureIdentifier | String | Identifier used to define a given feature(s). Provided by PRIVO Administrator |
| attributes | Collection | Attribute section to define custom attribute(s). |
| attributeName | String | Unique name assigned to a custom attribute. Provided by PRIVO Administrator |
| value | String | Value assigned to the custom attributeName in use. |
| requesterServiceId | String | ServiceId of the requesting User. |
| approverServiceId | String | ServiceId of the approving Granter. |
| setValue | Boolean | Used for password set/reset API to determine whether set or reset is used. |
| emailToResolveCollision | String | Used for password API to resolve conflicts of multiple accounts found. |
| suggest | Boolean | Used for username or display name API to suggest additional names if the one provided is already taken. |
| verificationTier | Value | Verification tier of the given User - e.g. A_, A_0, A, B, C, D, E, F, G |