Definitions for @turbot/azure-activedirectory

activeDirectory

Schema
{
"allOf": [
{
"$ref": "turbot#/definitions/service"
},
{
"type": "object",
"properties": {
"name": {
"const": "Active Directory"
}
}
}
],
".turbot": {
"uri": "tmod:@turbot/azure-activedirectory#/definitions/activeDirectory",
"modUri": "tmod:@turbot/azure-activedirectory"
}
}

application

Schema
{
"type": "object",
"properties": {
"objectId": {
"$ref": "#/definitions/objectId"
},
"id": {
"$ref": "#/definitions/objectId"
},
"displayName": {
"type": "string"
},
"appId": {
"type": "string"
},
"turbot": {
"type": "object",
"properties": {
"akas": {
"type": "array",
"items": {
"$ref": "#/definitions/applicationAka"
}
},
"custom": {
"type": "object",
"properties": {
"createTimestamp": {
"$ref": "turbot#/definitions/isoTimestamp"
},
"azure": {
"$ref": "azure#/definitions/azureMetadata"
}
}
}
}
}
},
"additionalProperties": true,
"tests": [
{
"description": "all properties provided",
"input": {
"objectId": "72aba83d-b4ed-4d97-910b-e9a2a4162b69",
"displayName": "Testing",
"appId": "82f1e82f-49fb-4fea-9c35-650bd4dc5d37",
"turbot": {
"akas": [
"azure:///application/72aba83d-b4ed-4d97-910b-e9a2a4162b69"
],
"custom": {
"azure": {
"tenantId": "1c2d0b7e-7d6a-4f05-84c0-b808a0ab455b"
}
}
}
}
}
],
".turbot": {
"uri": "tmod:@turbot/azure-activedirectory#/definitions/application",
"modUri": "tmod:@turbot/azure-activedirectory"
}
}

applicationAka

Schema
{
"type": "string",
"pattern": "^azure:///application/[a-f0-9-]{36}$",
"tests": [
{
"description": "base",
"input": "azure:///application/72aba83d-b4ed-4d97-910b-e9a2a4162b69"
},
{
"description": "invalid aka",
"input": "gcp://serviceusage.googleapis.com/projects/cse-legolas-2/services/compute.googleapis.com",
"expected": false
}
],
".turbot": {
"uri": "tmod:@turbot/azure-activedirectory#/definitions/applicationAka",
"modUri": "tmod:@turbot/azure-activedirectory"
}
}

clientSecret

Schema
{
"type": "object",
"properties": {
"keyId": {
"type": "string"
},
"startDate": {
"type": "string"
},
"endDate": {
"type": "string"
},
"turbot": {
"type": "object",
"properties": {
"akas": {
"type": "array",
"items": {
"$ref": "#/definitions/clientSecretAka"
}
},
"custom": {
"type": "object",
"properties": {
"objectId": {
"type": "string"
},
"createTimestamp": {
"$ref": "turbot#/definitions/isoTimestamp"
},
"azure": {
"$ref": "azure#/definitions/azureMetadata"
}
}
}
}
}
},
"additionalProperties": true,
"tests": [
{
"description": "all properties provided",
"input": {
"keyId": "82f1e82f-49fb-4fea-9c35-650bd4dc5d37",
"startDate": "2021-03-04T13:15:52.884000+00:00",
"endDate": "2299-12-30T18:30:00+00:00",
"turbot": {
"akas": [
"azure:///application/72aba83d-b4ed-4d97-910b-e9a2a4162b69/clientsecret/07be0325-f262-4c4f-bd0c-64d0f6be8795"
],
"custom": {
"objectId": "72aba83d-b4ed-4d97-910b-e9a2a4162b69",
"azure": {
"tenantId": "1c2d0b7e-7d6a-4f05-84c0-b808a0ab455b"
}
}
}
}
}
],
".turbot": {
"uri": "tmod:@turbot/azure-activedirectory#/definitions/clientSecret",
"modUri": "tmod:@turbot/azure-activedirectory"
}
}

