Skip to content

Adding Tenant routes #7

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
elliot-huffman merged 7 commits into from
Mar 25, 2025
Merged

Adding Tenant routes #7

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
cc1bcc2
Adding new endpoints to handle Customer operations
pasha-zayko Mar 13, 2025
6926842
Adding another response
pasha-zayko Mar 13, 2025
0488b18
Updating endpoints per business requirements
pasha-zayko Mar 14, 2025
db430d3
Small comment updates
pasha-zayko Mar 17, 2025
2692854
Merge branch 'main' into pasha-customer-api-dg
pasha-zayko Mar 17, 2025
4e094af
Update to endpoints
pasha-zayko Mar 21, 2025
18bb932
Wording
elliot-huffman Mar 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
292 changes: 292 additions & 0 deletions Data-Gateway.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,20 @@
"example": "1.12.5",
"type": "string"
}
},
"parentId": {
"description": "The object ID of the parent value to operate against.",
"in": "query",
"name": "parentId",
"required": false,
"schema": {
"example": "3b241101-e2bb-4255-8caf-4136c566a962",
"format": "uuid",
"maxLength": 36,
"minLength": 36,
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$",
"type": "string"
}
}
},
"responses": {
Expand Down Expand Up @@ -804,6 +818,57 @@
],
"title": "Update SHIELD Tenant - configuration entry",
"type": "object"
},
"TenantDetails.Record": {
"title": "Tenant Details Record",
"description": "Information about a single tenant record",
"properties": {
"tenantId": {
"description": "The object ID of the tenant record",
"example": "1c4d2f3b-2e4b-4a5b-8c6d-7e8f9a0b1c2d",
"format": "uuid",
"maxLength": 36,
"minLength": 36,
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$",
"type": "string"
},
"displayName": {
"description": "Human readable name for the tenant record",
"example": "Contoso - Prod",
"type": "string"
},
"parentId": {
"description": "The object ID of the tenant that is considered a parent to this record",
"example": "22354a3f-2e21-4bd2-8327-dc842cfa80c8",
"format": "uuid",
"maxLength": 36,
"minLength": 36,
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$",
"type": "string"
},
"authorizedPrincipalList": {
"description": "List of object IDs that are allowed to access this record and related data.",
"type": "array",
"items": {
"format": "uuid",
"maxLength": 36,
"minLength": 36,
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$",
"type": "string"
},
"example": [
"fd9a6a53-594d-41aa-950a-b21ff41d4688",
"54fc12cd-403d-4c48-be12-86b807e958d3"
]
}
},
"type": "object",
"required": [
"tenantId",
"displayName",
"parentId",
"authorizedPrincipalList"
]
}
},
"securitySchemes": {
Expand Down Expand Up @@ -2648,6 +2713,229 @@
"SHIELD - Update"
]
}
},
"/API/Tenant/" : {
"get": {
"description": "Retrieves the list of tenant records. Can use filter by parent ID limit the results. This endpoint requires the `Tenant.Read.All` or `Tenant.ReadWrite.All` scopes (permissions).",
"operationId": "/API/Tenant/Get",
"parameters": [
{
"$ref": "#/components/parameters/parentId"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"minItems": 0,
"items": {
"$ref": "#/components/schemas/TenantDetails.Record"
}
},
"examples": {
"Example List Of Tenant Records": {
"description": "Sample list of tenant records in the database",
"summary": "Existing Tenant Records",
"value": [
{
"tenantId": "5d6e7f8a-9b0c-1d2e-3f4a-5b6c7d8e9f0a",
"displayName": "Contoso - Legal",
"parentId": "f3ed1efc-4e62-46b8-bf2a-6b59ca9784e5",
"authorizedPrincipalList": [
"59673771-3b4f-4518-9187-aee8a51c8c07",
"47c42971-2dea-4553-a788-d29a42e3e867"
]
},
{
"tenantId": "7e8f9a0b-1c2d-3e4b-5a6c-7d8e9f0a1b2c",
"displayName": "Contoso - R&D",
"parentId": "f3ed1efc-4e62-46b8-bf2a-6b59ca9784e5",
"authorizedPrincipalList": []
}
]
}
}
}
},
"description": "OK"
},
"404":{
"$ref": "#/components/responses/404"
},
"500": {
"description": "Request has a failure that cannot be resolved and might require manual intervention or retry."
}
},
"summary": "Retrieves List of Tenant Records",
"tags": [
"Tenant Records"
]
}
},
"/API/Tenant/{tenantId}/": {
"get": {
"description": "Retrieves details of a specific tenant record. This endpoint requires the `Tenant.Read.All` or `Tenant.ReadWrite.All` scopes (permissions).",
"operationId": "/API/Tenant/:tenantId/Get",
"parameters": [
{
"$ref": "#/components/parameters/tenantId"
},
{
"$ref": "#/components/parameters/parentId"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TenantDetails.Record"
},
"examples": {
"Example Complete Tenant Record": {
"description": "Sample details of one tenant record",
"summary": "Existing Tenant Record",
"value": {
"tenantId": "9f0a1b2c-3d4e-5f6a-7b8c-9d0e1f2a3b4c",
"displayName": "Contoso - Testing",
"parentId": "f3ed1efc-4e62-46b8-bf2a-6b59ca9784e5",
"authorizedPrincipalList": [
"9f0a1b2c-3d4e-5f6a-7b8c-9d0e1f2a3b4c",
"2e3f4a5b-6c7d-8e9f-0a1b-2c3d4e5f6a7b",
"4b5c6d7e-8f9a-0b1c-2d3e-4f5a6b7c8d9e"
]
}
}
}
}
},
"description": "OK"
},
"404":{
"$ref": "#/components/responses/404"
},
"500": {
"description": "Request has a failure that cannot be resolved and might require manual intervention or retry."
}
},
"summary": "Retrieves Tenant Record",
"tags": [
"Tenant Records"
]
},
"patch": {
"description": "Update tenant record using provided information. Payload could contain any combination of existing properties. To remove a parent, set the parentId to be the same as the tenant ID value. This endpoint requires the `Tenant.ReadWrite.All` scopes (permissions).",
"operationId": "/API/Tenant/:tenantId/Patch",
"parameters": [
{
"$ref": "#/components/parameters/tenantId"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"displayName": {
"description": "Human readable name for the tenant record",
"type": "string"
},
"parentId": {
"description": "The object ID of the tenant that is considered a parent to this record",
"format": "uuid",
"maxLength": 36,
"minLength": 36,
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$",
"type": "string"
},
"authorizedPrincipalList": {
"description": "List of object IDs that are allowed to access this record and related data.",
"type": "array",
"items": {
"format": "uuid",
"maxLength": 36,
"minLength": 36,
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$",
"type": "string"
}
}
},
"anyOf": [
{
"required": [ "displayName" ]
},
{
"required": [ "parentId" ]
},
{
"required": [ "authorizedPrincipalList" ]
}
]
},
"examples": {
"Example Request to Update Tenant Parent": {
"description": "Sample payload requesting adjustment to the parent value",
"summary": "Update Parent Information for Tenant",
"value": {
"parentId": "6a7b8c9d-0e1f-2a3b-4c5d-6e7f8a9b0c1d"
}
},
"Example Request for Tenant Name and Parent Update": {
"description": "Sample payload requesting to update parent value and display name on the tenant record",
"summary": "Update Tenant Record Name and Parent Information",
"value": {
"parentId": "8f9a0b1c-2d3e-4f5a-6b7c-8d9e0a1b2c3d",
"displayName": "Contoso - R&D East"
}
},
"Example Request for Tenant Authorized Principals Update": {
"description": "Sample payload requesting to update authorized principals for the tenant record",
"summary": "Update Tenant Authorized Principals List",
"value": {
"authorizedPrincipalList": [ "4cae3355-0cff-410c-b4f9-69cb5de8f1ac", "0e52e6ac-f8e1-4070-ae2e-9bd0a37507a1" ]
}
}
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TenantDetails.Record"
},
"examples": {
"Example Complete Tenant Record": {
"description": "Sample response after updating a tenant record",
"summary": "Updated Tenant Record",
"value": {
"tenantId": "c00ffc2c-b6f6-4121-bd8e-4d02e9504eb9",
"displayName": "Contoso - Testing",
"parentId": "8c291062-a4f7-4706-b4df-59e605497f06",
"authorizedPrincipalList": [
"b856517a-2086-4be4-b63e-d6ca8a5b0ff6"
]
}
}
}
}
},
"description": "OK"
},
"500": {
"description": "Request has a failure that cannot be resolved and might require manual intervention or retry."
}
},
"summary": "Update Tenant Record",
"tags": [
"Tenant Records"
]
}
}
},
"security": [
Expand All @@ -2670,6 +2958,10 @@
"url": "https://docs.shilab.com/Date-Gateway/"
}
},
{
"description": "Manages the list of tenants that have interacted with the Data Gateway in the past.",
"name": "Tenant Records"
},
{
"description": "Collects and reports data from the license analytics product.",
"name": "License Analytics",
Expand Down