Page Comparison

Admin API endpoints documentation is found on GitHub and available in links below:

For the most accurate and detailed documentation of active endpoints in a version, configure and launch your application with SwaggerEnabled : true(this is not recommended in production)

.

Actions

v2/actions

Retrieves all actions

[
  {
    "id": 0
    "name": "string"
    "uri": "string"

  }
]

Applications

v2/applications/

Retrieves all applications

[
  {
    "id": 0,
    "applicationName": "string",
    "vendorId": 0,
    "claimSetName": "string",
    "profileIds": [],
    "educationOrganizationIds": [],
    "odsInstanceId": 0    
  }
]

v2/applications/{id}

Retrieves a specific application by id 

{
  "id": 0,
  "applicationName": "string",
  "vendorId": 0,
  "claimSetName": "string",
  "profileIds": [],
  "educationOrganizationIds": [],
  "odsInstanceId": 0   
}

v2/applications/

Creates a new application

{
  "applicationName": "string",
  "vendorId": 0,
  "claimSetName": "string",
  "profileIds": [ 0 ],
  "educationOrganizationIds": [ 0 ],
  "odsInstanceId": 0
}

{
  "id": 0,
  "key": "string",
  "secret": "string"
}

v2/applications/{id}

Updates a specific application by id

{
  "id": 0,
  "applicationName": "string",
  "vendorId": 0,
  "claimSetName": "string",
  "profileIds": [ 0 ],
  "educationOrganizationIds": [ 0 ],
  "odsInstanceId": 0
}

HTTP response as documented below

v2/applications/{id}

Deletes an application by id 

HTTP response as documented below

v2/applications/{id}/reset-credential

{
  "id": 0,
  "key": "string",
  "secret": "string"
}

AuthStrategies

v2/authStrategies

 Status
colour
Blue
title
GET

Retrieves all auth strategies

[
  {
    "authStrategyId": 0
    "authStrategyName": "string"
    "displayName": "string"

  }
]

ClaimSets

Note: Property names start with _ represents read-only properties.

Endpoint

HTTP Verb

Description

Request Schema

Response Schema (Success)

v2/claimSets

 Status
colour
Blue
title
GET

Retrieves all claimsets

-

[
  {
    "id": 0,
    "name": "string",
    "_isSystemReserved": true,
    "_applications": []
  }
]

v2/claimSets

Creates a new claimset.

{ "name": "string"}

v2/claimSets/{id}

 Status
colour
Blue
title
GET

Retrieves a specific claimset by id 

-

{
  "id": 0,
  "name": "string",
  "_isSystemReserved": false,
  "_applications": [],
  "resourceClaims": [
    {
      "id": "string",
      "name": "string",
      "read": true,
      "create": true,
      "update": true,
      "delete": true,
      "_defaultAuthStrategiesForCRUD": [
        {
          "actionName": string,
          "authStrategies": [],
          "isInheritedFromParent": true
        }
      ],
      "authStrategyOverridesForCRUD": [
        {            
          "actionName": string, 
          "authStrategies": [],           
          "isInheritedFromParent": true
        }
      ],
      "children": [
        "list of resource claims"
      ]
    }
  ]
}

v2/claimSets/{id}

{ 
"id": 0, 
"name": "string"
}

HTTP response as documented below

v2/claimSets/{id}

v2/claimSets/{claimSetId}/resourceClaimActions

{
"resouceclaimId" : 0,
"resourceClaimActions": 
 { 
    "read": true,
    "create": true,
    "update": true,
    "delete": true
  }   
}

HTTP response as documented below

Updates  the resourceclaimActions to a  specific resource claim on a claimset. At least one action should be enabled (read, create, update, delete). 

{   
  "resourceClaimActions": 
   {
      "read": true,
      "create": true,
      "update": true,
      "delete": true
    }  
}

HTTP response as documented below

Override the default authorization strategies on provided resource claim for a specific action.

ex: actionName = read,  authStrategies= [ "Ownershipbased" ]

{
"actionName": string,
"authStrategies: []
}

HTTP response as documented below

Reset to default authorization strategies on provided resource claim.

-

v2/claimSets/{claimSetId}/
resourceClaimActions/{resourceClaimId}

Deletes a resource claims association from a claim set

-

v2/claimSets/copy

Copy the existing claimset and create new.

{
   "originalId": 0,
   "name": "string"
}

v2/claimSets/import

Import new claimset 

{
  "name": "string",
  "resourceClaims": [
    {
      "name": "string",
      "read": true,
      "create": true,
      "update": true,
      "delete": true,     
      "authStrategyOverridesForCRUD": [
        {
          "actionName": string,
          "authStrategies": []          
        }
      ],
      "children": [
        "list of resource claims"
      ]
    }
  ]
}

Retrieves a specific claimset by id 

OdsInstances

v2/odsInstances

 Status
colour
Blue
title
GET

Retrieves all ODS Instances

[
  {
    "id": 0,
    "name": "string",
    "instanceType": "string"

  }
]

Retrieves a specific ODS instance by id