clientSecretAka

Schema
{
"type": "string",
"pattern": "^azure:///application/[a-f0-9-]{36}/clientsecret/([a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12})*$",
"tests": [
{
"description": "base",
"input": "azure:///application/72aba83d-b4ed-4d97-910b-e9a2a4162b69/clientsecret/07be0325-f262-4c4f-bd0c-64d0f6be8795"
},
{
"description": "invalid aka",
"input": "gcp://serviceusage.googleapis.com/projects/cse-legolas-2/services/compute.googleapis.com",
"expected": false
}
],
".turbot": {
"uri": "tmod:@turbot/azure-activedirectory#/definitions/clientSecretAka",
"modUri": "tmod:@turbot/azure-activedirectory"
}
}

customDomain

Schema
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"isDefault": {
"type": "boolean"
},
"isInitial": {
"type": "boolean"
},
"isRoot": {
"type": "boolean"
},
"turbot": {
"type": "object",
"properties": {
"akas": {
"type": "array",
"items": {
"$ref": "#/definitions/customDomainAka"
}
},
"custom": {
"type": "object",
"properties": {
"createTimestamp": {
"$ref": "turbot#/definitions/isoTimestamp"
},
"azure": {
"$ref": "azure#/definitions/azureMetadata"
}
}
}
}
}
},
"additionalProperties": true,
"tests": [
{
"description": "all properties provided",
"input": {
"name": "turbot.com",
"turbot": {
"akas": [
"azure:///directory/1c2d0b7e-7d6a-4f05-84c0-b808a0ab455b/customdomain/turbot.com"
],
"custom": {
"azure": {
"tenantId": "1c2d0b7e-7d6a-4f05-84c0-b808a0ab455b"
}
}
}
}
}
],
".turbot": {
"uri": "tmod:@turbot/azure-activedirectory#/definitions/customDomain",
"modUri": "tmod:@turbot/azure-activedirectory"
}
}

customDomainAka

Schema
{
"type": "string",
"pattern": "^azure:///directory/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}/customdomain/[a-zA-Z0-9-.]{4,48}$",
"tests": [
{
"description": "base",
"input": "azure:///directory/1c2d0b7e-7d6a-4f05-84c0-b808a0ab455b/customdomain/turbot.com"
},
{
"description": "invalid aka",
"input": "gcp://serviceusage.googleapis.com/projects/cse-legolas-2/services/compute.googleapis.com",
"expected": false
}
],
".turbot": {
"uri": "tmod:@turbot/azure-activedirectory#/definitions/customDomainAka",
"modUri": "tmod:@turbot/azure-activedirectory"
}
}

directory

Schema
{
"type": "object",
"properties": {
"id": {
"$ref": "azure#/definitions/tenantId"
},
"tenantId": {
"$ref": "azure#/definitions/tenantId"
},
"userDeltaLink": {
"type": "string"
},
"groupDeltaLink": {
"type": "string"
},
"turbot": {
"type": "object",
"properties": {
"title": {
"type": "string"
},
"akas": {
"type": "array",
"items": {
"$ref": "#/definitions/directoryAka"
}
},
"custom": {
"type": "object",
"properties": {
"azure": {
"$ref": "azure#/definitions/azureMetadata"
}
}
}
}
}
},
"tests": [
{
"description": "Valid - All properties given",
"input": {
"tenantId": "cdffd708-7da0-4cea-abeb-0a4cabcd1234",
"id": "cdffd708-7da0-4cea-abeb-0a4cabcd1234",
"turbot": {
"title": "cdffd708-7da0-4cea-abeb-0a4cabcd1234",
"akas": [
"azure:///directory/cdffd708-7da0-4cea-abeb-0a4cabcd1234"
],
"custom": {
"azure": {
"tenantId": "cdffd708-7da0-4cea-abeb-0a4cabcd1234"
}
}
}
}
}
],
".turbot": {
"uri": "tmod:@turbot/azure-activedirectory#/definitions/directory",
"modUri": "tmod:@turbot/azure-activedirectory"
}
}

