CampusAPI Authorization Services API documentation version 0.1.5
Based on OSID version 3.0.0

Query Parameters

• offset: (integer - default: 0)

  Skip over a number of elements by specifying an offset value for the query

  Example:

  20

• limit: (integer - default: 10)

  Limit the number of elements on the response

  Example:

  80

• expand: (string)

  Expand object or type for named attribute: "genusType", "recordType", "endReason", "agent", "function", "qualifier", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.

  Example:

  all

• genusTypeId: (string)

  The id string to match a genusType

  Example:

  type.Type%3AexampleAuthorizationType%40dxtera.org

• parentGenusTypeId: (string)

  The id string to match a parent genusType

  Example:

  type.Type%3AparentTypeExampleAuthorizationType%40dxtera.org

• recordTypeId: (string)

  The id string to match a recordType

  Example:

  type.Type%3AexampleAuthorizationType%40campusapi.org

• fromDate: (string)

  Get all authorizations from this date inclusive. Use with toDate to define date range query.

  Example:

  2020-10-03

• toDate: (string)

  Get all authorizations up to this date inclusive. Use with fromDate to define date range query.

  Example:

  2020-12-18

• agentId: (string)

  the id string to match a agent.

  Example:

  authentication.Agent%3A910%40base.url

• functionId: (string)

  the id string to match a function.

  Example:

  authorization.Function%3A1352%40base.url

• qualifierId: (string)

  the id string to match a qualifier.

  Example:

  authorization.Qualifier%3A1521%40base.url

• resourceId: (string)

  Id string to match resource.

  Example:

  resource.Resource%3A3690%40base.url

• vaultId: (string)

  The id string to match a vault

  Example:

  authorization.Vault%3A8374%40base.url

Query Parameters

• agentId: required(string)

  the agent of this authorization.

  Example:

  authentication.Agent%3A910%40base.url

• functionId: required(string)

  the function of this authorization.

  Example:

  authorization.Function%3A1352%40base.url

• qualifierId: required(string)

  the qualifier of this authorization.

  Example:

  authorization.Qualifier%3A1521%40base.url

• genusType: (string)

  specify a particular authorization type to create

  Example:

  type.Type%3AexampleAuthorizationType%40dxtera.org

• recordType: (array of )

  specify support for one or more authorization record types

  Example:

  [
    "type.Type%3AexampleAuthorizationRecordType%40campusapi.org",
    "..."
  ]

• vaultId: (string)

  specify in which vault to create this authorization

  Example:

  authorization.Vault%3A8374%40base.url

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Authorization",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this authorization, provided by system.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this authorization, provided by system.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this authorization for display.",
      "type": "string"
    },
    "description": {
      "description": "The description of this authorization.",
      "type": "string"
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this authorization. Default type set by system unless specified in query parameter.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "recordTypeIds": {
      "description": "Type Ids of record types available on this authorization. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
      "type": "array",
      "items": {
        "type": "string",
        "format": "osid-id"
      },
      "readOnly": true
    },
    "startDate": {
      "description": "The starting date of this authorization.",
      "type": "string",
      "format": "date-time"
    },
    "endDate": {
      "description": "The ending date of this authorization.",
      "type": "string",
      "format": "date-time"
    },
    "endReasonId": {
      "description": "The reason this authorization ended.",
      "type": "string",
      "format": "osid-id"
    },
    "agentId": {
      "description": "The agent associated with this authorization.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "functionId": {
      "description": "The function associated with this authorization.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "qualifierId": {
      "description": "The qualifier associated with this authorization.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    }
  }
}

Example:

{
  "displayName": "Display Name of this Authorization",
  "description": "The description of this Authorization",
  "startDate": "2020-10-03T06:30:00.000Z",
  "endDate": "2020-12-18T19:30:00.000Z",
  "endReasonId": "process.State:1744@base.url"
}

Query Parameters

• offset: (integer - default: 0)

  Skip over a number of elements by specifying an offset value for the query

  Example:

  20

• limit: (integer - default: 10)

  Limit the number of elements on the response

  Example:

  80

