blob: 44482854dd8e1051554cfd875e18bf864565ac3a [file] [log] [blame]
{
"openapi": "3.0.0",
"info": {
"title": "CDP ACLs",
"version": "0.8.4s"
},
"paths": {},
"components": {
"schemas": {
"ResultTri": {
"type": "string",
"enum": [
"UNKOWN",
"YES",
"NO"
],
"default": "UNKOWN"
},
"cogniteCapability": {
"type": "array",
"items": {
"type": "object",
"oneOf": [
{
"properties": {
"groupsAcl": {
"$ref": "#/components/schemas/cognitegroups_aclAcl"
}
}
},
{
"properties": {
"assetsAcl": {
"$ref": "#/components/schemas/cogniteassets_aclAcl"
}
}
},
{
"properties": {
"eventsAcl": {
"$ref": "#/components/schemas/cogniteevents_aclAcl"
}
}
},
{
"properties": {
"filesAcl": {
"$ref": "#/components/schemas/cognitefiles_aclAcl"
}
}
},
{
"properties": {
"usersAcl": {
"$ref": "#/components/schemas/cogniteusers_aclAcl"
}
}
},
{
"properties": {
"projectsAcl": {
"$ref": "#/components/schemas/cogniteprojects_aclAcl"
}
}
},
{
"properties": {
"securityCategoriesAcl": {
"$ref": "#/components/schemas/cognitesecuritycategories_aclAcl"
}
}
},
{
"properties": {
"rawAcl": {
"$ref": "#/components/schemas/cogniteraw_aclAcl"
}
}
},
{
"properties": {
"timeSeriesAcl": {
"$ref": "#/components/schemas/cognitetimeseries_aclAcl"
}
}
},
{
"properties": {
"apikeysAcl": {
"$ref": "#/components/schemas/cogniteapikeys_aclAcl"
}
}
},
{
"properties": {
"threedAcl": {
"$ref": "#/components/schemas/cognitethreed_aclAcl"
}
}
},
{
"properties": {
"sequencesAcl": {
"$ref": "#/components/schemas/cognitesequences_aclAcl"
}
}
},
{
"properties": {
"analyticsAcl": {
"$ref": "#/components/schemas/cogniteanalytics_aclAcl"
}
}
}
]
},
"title": "Capability"
},
"cogniteanalytics_aclAcl": {
"type": "object",
"properties": {
"actions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/cogniteanalytics_aclAction"
}
},
"scope": {
"$ref": "#/components/schemas/cogniteanalytics_aclScope"
}
},
"title": "Acl:Analytics"
},
"cogniteanalytics_aclAction": {
"type": "string",
"enum": [
"READ",
"EXECUTE",
"LIST"
],
"default": "READ",
"title": "Analytics:Action"
},
"cogniteanalytics_aclScope": {
"type": "object",
"properties": {
"all": {
"$ref": "#/components/schemas/generic_aclAllScope"
}
},
"title": "Analytics:Scope"
},
"cogniteapikeys_aclAcl": {
"type": "object",
"properties": {
"actions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/cogniteapikeys_aclAction"
}
},
"scope": {
"$ref": "#/components/schemas/cogniteapikeys_aclScope"
}
},
"title": "Acl:Apikey"
},
"cogniteapikeys_aclAction": {
"type": "string",
"enum": [
"LIST",
"CREATE",
"DELETE"
],
"default": "LIST",
"title": "Apikey:Action"
},
"cogniteapikeys_aclScope": {
"type": "object",
"oneOf": [
{
"properties": {
"all": {
"$ref": "#/components/schemas/generic_aclAllScope"
}
}
},
{
"properties": {
"currentuserscope": {
"$ref": "#/components/schemas/generic_aclCurrentUserScope",
"title": "apikeys the user making the request has"
}
}
}
],
"title": "Apikey:Scope"
},
"cogniteassets_aclAcl": {
"type": "object",
"properties": {
"actions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/cogniteassets_aclAction"
}
},
"scope": {
"$ref": "#/components/schemas/cogniteassets_aclScope"
}
},
"title": "Acl:Asset"
},
"cogniteassets_aclAction": {
"type": "string",
"enum": [
"READ",
"WRITE"
],
"default": "READ",
"title": "Asset:Action"
},
"cogniteassets_aclIdScope": {
"type": "object",
"properties": {
"subtreeIds": {
"type": "array",
"items": {
"type": "string",
"format": "uint64"
},
"title": "root asset id (subtrees)"
}
},
"title": "Scope:AssetIdScope"
},
"cogniteassets_aclScope": {
"type": "object",
"properties": {
"all": {
"$ref": "#/components/schemas/generic_aclAllScope"
}
},
"title": "Asset:Scope"
},
"cogniteevents_aclAcl": {
"type": "object",
"properties": {
"actions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/cogniteevents_aclAction"
}
},
"scope": {
"$ref": "#/components/schemas/cogniteevents_aclScope"
}
},
"title": "Acl:Event"
},
"cogniteevents_aclAction": {
"type": "string",
"enum": [
"READ",
"WRITE"
],
"default": "READ",
"title": "Event:Action"
},
"cogniteevents_aclScope": {
"type": "object",
"properties": {
"all": {
"$ref": "#/components/schemas/generic_aclAllScope"
}
},
"title": "Event:Scope"
},
"cognitefiles_aclAcl": {
"type": "object",
"properties": {
"actions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/cognitefiles_aclAction"
}
},
"scope": {
"$ref": "#/components/schemas/cognitefiles_aclScope"
}
},
"title": "Acl:File"
},
"cognitefiles_aclAction": {
"type": "string",
"enum": [
"READ",
"WRITE"
],
"default": "READ",
"title": "File:Action"
},
"cognitefiles_aclScope": {
"type": "object",
"properties": {
"all": {
"$ref": "#/components/schemas/generic_aclAllScope"
}
},
"title": "File:Scope"
},
"cognitegroups_aclAcl": {
"type": "object",
"properties": {
"actions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/cognitegroups_aclAction"
}
},
"scope": {
"$ref": "#/components/schemas/cognitegroups_aclScope"
}
},
"title": "Acl:Group"
},
"cognitegroups_aclAction": {
"type": "string",
"enum": [
"LIST",
"READ",
"CREATE",
"UPDATE",
"DELETE"
],
"default": "LIST",
"title": "Group:Action"
},
"cognitegroups_aclScope": {
"type": "object",
"oneOf": [
{
"properties": {
"all": {
"$ref": "#/components/schemas/generic_aclAllScope",
"title": "all groups"
}
}
},
{
"properties": {
"currentuserscope": {
"$ref": "#/components/schemas/generic_aclCurrentUserScope",
"title": "groups the current user is in"
}
}
}
],
"title": "Group:Scope"
},
"cogniteprojects_aclAcl": {
"type": "object",
"properties": {
"actions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/cogniteprojects_aclAction"
}
},
"scope": {
"$ref": "#/components/schemas/cogniteprojects_aclScope"
}
},
"title": "Acl:Project"
},
"cogniteprojects_aclAction": {
"type": "string",
"enum": [
"LIST",
"READ",
"CREATE",
"UPDATE"
],
"default": "LIST",
"title": "Project:Action"
},
"cogniteprojects_aclScope": {
"type": "object",
"properties": {
"all": {
"$ref": "#/components/schemas/generic_aclAllScope"
}
},
"title": "Project:Scope"
},
"cogniteraw_aclAcl": {
"type": "object",
"properties": {
"actions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/cogniteraw_aclAction"
}
},
"scope": {
"$ref": "#/components/schemas/cogniteraw_aclScope"
}
},
"title": "Acl:Raw"
},
"cogniteraw_aclAction": {
"type": "string",
"enum": [
"READ",
"WRITE",
"LIST"
],
"default": "READ",
"title": "Raw:Action"
},
"cogniteraw_aclScope": {
"type": "object",
"properties": {
"all": {
"$ref": "#/components/schemas/generic_aclAllScope"
}
},
"title": "Raw:Scope"
},
"cognitesecuritycategories_aclAcl": {
"type": "object",
"properties": {
"actions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/cognitesecuritycategories_aclAction"
}
},
"scope": {
"$ref": "#/components/schemas/cognitesecuritycategories_aclScope"
}
},
"title": "Acl:SecurityCategory"
},
"cognitesecuritycategories_aclAction": {
"type": "string",
"enum": [
"MEMBEROF",
"LIST",
"CREATE",
"DELETE"
],
"default": "MEMBEROF",
"title": "SecurityCategory:Action"
},
"cognitesecuritycategories_aclScope": {
"type": "object",
"properties": {
"all": {
"$ref": "#/components/schemas/generic_aclAllScope"
}
},
"title": "SecurityCategory:Scope"
},
"cognitesequences_aclAcl": {
"type": "object",
"properties": {
"actions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/cognitesequences_aclAction"
}
},
"scope": {
"$ref": "#/components/schemas/cognitesequences_aclScope"
}
},
"title": "Acl:Sequences"
},
"cognitesequences_aclAction": {
"type": "string",
"enum": [
"READ",
"WRITE"
],
"default": "READ",
"title": "Sequences:Action"
},
"cognitesequences_aclScope": {
"type": "object",
"properties": {
"all": {
"$ref": "#/components/schemas/generic_aclAllScope"
}
},
"title": "Sequences:Scope"
},
"cognitethreed_aclAcl": {
"type": "object",
"properties": {
"actions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/cognitethreed_aclAction"
}
},
"scope": {
"$ref": "#/components/schemas/cognitethreed_aclScope"
}
},
"title": "Acl:Threed"
},
"cognitethreed_aclAction": {
"type": "string",
"enum": [
"READ",
"CREATE",
"UPDATE",
"DELETE"
],
"default": "READ",
"title": "Threed:Action"
},
"cognitethreed_aclScope": {
"type": "object",
"properties": {
"all": {
"$ref": "#/components/schemas/generic_aclAllScope"
}
},
"title": "Threed:Scope"
},
"cognitetimeseries_aclAcl": {
"type": "object",
"properties": {
"actions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/cognitetimeseries_aclAction"
}
},
"scope": {
"$ref": "#/components/schemas/cognitetimeseries_aclScope"
}
},
"title": "Acl:Timeseries"
},
"cognitetimeseries_aclAction": {
"type": "string",
"enum": [
"READ",
"WRITE"
],
"default": "READ",
"title": "Timeseries:Action"
},
"cognitetimeseries_aclScope": {
"type": "object",
"oneOf": [
{
"properties": {
"all": {
"$ref": "#/components/schemas/generic_aclAllScope"
}
}
},
{
"properties": {
"assetIdScope": {
"$ref": "#/components/schemas/cogniteassets_aclIdScope"
}
}
}
],
"title": "Timeseries:Scope"
},
"cogniteusers_aclAcl": {
"type": "object",
"properties": {
"actions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/cogniteusers_aclAction"
}
},
"scope": {
"$ref": "#/components/schemas/cogniteusers_aclScope"
}
},
"title": "Acl:User"
},
"cogniteusers_aclAction": {
"type": "string",
"enum": [
"LIST",
"CREATE",
"DELETE"
],
"default": "LIST",
"title": "User:Action"
},
"cogniteusers_aclScope": {
"type": "object",
"oneOf": [
{
"properties": {
"all": {
"$ref": "#/components/schemas/generic_aclAllScope",
"title": "all users"
}
}
},
{
"properties": {
"currentuserscope": {
"$ref": "#/components/schemas/generic_aclCurrentUserScope",
"title": "the current user making the request"
}
}
}
],
"title": "User:Scope"
},
"generic_aclAllScope": {
"type": "object",
"title": "Scope:All"
},
"generic_aclCurrentUserScope": {
"type": "object",
"title": "Scope:CurrentUser"
},
"generic_aclResult": {
"type": "object",
"properties": {
"result": {
"$ref": "#/components/schemas/ResultTri",
"title": "Result status"
},
"message": {
"type": "string",
"title": "Result message"
}
},
"title": "Result"
}
}
}
}