directoryAka

Schema
{
"type": "string",
"pattern": "^azure:///directory/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$",
"tests": [
{
"description": "valid - base",
"input": "azure:///directory/cdffd708-7da0-4cea-abeb-0a4cabcd1234"
},
{
"description": "invalid - azure prefix not provided",
"input": "/directory/cdffd708-7da0-4cea-abeb-0a4cabcd1234",
"expected": false
}
],
".turbot": {
"uri": "tmod:@turbot/azure-activedirectory#/definitions/directoryAka",
"modUri": "tmod:@turbot/azure-activedirectory"
}
}

group

Schema
{
"type": "object",
"properties": {
"objectId": {
"$ref": "#/definitions/objectId"
},
"id": {
"$ref": "#/definitions/objectId"
},
"deletedDateTime": {
"type": "string"
},
"classification": {
"type": "string"
},
"createdDateTime": {
"type": "string"
},
"description": {
"type": "string"
},
"displayName": {
"type": "string"
},
"isAssignableToRole": {
"type": "string"
},
"mail": {
"type": "string"
},
"mailEnabled": {
"type": "boolean"
},
"creationOptions": {
"type": "array"
},
"mailNickname": {
"type": "string"
},
"onPremisesDomainName": {
"type": "string"
},
"onPremisesLastSyncDateTime": {
"type": "string"
},
"onPremisesNetBiosName": {
"type": "string"
},
"onPremisesSamAccountName": {
"type": "string"
},
"onPremisesSecurityIdentifier": {
"type": "string"
},
"onPremisesSyncEnabled": {
"type": "string"
},
"preferredDataLocation": {
"type": "string"
},
"renewedDateTime": {
"type": "string"
},
"visibility": {
"type": "string"
},
"securityIdentifier": {
"type": "string"
},
"securityEnabled": {
"type": "boolean"
},
"groupTypes": {
"type": "array"
},
"proxyAddresses": {
"type": "array"
},
"resourceBehaviorOptions": {
"type": "array"
},
"resourceProvisioningOptions": {
"type": "array"
},
"onPremisesProvisioningErrors": {
"type": "array"
},
"turbot": {
"type": "object",
"properties": {
"akas": {
"type": "array",
"items": {
"$ref": "#/definitions/groupAka"
}
},
"custom": {
"type": "object",
"properties": {
"createTimestamp": {
"$ref": "turbot#/definitions/isoTimestamp"
},
"azure": {
"$ref": "azure#/definitions/azureMetadata"
}
}
}
}
}
},
"additionalProperties": true,
"tests": [
{
"description": "all properties provided",
"input": {
"id": "02bd9fd6-8f93-4758-87c3-1fb73740a315",
"deletedDateTime": null,
"classification": null,
"createdDateTime": "2017-07-31T18:56:16Z",
"creationOptions": [
"ExchangeProvisioningFlags:481"
],
"description": "Welcome to the HR Taskforce team.",
"displayName": "HR Taskforce",
"groupTypes": [
"Unified"
],
"isAssignableToRole": null,
"mail": "HRTaskforce@M365x214355.onmicrosoft.com",
"mailEnabled": true,
"mailNickname": "HRTaskforce",
"onPremisesDomainName": null,
"onPremisesLastSyncDateTime": null,
"onPremisesNetBiosName": null,
"onPremisesSamAccountName": null,
"onPremisesSecurityIdentifier": null,
"onPremisesSyncEnabled": null,
"preferredDataLocation": null,
"proxyAddresses": [
"SPO:SPO_896cf652-b200-4b74-8111-c013f64406cf@SPO_dcd219dd-bc68-4b9b-bf0b-4a33a796be35",
"SMTP:HRTaskforce@M365x214355.onmicrosoft.com"
],
"renewedDateTime": "2020-01-24T19:01:14Z",
"resourceBehaviorOptions": [],
"resourceProvisioningOptions": [
"Team"
],
"securityEnabled": false,
"securityIdentifier": "S-1-12-1-45981654-1196986259-3072312199-363020343",
"visibility": "Private",
"onPremisesProvisioningErrors": [],
"turbot": {
"akas": [
"azure:///group/02bd9fd6-8f93-4758-87c3-1fb73740a315"
],
"custom": {
"azure": {
"tenantID": "9e3548cf-17e2-4751-b87e-b72bdd2c77f7"
}
}
}
}
},
{
"description": "invalid - missing required property groupPrincipalName",
"input": {
"surname": "516239f1-63e1-4d78-a4de-a74fb236a071",
"turbot": {
"akas": [
"azure:///group/87d349ed-44d7-43e1-9a83-5f2406dee5bd"
],
"custom": {
"azure": {
"tenantID": "9e3548cf-17e2-4751-b87e-b72bdd2c77f7"
}
}
}
},
"expected": false
}
],
".turbot": {
"uri": "tmod:@turbot/azure-activedirectory#/definitions/group",
"modUri": "tmod:@turbot/azure-activedirectory"
}
}