• expand: (string)

  Expand object or type for named attribute: "genusType", "recordType", "endReason", "agent", "function", "qualifier", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.

  Example:

  all

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "AuthorizationQuery",
  "type": "object",
  "properties": {
    "matchIds": {
      "description": "List of Ids to match. Boolean OR performed among multiple Ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchKeywords": {
      "description": "List keywords to match. Multiple keywords can be added to perform a boolean OR among them. A keyword may be applied to any of the elements defined in this object such as the display name, description or any attribute defined in or implemented by this object.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "keyword": {
            "description": "keyword to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchDisplayNames": {
      "description": "List of displayName strings to match. Boolean OR performed among multiple displayNames.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "displayName": {
            "description": "displayName to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchDescriptions": {
      "description": "List of discription strings to match. Boolean OR performed among multiple descriptions.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "description": {
            "description": "description to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchGenusTypeIds": {
      "description": "List of genus type ids to match. Boolean OR performed among multiple ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "genusTypeid": {
            "description": "genus type id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchRecordTypeIds": {
      "description": "List of record type ids to match. Boolean OR performed among multiple ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "genusTypeid": {
            "description": "record type id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchEffective": {
      "description": "Match effective objects where the current date falls within the start and end dates inclusive. true to match any effective, false to match ineffective",
      "type": "boolean"
    },
    "matchStartDate": {
      "description": "Matches temporals whose start date falls in between the given dates inclusive.",
      "type": "object",
      "properties": {
        "start": {
          "description": "start of date range",
          "type": "string",
          "format": "date-time"
        },
        "end": {
          "description": "end of date range",
          "type": "string",
          "format": "date-time"
        },
        "match": {
          "description": "true if a positive match, false for negative match",
          "type": "boolean"
        }
      }
    },
    "matchEndDate": {
      "description": "Matches temporals whose end date falls in between the given dates inclusive.",
      "type": "object",
      "properties": {
        "start": {
          "description": "start of date range",
          "type": "string",
          "format": "date-time"
        },
        "end": {
          "description": "end of date range",
          "type": "string",
          "format": "date-time"
        },
        "match": {
          "description": "true if a positive match, false for negative match",
          "type": "boolean"
        }
      }
    },
    "matchEndReasonIds": {
      "description": "List of end reason Id's to match.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "stateId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "endReasonQueries": {
      "description": "process.StateQueries to match end reason state. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "matchAnyEndReason": {
      "description": "Match end reasons with any value. true to match Authorizations with any end reason, false to match Authorizations with no end reason",
      "type": "boolean"
    },
    "matchAgentIds": {
      "description": "List of agent Ids for this query to match authorization that have a related agent.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "ruleId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "agentQueries": {
      "description": "AgentQueries to match the agent. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "matchFunctionIds": {
      "description": "List of function Ids for this query to match authorization that have a related function.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "ruleId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "functionQueries": {
      "description": "FunctionQueries to match the function. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "matchQualifierIds": {
      "description": "List of qualifier Ids for this query to match authorization that have a related qualifier.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "ruleId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "qualifierQueries": {
      "description": "QualifierQueries to match the qualifier. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "matchVaultIds": {
      "description": "List of Vault Id's to match.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "vaultId": {
            "description": "Vault id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "vaultQueries": {
      "description": "VaultQueries to match Vault. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    }
  }
}

Example:

{
  "matchDisplayNames": [
    {
      "displayName": "string to exclude",
      "match": false
    }
  ]
}

Query Parameters

• agentId: required(string)

  the agent of this metadatum.

  Example:

  authentication.Agent%3A910%40base.url

• functionId: required(string)

  the function of this metadatum.

  Example:

  authorization.Function%3A1352%40base.url

• qualifierId: required(string)

  the qualifier of this metadatum.

  Example:

  authorization.Qualifier%3A1521%40base.url

• genusType: (string)

  specify a particular authorization type to create

  Example:

  type.Type%3AexampleAuthorizationType%40dxtera.org

• recordType: (array of )

  specify support for one or more authorization record types

  Example:

  [
    "type.Type%3AexampleAuthorizationRecordType%40campusapi.org",
    "..."
  ]

• vaultId: (string)

  specify in which vault to create this authorization

  Example:

  authorization.Vault%3A8374%40base.url

URI Parameters

• authorizationId: required(string)

Query Parameters

• expand: (string)

  Expand object or type for named attribute: "genusType", "recordType", "endReason", "agent", "function", "qualifier", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.

  Example:

  all

URI Parameters

• authorizationId: required(string)

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Authorization",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this authorization, provided by system.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this authorization, provided by system.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this authorization for display.",
      "type": "string"
    },
    "description": {
      "description": "The description of this authorization.",
      "type": "string"
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this authorization. Default type set by system unless specified in query parameter.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "recordTypeIds": {
      "description": "Type Ids of record types available on this authorization. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
      "type": "array",
      "items": {
        "type": "string",
        "format": "osid-id"
      },
      "readOnly": true
    },
    "startDate": {
      "description": "The starting date of this authorization.",
      "type": "string",
      "format": "date-time"
    },
    "endDate": {
      "description": "The ending date of this authorization.",
      "type": "string",
      "format": "date-time"
    },
    "endReasonId": {
      "description": "The reason this authorization ended.",
      "type": "string",
      "format": "osid-id"
    },
    "agentId": {
      "description": "The agent associated with this authorization.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "functionId": {
      "description": "The function associated with this authorization.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "qualifierId": {
      "description": "The qualifier associated with this authorization.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    }
  }
}

Example:

{
  "displayName": "Display Name of this Authorization",
  "description": "The description of this Authorization",
  "startDate": "2020-10-03T06:30:00.000Z",
  "endDate": "2020-12-18T19:30:00.000Z",
  "endReasonId": "process.State:1744@base.url"
}

URI Parameters

• authorizationId: required(string)

URI Parameters

• authorizationId: required(string)

Query Parameters

• offset: (integer - default: 0)

  Skip over a number of elements by specifying an offset value for the query

  Example:

  20

• limit: (integer - default: 10)

  Limit the number of elements on the response

  Example:

  80

• expand: (string)

  Expand object or type for named attribute: "genusType", "recordType", "rule", "qualifierHierarchy", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.

  Example:

  all

• genusTypeId: (string)

  The id string to match a genusType

  Example:

  type.Type%3AexampleFunctionType%40dxtera.org

• parentGenusTypeId: (string)

  The id string to match a parent genusType

  Example:

  type.Type%3AparentTypeExampleFunctionType%40dxtera.org

• recordTypeId: (string)

  The id string to match a recordType

  Example:

  type.Type%3AexampleFunctionType%40campusapi.org

• vaultId: (string)

  The id string to match a vault

  Example:

  authorization.Vault%3A8374%40base.url

Query Parameters

• genusType: (string)

  specify a particular function type to create

  Example:

  type.Type%3AexampleFunctionType%40dxtera.org

• recordType: (array of )

  specify support for one or more function record types

  Example:

  [
    "type.Type%3AexampleFunctionRecordType%40campusapi.org",
    "..."
  ]

• vaultId: (string)

  specify in which vault to create this function

  Example:

  authorization.Vault%3A8374%40base.url

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Function",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this function, provided by system.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this function, provided by system.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this function for display.",
      "type": "string"
    },
    "description": {
      "description": "The description of this function.",
      "type": "string"
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this function. Default type set by system unless specified in query parameter.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "recordTypeIds": {
      "description": "Type Ids of record types available on this function. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
      "type": "array",
      "items": {
        "type": "string",
        "format": "osid-id"
      },
      "readOnly": true
    },
    "active": {
      "description": "Whether this function is active. Active is true if operational is true and disabled is false, or enabled is true.",
      "type": "boolean",
      "readOnly": true
    },
    "enabled": {
      "description": "Whether this function is administravely enabled. Administratively enabling overrides any applied enabler.",
      "type": "boolean"
    },
    "disabled": {
      "description": "Whether this function is administravely enabled. Administratively enabling overrides any applied enabler.",
      "type": "boolean"
    },
    "operational": {
      "description": "Whether this function is operational. This function is operational if any of the applied enablers are true.",
      "type": "boolean",
      "readOnly": true
    },
    "ruleId": {
      "description": "An explicit Rule for this function.",
      "type": "string",
      "format": "osid-id"
    },
    "qualifierHierarchyId": {
      "description": "The qualifier hierarchy for this function.",
      "type": "string",
      "format": "osid-id"
    }
  }
}

Example:

{
  "displayName": "Display Name of this Function",
  "description": "The description of this Function",
  "active": true,
  "enabled": true,
  "disabled": false,
  "operational": true,
  "ruleId": "rules.Rule:123@base.url",
  "qualifierHierarchyId": "hierarchy.Hierarchy:8102@base.url"
}

Query Parameters

• offset: (integer - default: 0)

  Skip over a number of elements by specifying an offset value for the query

  Example:

  20

• limit: (integer - default: 10)

  Limit the number of elements on the response

  Example:

  80

• expand: (string)

  Expand object or type for named attribute: "genusType", "recordType", "rule", "qualifierHierarchy", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.

  Example:

  all

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "FunctionQuery",
  "type": "object",
  "properties": {
    "matchIds": {
      "description": "List of Ids to match. Boolean OR performed among multiple Ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchKeywords": {
      "description": "List keywords to match. Multiple keywords can be added to perform a boolean OR among them. A keyword may be applied to any of the elements defined in this object such as the display name, description or any attribute defined in or implemented by this object.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "keyword": {
            "description": "keyword to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchDisplayNames": {
      "description": "List of displayName strings to match. Boolean OR performed among multiple displayNames.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "displayName": {
            "description": "displayName to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchDescriptions": {
      "description": "List of discription strings to match. Boolean OR performed among multiple descriptions.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "description": {
            "description": "description to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchGenusTypeIds": {
      "description": "List of genus type ids to match. Boolean OR performed among multiple ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "genusTypeid": {
            "description": "genus type id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchRecordTypeIds": {
      "description": "List of record type ids to match. Boolean OR performed among multiple ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "genusTypeid": {
            "description": "record type id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchActive": {
      "description": "Matches active. true to match active, false to match inactive",
      "type": "boolean"
    },
    "matchEnabled": {
      "description": "Matches administratively enabled. true to match administratively enabled, false otherwise",
      "type": "boolean"
    },
    "matchDisabled": {
      "description": "Matches administratively disabled. true to match administratively disabled, false otherwise",
      "type": "boolean"
    },
    "matchOperational": {
      "description": "Matches operational operables. true to match operational, false to match not operational",
      "type": "boolean"
    },
    "matchRuleIds": {
      "description": "List of rule Ids to match.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "ruleId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "ruleQueries": {
      "description": "rules.RuleQuery for the cyclic event. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "matchQualifierHierarchyIds": {
      "description": "List of Hierarchy Ids for this query to match qualifierHierarchy.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "qualifierHierarchyId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "qualifierHierarchyQueries": {
      "description": "hierarchy.HierarchyQueries to match the Qualifier Hierarchy. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "matchAnyQualifierHierarchy": {
      "description": "Match qualifier hierarchy with any value. true to match Functions with any qualifier hierarchy, false to match Functions with no qualifier hierarchy",
      "type": "boolean"
    },
    "matchVaultIds": {
      "description": "List of Vault Id's to match.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "vaultId": {
            "description": "Vault id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "vaultQueries": {
      "description": "VaultQueries to match Vault. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    }
  }
}

Example:

{
  "matchDisplayNames": [
    {
      "displayName": "string to exclude",
      "match": false
    }
  ]
}

Query Parameters

• genusType: (string)

  specify a particular function type to create

  Example:

  type.Type%3AexampleFunctionType%40dxtera.org

• recordType: (array of )

  specify support for one or more function record types

  Example:

  [
    "type.Type%3AexampleFunctionRecordType%40campusapi.org",
    "..."
  ]

• vaultId: (string)

  specify in which vault to create this function

  Example:

  authorization.Vault%3A8374%40base.url

URI Parameters

• functionId: required(string)

Query Parameters

• expand: (string)

  Expand object or type for named attribute: "genusType", "recordType", "rule", "qualifierHierarchy", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.

  Example:

  all

URI Parameters

• functionId: required(string)

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Function",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this function, provided by system.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this function, provided by system.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this function for display.",
      "type": "string"
    },
    "description": {
      "description": "The description of this function.",
      "type": "string"
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this function. Default type set by system unless specified in query parameter.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "recordTypeIds": {
      "description": "Type Ids of record types available on this function. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
      "type": "array",
      "items": {
        "type": "string",
        "format": "osid-id"
      },
      "readOnly": true
    },
    "active": {
      "description": "Whether this function is active. Active is true if operational is true and disabled is false, or enabled is true.",
      "type": "boolean",
      "readOnly": true
    },
    "enabled": {
      "description": "Whether this function is administravely enabled. Administratively enabling overrides any applied enabler.",
      "type": "boolean"
    },
    "disabled": {
      "description": "Whether this function is administravely enabled. Administratively enabling overrides any applied enabler.",
      "type": "boolean"
    },
    "operational": {
      "description": "Whether this function is operational. This function is operational if any of the applied enablers are true.",
      "type": "boolean",
      "readOnly": true
    },
    "ruleId": {
      "description": "An explicit Rule for this function.",
      "type": "string",
      "format": "osid-id"
    },
    "qualifierHierarchyId": {
      "description": "The qualifier hierarchy for this function.",
      "type": "string",
      "format": "osid-id"
    }
  }
}

Example:

{
  "displayName": "Display Name of this Function",
  "description": "The description of this Function",
  "active": true,
  "enabled": true,
  "disabled": false,
  "operational": true,
  "ruleId": "rules.Rule:123@base.url",
  "qualifierHierarchyId": "hierarchy.Hierarchy:8102@base.url"
}

URI Parameters

• functionId: required(string)

URI Parameters

• functionId: required(string)

Query Parameters

• offset: (integer - default: 0)

  Skip over a number of elements by specifying an offset value for the query

  Example:

  20

• limit: (integer - default: 10)

  Limit the number of elements on the response

  Example:

  80

• expand: (string)

  Expand object or type for named attribute: "genusType", "recordType", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.

  Example:

  all

• genusTypeId: (string)

  The id string to match a genusType

  Example:

  type.Type%3AexampleQualifierType%40dxtera.org

• parentGenusTypeId: (string)

  The id string to match a parent genusType

  Example:

  type.Type%3AparentTypeExampleQualifierType%40dxtera.org

• recordTypeId: (string)

  The id string to match a recordType

  Example:

  type.Type%3AexampleQualifierType%40campusapi.org

• vaultId: (string)

  The id string to match a vault

  Example:

  authorization.Vault%3A8374%40base.url

Query Parameters

• genusType: (string)

  specify a particular qualifier type to create

  Example:

  type.Type%3AexampleQualifierType%40dxtera.org

• recordType: (array of )

  specify support for one or more qualifier record types

  Example:

  [
    "type.Type%3AexampleQualifierRecordType%40campusapi.org",
    "..."
  ]

• vaultId: (string)

  specify in which vault to create this qualifier

  Example:

  authorization.Vault%3A8374%40base.url

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Qualifier",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this qualifier, provided by system.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this qualifier, provided by system.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this qualifier for display.",
      "type": "string"
    },
    "description": {
      "description": "The description of this qualifier.",
      "type": "string"
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this qualifier. Default type set by system unless specified in query parameter.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "recordTypeIds": {
      "description": "Type Ids of record types available on this qualifier. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
      "type": "array",
      "items": {
        "type": "string",
        "format": "osid-id"
      },
      "readOnly": true
    }
  }
}

Example:

{
  "displayName": "Display Name of this Qualifier",
  "description": "The description of this Qualifier"
}

Query Parameters

• offset: (integer - default: 0)

  Skip over a number of elements by specifying an offset value for the query

  Example:

  20

• limit: (integer - default: 10)

  Limit the number of elements on the response

  Example:

  80

• expand: (string)

  Expand object or type for named attribute: "genusType", "recordType", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.

  Example:

  all

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "QualifierQuery",
  "type": "object",
  "properties": {
    "matchIds": {
      "description": "List of Ids to match. Boolean OR performed among multiple Ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchKeywords": {
      "description": "List keywords to match. Multiple keywords can be added to perform a boolean OR among them. A keyword may be applied to any of the elements defined in this object such as the display name, description or any attribute defined in or implemented by this object.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "keyword": {
            "description": "keyword to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchDisplayNames": {
      "description": "List of displayName strings to match. Boolean OR performed among multiple displayNames.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "displayName": {
            "description": "displayName to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchDescriptions": {
      "description": "List of discription strings to match. Boolean OR performed among multiple descriptions.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "description": {
            "description": "description to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchGenusTypeIds": {
      "description": "List of genus type ids to match. Boolean OR performed among multiple ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "genusTypeid": {
            "description": "genus type id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchRecordTypeIds": {
      "description": "List of record type ids to match. Boolean OR performed among multiple ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "genusTypeid": {
            "description": "record type id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchVaultIds": {
      "description": "List of Vault Id's to match.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "vaultId": {
            "description": "Vault id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "vaultQueries": {
      "description": "VaultQueries to match Vault. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    }
  }
}

Example:

{
  "matchDisplayNames": [
    {
      "displayName": "string to exclude",
      "match": false
    }
  ]
}

Query Parameters

• genusType: (string)

  specify a particular qualifier type to create

  Example:

  type.Type%3AexampleQualifierType%40dxtera.org

• recordType: (array of )

  specify support for one or more qualifier record types

  Example:

  [
    "type.Type%3AexampleQualifierRecordType%40campusapi.org",
    "..."
  ]

• vaultId: (string)

  specify in which vault to create this qualifier

  Example:

  authorization.Vault%3A8374%40base.url

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

[
  {
    "id": "authorization.Qualifier:5611@base.url",
    "uri": "http://base.url/open/campusapi/authorization/qualifier/authorization.Qualifier%3A5611%40base.url",
    "displayName": "Display Name of this Qualifier",
    "description": "The description of this Qualifier",
    "genusTypeId": "type.Type:defaultQualifierType@base.url",
    "recordTypeIds": [ "type.Type:exampleQualifierRecordType@campusapi.org", "..."]
  },
  {
    "...": "..."
  }
]

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

URI Parameters

• qualifierId: required(string)

URI Parameters

• qualifierId: required(string)

URI Parameters

• qualifierId: required(string)

URI Parameters

• qualifierId: required(string)

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Qualifier",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this qualifier, provided by system.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this qualifier, provided by system.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this qualifier for display.",
      "type": "string"
    },
    "description": {
      "description": "The description of this qualifier.",
      "type": "string"
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this qualifier. Default type set by system unless specified in query parameter.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "recordTypeIds": {
      "description": "Type Ids of record types available on this qualifier. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
      "type": "array",
      "items": {
        "type": "string",
        "format": "osid-id"
      },
      "readOnly": true
    }
  }
}

Example:

{
  "displayName": "Display Name of this Qualifier",
  "description": "The description of this Qualifier"
}

URI Parameters

• qualifierId: required(string)

URI Parameters

• qualifierId: required(string)

URI Parameters

• qualifierId: required(string)

URI Parameters

• qualifierId: required(string)
• childId: required(string)

URI Parameters

• qualifierId: required(string)
• childId: required(string)

URI Parameters

• qualifierId: required(string)

Query Parameters

• offset: (integer - default: 0)

  Skip over a number of elements by specifying an offset value for the query

  Example:

  20

• limit: (integer - default: 10)

  Limit the number of elements on the response

  Example:

  80

• expand: (string)

  Expand object or type for named attribute: "genusType", "recordType", "provider", "branding", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.

  Example:

  all

• genusTypeId: (string)

  The id string to match a genusType

  Example:

  type.Type%3AexampleVaultType%40dxtera.org

• parentGenusTypeId: (string)

  The id string to match a parent genusType

  Example:

  type.Type%3AparentTypeExampleVaultType%40dxtera.org

• recordTypeId: (string)

  The id string to match a recordType

  Example:

  type.Type%3AexampleVaultType%40campusapi.org

• providerId: (string)

  Id string to match provider.

  Example:

  resource.Resource%3A3007%40demo.dxtera.org

• authorizationId: (string)

  Get vaults mapped to this authorization.

  Example:

  authorization.Authorization%3A845%40demo.dxtera.org

• functionId: (string)

  Get vaults mapped to this function.

  Example:

  authorization.Function%3A520%40demo.dxtera.org

• qualifierId: (string)

  Get vaults mapped to this qualifier.

  Example:

  authorization.Qualifier%3A585%40demo.dxtera.org

Query Parameters

• genusType: (string)

  specify a particular vault type to create

  Example:

  type.Type%3AexampleVaultType%40dxtera.org

• recordType: (array of )

  specify support for one or more vault record types

  Example:

  [
    "type.Type%3AexampleVaultRecordType%40campusapi.org",
    "..."
  ]

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Vault",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this vault, provided by system.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this vault, provided by system.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this vault for display.",
      "type": "string"
    },
    "description": {
      "description": "The description of this vault.",
      "type": "string"
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this vault. Default type set by system unless specified in query parameter.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "recordTypeIds": {
      "description": "Type Ids of record types available on this vault. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
      "type": "array",
      "items": {
        "type": "string",
        "format": "osid-id"
      },
      "readOnly": true
    },
    "providerId": {
      "description": "The provider of this vault.",
      "type": "string",
      "format": "osid-id"
    },
    "brandingIds": {
      "description": "The branding of this vault. A collection of Assets.",
      "type": "array",
      "items" : {
        "type": "string",
        "format": "osid-id"
      }
    },
    "license": {
      "description": "The licensing that applies to this vault.",
      "type": "string"
    }
  }
}

Example:

{
  "displayName": "Display Name of this Vault",
  "description": "The description of this Vault",
  "providerId": "resource.Resource:123@base.url",
  "brandingId": "asset.Asset:Vault@base.url",
  "license": "The license that applies to this Vault"
}

Query Parameters

• offset: (integer - default: 0)

  Skip over a number of elements by specifying an offset value for the query

  Example:

  20

• limit: (integer - default: 10)

  Limit the number of elements on the response

  Example:

  80

• expand: (string)

  Expand object or type for named attribute: "genusType", "recordType", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.

  Example:

  all

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "VaultQuery",
  "type": "object",
  "properties": {
    "matchIds": {
      "description": "List of Ids to match. Boolean OR performed among multiple Ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchKeywords": {
      "description": "List keywords to match. Multiple keywords can be added to perform a boolean OR among them. A keyword may be applied to any of the elements defined in this object such as the display name, description or any attribute defined in or implemented by this object.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "keyword": {
            "description": "keyword to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchDisplayNames": {
      "description": "List of displayName strings to match. Boolean OR performed among multiple displayNames.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "displayName": {
            "description": "displayName to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchDescriptions": {
      "description": "List of discription strings to match. Boolean OR performed among multiple descriptions.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "description": {
            "description": "description to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchGenusTypeIds": {
      "description": "List of genus type ids to match. Boolean OR performed among multiple ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "genusTypeid": {
            "description": "genus type id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchRecordTypeIds": {
      "description": "List of record type ids to match. Boolean OR performed among multiple ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "genusTypeid": {
            "description": "record type id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchProviderIds": {
      "description": "List of provider Ids to match.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "stateId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "providerQueries": {
      "description": "resource.ResourceQuery for provider. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
    },
    "matchAnyProvider": {
      "description": "Match providers with any value. true to match Vault with any provider, false to match Vault with no provider",
      "type": "boolean"
      }
    },
    "matchBrandingIds": {
      "description": "List of branding asset Ids to match.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "stateId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "brandingQueries": {
      "description": "repository.AssetQuery for branding. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "matchAnyBranding": {
      "description": "Match brandingss with any value. true to match Vault with any branding, false to match Vault with no branding",
      "type": "boolean"
    },
    "matchlicenses": {
      "description": "List of license strings to match. Boolean OR performed among multiple descriptions.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "license": {
            "description": "license to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchVaultIds": {
      "description": "List of Vault Id's to match.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "vaultId": {
            "description": "Vault id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "vaultQueries": {
      "description": "VaultQueries to match Vault. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    }
  }
}

Example:

{
  "matchDisplayNames": [
    {
      "displayName": "string to exclude",
      "match": false
    }
  ]
}

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{
  "$schema": "http://json-schema.org/draft/2019-9/schema#",
  "title": "Vault",
  "type": "object",
  "required": ["displayName"],
  "properties": {
    "id": {
      "description": "The unique id of this vault, provided by system.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this vault, provided by system.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this vault for display.",
      "type": "string",
      "read-only": false,
      "minLength": 1,
      "maxLength": 128,
      "pattern": "",
      "default": "",
      "enum": [],
      "elementId": "Vault.Vault:displayName@base.url",
      "existingValue": "The Existing Name",
      "elementLabel": "Name",
      "instructions": "Enter a name for this vault",
      "linked": false
    },
    "description": {
      "description": "The description of this vault.",
      "type": "string",
      "read-only": false,
      "minLength": 0,
      "maxLength": 128,
      "pattern": "",
      "default": "",
      "enum": [],
      "elementId": "Vault.Vault:displayName@demo.base.url",
      "existingValue": "The Existing Description",
      "elementLabel": "Description",
      "instructions": "Enter a description for this vault",
      "linked": false
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this vault. Default type set by system unless specified in query parameter on initial post.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "recordTypeIds": {
      "description": "Type Ids of record types available on this vault. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
      "type": "array",
      "items": {
        "type": "string",
        "format": "osid-id"
      },
      "readOnly": true
    },
    "providerId": {
      "description": "The provider of this vault.",
      "type": "string",
      "format": "osid-id",
      "read-only": false,
      "pattern": "",
      "default": "",
      "enum": [],
      "elementId": "Vault.Vault:provider@base.url",
      "existingValue": "",
      "elementLabel": "Provider",
      "instructions": "Enter the provider of this vault",
      "linked": false
    },
    "brandingIds": {
      "description": "The branding of this vault. A list of Assets.",
      "type": "array",
      "items" : {
        "type": "string",
        "format": "osid-id",
        "pattern": "",
        "enum": []
      },
      "read-only": false,
      "default": [],
      "elementId": "Vault.Vault:branding@base.url",
      "existingValue": "",
      "elementLabel": "Branding",
      "instructions": "Enter the branding images for this vault",
      "linked": false
    },
    "license": {
      "description": "The licensing that applies to this vault.",
      "type": "string",
      "read-only": false,
      "minLength": 0,
      "maxLength": 128,
      "pattern": "",
      "default": "",
      "enum": [],
      "elementId": "Vault.Vault:license@base.url",
      "existingValue": "The Existing License",
      "elementLabel": "License",
      "instructions": "Include a license for this vault",
      "linked": false
    }
  }
}

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

[
  {
    "id": "authorization.Vault:1561@base.url",
    "uri": "http://base.url/open/campusapi/authorization/vault/authorization.Vault%3A1561%40base.url",
    "displayName": "Display Name of this Vault",
    "description": "The description of this Vault",
    "genusTypeId": "type.Type:defaultVaultType@base.url",
    "recordTypeIds": [ "type.Type:exampleVaultRecordType@campusapi.org", "..."],
    "providerId": "resource.Resource:123@base.url",
    "brandingId": "asset.Asset:Vault@base.url",
    "license": "The license that applies to this Vault"
  },
  {
    "...": "..."
  }
]

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

URI Parameters

• vaultId: required(string)

URI Parameters

• vaultId: required(string)

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Vault",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this vault, provided by system.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this vault, provided by system.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this vault for display.",
      "type": "string"
    },
    "description": {
      "description": "The description of this vault.",
      "type": "string"
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this vault. Default type set by system unless specified in query parameter.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "recordTypeIds": {
      "description": "Type Ids of record types available on this vault. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
      "type": "array",
      "items": {
        "type": "string",
        "format": "osid-id"
      },
      "readOnly": true
    },
    "providerId": {
      "description": "The provider of this vault.",
      "type": "string",
      "format": "osid-id"
    },
    "brandingIds": {
      "description": "The branding of this vault. A collection of Assets.",
      "type": "array",
      "items" : {
        "type": "string",
        "format": "osid-id"
      }
    },
    "license": {
      "description": "The licensing that applies to this vault.",
      "type": "string"
    }
  }
}

Example:

{
  "displayName": "Display Name of this Vault",
  "description": "The description of this Vault",
  "providerId": "resource.Resource:123@base.url",
  "brandingId": "asset.Asset:Vault@base.url",
  "license": "The license that applies to this Vault"
}

URI Parameters

• vaultId: required(string)

URI Parameters

• vaultId: required(string)

URI Parameters

• vaultId: required(string)

URI Parameters

• vaultId: required(string)
• childId: required(string)

URI Parameters

• vaultId: required(string)
• childId: required(string)

URI Parameters

• vaultId: required(string)

URI Parameters

• vaultId: required(string)

Query Parameters

• offset: (integer - default: 0)

  Skip over a number of elements by specifying an offset value for the query

  Example:

  20

• limit: (integer - default: 10)

  Limit the number of elements on the response

  Example:

  80

• expand: (string)

  Expand object or type for named attribute: "genusType", "recordType", "endReason", "agent", "function", "qualifier", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.

  Example:

  all

• genusTypeId: (string)

  The id string to match a genusType

  Example:

  type.Type%3AexampleAuthorizationType%40dxtera.org

• parentGenusTypeId: (string)

  The id string to match a parent genusType

  Example:

  type.Type%3AparentTypeExampleAuthorizationType%40dxtera.org

• recordTypeId: (string)

  The id string to match a recordType

  Example:

  type.Type%3AexampleAuthorizationType%40campusapi.org

URI Parameters

• vaultId: required(string)
• authorizationId: required(string)

URI Parameters

• vaultId: required(string)
• authorizationId: required(string)

URI Parameters

• vaultId: required(string)

Query Parameters

• offset: (integer - default: 0)

  Skip over a number of elements by specifying an offset value for the query

  Example:

  20

• limit: (integer - default: 10)

  Limit the number of elements on the response

  Example:

  80

• expand: (string)

  Expand object or type for named attribute: "genusType", "recordType", "rule", "qualifierHierarchy", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.

  Example:

  all

• genusTypeId: (string)

  The id string to match a genusType

  Example:

  type.Type%3AexampleFunctionType%40dxtera.org

• parentGenusTypeId: (string)

  The id string to match a parent genusType

  Example:

  type.Type%3AparentTypeExampleFunctionType%40dxtera.org

• recordTypeId: (string)

  The id string to match a recordType

  Example:

  type.Type%3AexampleFunctionType%40campusapi.org

URI Parameters

• vaultId: required(string)
• functionId: required(string)

URI Parameters

• vaultId: required(string)
• functionId: required(string)

URI Parameters

• vaultId: required(string)

Query Parameters

• offset: (integer - default: 0)

  Skip over a number of elements by specifying an offset value for the query

  Example:

  20

• limit: (integer - default: 10)

  Limit the number of elements on the response

  Example:

  80

• expand: (string)

  Expand object or type for named attribute: "genusType", "recordType", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.

  Example:

  all

• genusTypeId: (string)

  The id string to match a genusType

  Example:

  type.Type%3AexampleQualifierType%40dxtera.org

• parentGenusTypeId: (string)

  The id string to match a parent genusType

  Example:

  type.Type%3AparentTypeExampleQualifierType%40dxtera.org

• recordTypeId: (string)

  The id string to match a recordType

  Example:

  type.Type%3AexampleQualifierType%40campusapi.org

URI Parameters

• vaultId: required(string)
• qualifierId: required(string)

URI Parameters

• vaultId: required(string)
• qualifierId: required(string)