{
    "id": 0,
    "name": "string",
    "instanceType": "string",
    "odsInstanceContexts": [    

      {
       "id": 0,
       "odsInstanceId": 0,
       "contextKey": "string",
       "contextValue": "string"
      }],
    "odsInstanceDerivatives": [
       {
        "id": 0,
        "odsInstanceId": 0,
        "derivativeType": "string"
       }]
}

Creates a new ODS instance. 

Note: Will validate the connection string to be proper format.

All the fields are required.

{    
 "name": "string"
 "instanceType": "string",
 "connectionString": "string"
}

Updates a specific ODS instance by id.

Note: Will validate the connection string to be proper format.

On update the connection string is optional.

If user is not intending to update the connection string value as part of update, then empty value will be passed. So that the existing connection string will be retained as plain text or encrypted value.

Deletes an ODS instance by id

Retrieves list of applications assigned to a specific ODS instance. 

OdsInstanceContexts

v2/odsInstanceContexts

 Status
colour
Blue
title
GET

Retrieves all ODS Instance contexts

[
  {
    "id": 0,
    "odsInstanceId": 0,
    "contextKey": "string",
    "contextValue": "string"

  }
]

Retrieves a specific ODS instance  context by id

{
    "id": 0,
    "odsInstanceId": 0,
    "contextKey": "string",
    "contextValue": "string"    

}

Creates a new ODS instance context

All the fields are required.

ex: contextKey = "SchoolYear"

contextValue = "2023"

{    
 "odsInstanceId": 0
 "contextKey": "string",
 "contextValue": "string"
}

Updates a specific ODS instance context by id.

{
"odsInstanceId": 0
"contextKey": "string",
"contextValue": "string"
}

Deletes an ODS instance context by id

OdsInstanceDerivatives

v2/odsInstanceDerivatives

 Status
colour
Blue
title
GET

Retrieves all ODS Instance derivatives

[
  {
    "id": 0,
    "odsInstanceId": 0,
    "derivativeType": "string"
  }

]

Retrieves a specific ODS instance derivative by id

{
    "id": 0,
    "odsInstanceId": 0,
    "derivativeType": "string"

}

Creates a new ODS instance derivative

All the fields are required.

Note: Will validate the connection string to be proper format.

Derivative types would be "ReadReplica" or "Snapshot"

{    
 "odsInstanceId": 0
 "derivativeType": "string",
 "connectionString": "string"
}

Updates a specific ODS instance derivative by id.

Note: Will validate the connection string to be proper format.

On update the connection string is optional.

If user is not intending to update the connection string value as part of update, then empty value will be passed. So that the existing connection string will be retained as plain text or encrypted value.

Derivative types would be "ReadReplica" or "Snapshot"

{   
"odsInstanceId": 0
"derivativeType": "string",
"connectionString": "string"
}

Deletes an ODS instance derivative by id

Profiles

v2/profiles

Retrieves all profiles

[
  {
    "id": 0,
    "name":string
  }
]

v2/profiles

Creates a new profile

{
  "name": "string",
  "definition": "string"  
}

HTTP response as documented below

v2/profiles/{id}

Retrieves a specific profile by id 

{
  "id": 0,
  "name":string,
  "definition":string
}

v2/profiles/{id}

Updates a specific profile by id

HTTP response as documented below

v2/profiles/{id}

Deletes a profile by id 

HTTP response as documented below

ResourceClaims

v2/resourceClaims

Retrieves all resourceclaims

[
  {
    "id": 0
    "name": "string",
    "parentId": null,
    "parentName": "",
    "children": [
      {
       "id": 0
       "name": "string",
       "parentId": 0,
       "parentName": "",
       "children": []
      }
    ]
  }
]

v2/resourceClaims/{id}

Retrieves a specific resource claim by id 

 {
  "id": 0
  "name": "string",
  "parentId": null,
  "parentName": "",
  "children": [
     {
      "id": 0
      "name": "string",
      "parentId": 0,
      "parentName": "",
      "children": []
     }
  ]
}

Vendors

v2/vendors

Retrieves all vendors

[
  {
    "id": 0,
    "company": "string",
    "namespacePrefixes": "string",
    "contactName": "string",
    "contactEmailAddress": "string"
  }
]

v2/vendors

Creates a new vendor

{
  "company": "string",
  "namespacePrefixes": "string",
  "contactName": "string",
  "contactEmailAddress": "string"
}

HTTP response as documented below

v2/vendors/{id}

Retrieves a specific vendor by id 

{
  "id": 0,
  "company": "string",
  "namespacePrefixes": "string",
  "contactName": "string",
  "contactEmailAddress": "string"
}

v2/vendors/{id}

Updates a specific vendor by id

HTTP response as documented below

v2/vendors/{id}

Deletes a vendor by id 

HTTP response as documented below

v2/vendors/{id}/applications

  The documentation can be found at https://{mydomain}/swagger/v2/swagger.json and the UI found at https://{mydomain}/adminapi/swagger/index.html.

All functional endpoints require authentication to access. See Securing Admin API for details.

Common Responses

200 SUCCESS

201 CREATED

400 BAD REQUEST

401 UNAUTHORIZED

403 FORBIDDEN

404 NOT FOUND

500 INTERNAL SERVER ERROR