groupAka

Schema
{
"type": "string",
"pattern": "^azure:///group/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$",
"tests": [
{
"description": "base",
"input": "azure:///group/87d349ed-44d7-43e1-9a83-5f2406dee5bd"
},
{
"description": "invalid aka",
"input": "gcp://serviceusage.googleapis.com/projects/cse-legolas-2/services/compute.googleapis.com",
"expected": false
}
],
".turbot": {
"uri": "tmod:@turbot/azure-activedirectory#/definitions/groupAka",
"modUri": "tmod:@turbot/azure-activedirectory"
}
}

objectId

Schema
{
"type": "string",
"pattern": "^[a-f0-9-]{36}$",
"tests": [
{
"description": "base",
"input": "5cb5a48e-ee01-40ba-a5e6-8f7114930866"
},
{
"description": "invalid id",
"input": "/5cb5a48e-ee01-40ba-a5e6-8f7114930866",
"expected": false
}
],
".turbot": {
"uri": "tmod:@turbot/azure-activedirectory#/definitions/objectId",
"modUri": "tmod:@turbot/azure-activedirectory"
}
}

servicePrincipal

Schema
{
"type": "object",
"properties": {
"objectId": {
"$ref": "#/definitions/objectId"
},
"id": {
"$ref": "#/definitions/objectId"
},
"displayName": {
"type": "string"
},
"turbot": {
"type": "object",
"properties": {
"akas": {
"type": "array",
"items": {
"$ref": "#/definitions/servicePrincipalAka"
}
},
"custom": {
"type": "object",
"properties": {
"createTimestamp": {
"$ref": "turbot#/definitions/isoTimestamp"
},
"azure": {
"$ref": "azure#/definitions/azureMetadata"
}
}
}
}
}
},
"additionalProperties": true,
"tests": [
{
"description": "all properties provided",
"input": {
"objectId": "72aba83d-b4ed-4d97-910b-e9a2a4162b69",
"turbot": {
"akas": [
"azure:///serviceprincipal/72aba83d-b4ed-4d97-910b-e9a2a4162b69"
],
"custom": {
"azure": {
"tenantId": "1c2d0b7e-7d6a-4f05-84c0-b808a0ab455b"
}
}
}
}
}
],
".turbot": {
"uri": "tmod:@turbot/azure-activedirectory#/definitions/servicePrincipal",
"modUri": "tmod:@turbot/azure-activedirectory"
}
}

servicePrincipalAka

Schema
{
"type": "string",
"pattern": "^azure:///serviceprincipal/[a-f0-9-]{36}$",
"tests": [
{
"description": "base",
"input": "azure:///serviceprincipal/72aba83d-b4ed-4d97-910b-e9a2a4162b69"
},
{
"description": "invalid aka",
"input": "gcp://serviceusage.googleapis.com/projects/cse-legolas-2/services/compute.googleapis.com",
"expected": false
}
],
".turbot": {
"uri": "tmod:@turbot/azure-activedirectory#/definitions/servicePrincipalAka",
"modUri": "tmod:@turbot/azure-activedirectory"
}
}

user

Schema
{
"type": "object",
"properties": {
"objectId": {
"$ref": "#/definitions/objectId"
},
"id": {
"$ref": "#/definitions/objectId"
},
"displayName": {
"type": "string"
},
"userPrincipalName": {
"$ref": "#/definitions/userPrincipalName"
},
"surname": {
"type": "string"
},
"givenName": {
"type": "string"
},
"preferredLanguage": {
"type": "string"
},
"officeLocation": {
"type": "string"
},
"mobilePhone": {
"type": "string"
},
"mail": {
"type": "string"
},
"jobTitle": {
"type": "string"
},
"businessPhones": {
"type": "array"
},
"userType": {
"type": "string"
},
"memberOf": {
"type": "array",
"items": {
"$ref": "#/definitions/group"
}
},
"turbot": {
"type": "object",
"properties": {
"akas": {
"type": "array",
"items": {
"$ref": "#/definitions/userAka"
}
},
"custom": {
"type": "object",
"properties": {
"createTimestamp": {
"$ref": "turbot#/definitions/isoTimestamp"
},
"azure": {
"$ref": "azure#/definitions/azureMetadata"
}
}
}
}
}
},
"additionalProperties": true,
"tests": [
{
"description": "all properties provided",
"input": {
"businessPhones": [
"+1 425 555 0109"
],
"displayName": "Adele Vance",
"givenName": "Adele",
"jobTitle": "Product Marketing Manager",
"mail": "AdeleV@M365x214355.onmicrosoft.com",
"mobilePhone": "+1 425 555 0109",
"officeLocation": "18/2111",
"preferredLanguage": "en-US",
"surname": "Vance",
"userPrincipalName": "AdeleV@M365x214355.onmicrosoft.com",
"id": "87d349ed-44d7-43e1-9a83-5f2406dee5bd",
"userType": "Member",
"turbot": {
"akas": [
"azure:///user/87d349ed-44d7-43e1-9a83-5f2406dee5bd"
],
"custom": {
"azure": {
"tenantID": "9e3548cf-17e2-4751-b87e-b72bdd2c77f7"
}
}
}
}
},
{
"description": "invalid - missing required property userPrincipalName",
"input": {
"surname": "516239f1-63e1-4d78-a4de-a74fb236a071",
"turbot": {
"akas": [
"azure:///directory/9e3548cf-17e2-4751-b87e-b72bdd2c77f7/user/87d349ed-44d7-43e1-9a83-5f2406dee5bd"
],
"custom": {
"azure": {
"tenantID": "9e3548cf-17e2-4751-b87e-b72bdd2c77f7"
}
}
}
},
"expected": false
}
],
".turbot": {
"uri": "tmod:@turbot/azure-activedirectory#/definitions/user",
"modUri": "tmod:@turbot/azure-activedirectory"
}
}

userAka

Schema
{
"type": "string",
"pattern": "^azure:///user/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$",
"tests": [
{
"description": "base",
"input": "azure:///user/87d349ed-44d7-43e1-9a83-5f2406dee5bd"
},
{
"description": "invalid aka",
"input": "gcp://serviceusage.googleapis.com/projects/cse-legolas-2/services/compute.googleapis.com",
"expected": false
}
],
".turbot": {
"uri": "tmod:@turbot/azure-activedirectory#/definitions/userAka",
"modUri": "tmod:@turbot/azure-activedirectory"
}
}

userPrincipalName

Schema
{
"type": "string",
"pattern": "^[^\\\\]*$",
"tests": [
{
"description": "base",
"input": "Some ®@nNdom name @#$#@%$% with anything"
},
{
"description": "Invalid role name if \"\\\" in it",
"input": "Some ®@nN\\dom name @#$#@%$% with anything",
"expected": false
}
],
".turbot": {
"uri": "tmod:@turbot/azure-activedirectory#/definitions/userPrincipalName",
"modUri": "tmod:@turbot/azure-activedirectory"
}
}