Skip to content

Commit

Permalink
added all domains specs (#708)
Browse files Browse the repository at this point in the history
  • Loading branch information
ALCooper12 authored Jul 19, 2024
1 parent adf633d commit 647da0f
Show file tree
Hide file tree
Showing 16 changed files with 740 additions and 15 deletions.
30 changes: 15 additions & 15 deletions packages/go/openapi/src/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -381,35 +381,35 @@ paths:

# domains
/api/v2/domains/{object_id}:
$ref: './paths/domains/domains.id.yaml'
$ref: './paths/domains.domains.id.yaml'
/api/v2/domains/{object_id}/computers:
$ref: './paths/domains/domains.id.computers.yaml'
$ref: './paths/domains.domains.id.computers.yaml'
/api/v2/domains/{object_id}/controllers:
$ref: './paths/domains/domains.id.controllers.yaml'
$ref: './paths/domains.domains.id.controllers.yaml'
/api/v2/domains/{object_id}/dc-syncers:
$ref: './paths/domains/domains.id.dc-syncers.yaml'
$ref: './paths/domains.domains.id.dc-syncers.yaml'
/api/v2/domains/{object_id}/foreign-admins:
$ref: './paths/domains/domains.id.foreign-admins.yaml'
$ref: './paths/domains.domains.id.foreign-admins.yaml'
/api/v2/domains/{object_id}/foreign-gpo-controllers:
$ref: './paths/domains/domains.id.foreign-gpo-controllers.yaml'
$ref: './paths/domains.domains.id.foreign-gpo-controllers.yaml'
/api/v2/domains/{object_id}/foreign-groups:
$ref: './paths/domains/domains.id.foreign-groups.yaml'
$ref: './paths/domains.domains.id.foreign-groups.yaml'
/api/v2/domains/{object_id}/foreign-users:
$ref: './paths/domains/domains.id.foreign-users.yaml'
$ref: './paths/domains.domains.id.foreign-users.yaml'
/api/v2/domains/{object_id}/gpos:
$ref: './paths/domains/domains.id.gpos.yaml'
$ref: './paths/domains.domains.id.gpos.yaml'
/api/v2/domains/{object_id}/groups:
$ref: './paths/domains/domains.id.groups.yaml'
$ref: './paths/domains.domains.id.groups.yaml'
/api/v2/domains/{object_id}/inbound-trusts:
$ref: './paths/domains/domains.id.inbound-trusts.yaml'
$ref: './paths/domains.domains.id.inbound-trusts.yaml'
/api/v2/domains/{object_id}/linked-gpos:
$ref: './paths/domains/domains.id.linked-gpos.yaml'
$ref: './paths/domains.domains.id.linked-gpos.yaml'
/api/v2/domains/{object_id}/ous:
$ref: './paths/domains/domains.id.ous.yaml'
$ref: './paths/domains.domains.id.ous.yaml'
/api/v2/domains/{object_id}/outbound-trusts:
$ref: './paths/domains/domains.id.outbound-trusts.yaml'
$ref: './paths/domains.domains.id.outbound-trusts.yaml'
/api/v2/domains/{object_id}/users:
$ref: './paths/domains/domains.id.users.yaml'
$ref: './paths/domains.domains.id.users.yaml'

# gpos
/api/v2/gpos/{object_id}:
Expand Down
45 changes: 45 additions & 0 deletions packages/go/openapi/src/paths/domains.domains.id.computers.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
# Copyright 2024 Specter Ops, Inc.
#
# Licensed under the Apache License, Version 2.0
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# SPDX-License-Identifier: Apache-2.0

parameters:
- $ref: './../parameters/header.prefer.yaml'
- $ref: './../parameters/path.object-id.yaml'
get:
operationId: GetDomainEntityComputers
summary: Get domain entity computers
description: Get a list or count of the computers that belong to this domain.
tags:
- Domains
- Community
- Enterprise
parameters:
- $ref: './../parameters/query.entity.skip.yaml'
- $ref: './../parameters/query.entity.limit.yaml'
- $ref: './../parameters/query.entity.type.yaml'
- $ref: './../parameters/query.entity.sort-by.yaml'
responses:
200:
$ref: './../responses/related-entity-query-results.yaml'
400:
$ref: './../responses/bad-request.yaml'
401:
$ref: './../responses/unauthorized.yaml'
403:
$ref: './../responses/forbidden.yaml'
429:
$ref: './../responses/too-many-requests.yaml'
500:
$ref: './../responses/internal-server-error.yaml'
45 changes: 45 additions & 0 deletions packages/go/openapi/src/paths/domains.domains.id.controllers.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
# Copyright 2024 Specter Ops, Inc.
#
# Licensed under the Apache License, Version 2.0
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# SPDX-License-Identifier: Apache-2.0

parameters:
- $ref: './../parameters/header.prefer.yaml'
- $ref: './../parameters/path.object-id.yaml'
get:
operationId: GetDomainEntityControllers
summary: Get domain entity controllers
description: Get a list, graph, or count of the principals that can control this domain.
tags:
- Domains
- Community
- Enterprise
parameters:
- $ref: './../parameters/query.entity.skip.yaml'
- $ref: './../parameters/query.entity.limit.yaml'
- $ref: './../parameters/query.entity.type.yaml'
- $ref: './../parameters/query.entity.sort-by.yaml'
responses:
200:
$ref: './../responses/related-entity-query-results.yaml'
400:
$ref: './../responses/bad-request.yaml'
401:
$ref: './../responses/unauthorized.yaml'
403:
$ref: './../responses/forbidden.yaml'
429:
$ref: './../responses/too-many-requests.yaml'
500:
$ref: './../responses/internal-server-error.yaml'
45 changes: 45 additions & 0 deletions packages/go/openapi/src/paths/domains.domains.id.dc-syncers.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
# Copyright 2024 Specter Ops, Inc.
#
# Licensed under the Apache License, Version 2.0
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# SPDX-License-Identifier: Apache-2.0

parameters:
- $ref: './../parameters/header.prefer.yaml'
- $ref: './../parameters/path.object-id.yaml'
get:
operationId: GetDomainEntityDcSyncers
summary: Get domain entity DC Syncers
description: Get a list, graph, or count of the principals that can DC sync this domain.
tags:
- Domains
- Community
- Enterprise
parameters:
- $ref: './../parameters/query.entity.skip.yaml'
- $ref: './../parameters/query.entity.limit.yaml'
- $ref: './../parameters/query.entity.type.yaml'
- $ref: './../parameters/query.entity.sort-by.yaml'
responses:
200:
$ref: './../responses/related-entity-query-results.yaml'
400:
$ref: './../responses/bad-request.yaml'
401:
$ref: './../responses/unauthorized.yaml'
403:
$ref: './../responses/forbidden.yaml'
429:
$ref: './../responses/too-many-requests.yaml'
500:
$ref: './../responses/internal-server-error.yaml'
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
# Copyright 2024 Specter Ops, Inc.
#
# Licensed under the Apache License, Version 2.0
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# SPDX-License-Identifier: Apache-2.0

parameters:
- $ref: './../parameters/header.prefer.yaml'
- $ref: './../parameters/path.object-id.yaml'
get:
operationId: GetDomainEntityForeignAdmins
summary: Get domain entity foreign admins
description: |
Get a list, graph, or count of the principals outside of this domain that have admin
rights on principals in this domain.
tags:
- Domains
- Community
- Enterprise
parameters:
- $ref: './../parameters/query.entity.skip.yaml'
- $ref: './../parameters/query.entity.limit.yaml'
- $ref: './../parameters/query.entity.type.yaml'
- $ref: './../parameters/query.entity.sort-by.yaml'
responses:
200:
$ref: './../responses/related-entity-query-results.yaml'
400:
$ref: './../responses/bad-request.yaml'
401:
$ref: './../responses/unauthorized.yaml'
403:
$ref: './../responses/forbidden.yaml'
429:
$ref: './../responses/too-many-requests.yaml'
500:
$ref: './../responses/internal-server-error.yaml'
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
# Copyright 2024 Specter Ops, Inc.
#
# Licensed under the Apache License, Version 2.0
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# SPDX-License-Identifier: Apache-2.0

parameters:
- $ref: './../parameters/header.prefer.yaml'
- $ref: './../parameters/path.object-id.yaml'
get:
operationId: GetDomainEntityForeignGpoControllers
summary: Get domain entity foreign GPO controllers
description: |
Get a list, graph, or count of the principals outside of this domain that can control
GPOs inside this domain.
tags:
- Domains
- Community
- Enterprise
parameters:
- $ref: './../parameters/query.entity.skip.yaml'
- $ref: './../parameters/query.entity.limit.yaml'
- $ref: './../parameters/query.entity.type.yaml'
- $ref: './../parameters/query.entity.sort-by.yaml'
responses:
200:
$ref: './../responses/related-entity-query-results.yaml'
400:
$ref: './../responses/bad-request.yaml'
401:
$ref: './../responses/unauthorized.yaml'
403:
$ref: './../responses/forbidden.yaml'
429:
$ref: './../responses/too-many-requests.yaml'
500:
$ref: './../responses/internal-server-error.yaml'
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
# Copyright 2024 Specter Ops, Inc.
#
# Licensed under the Apache License, Version 2.0
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# SPDX-License-Identifier: Apache-2.0

parameters:
- $ref: './../parameters/header.prefer.yaml'
- $ref: './../parameters/path.object-id.yaml'
get:
operationId: GetDomainEntityForeignGroups
summary: Get domain entity foregin groups
description: |
Get a list, graph, or count of the groups outside of this domain that are members
of groups inside this domain.
tags:
- Domains
- Community
- Enterprise
parameters:
- $ref: './../parameters/query.entity.skip.yaml'
- $ref: './../parameters/query.entity.limit.yaml'
- $ref: './../parameters/query.entity.type.yaml'
- $ref: './../parameters/query.entity.sort-by.yaml'
responses:
200:
$ref: './../responses/related-entity-query-results.yaml'
400:
$ref: './../responses/bad-request.yaml'
401:
$ref: './../responses/unauthorized.yaml'
403:
$ref: './../responses/forbidden.yaml'
429:
$ref: './../responses/too-many-requests.yaml'
500:
$ref: './../responses/internal-server-error.yaml'
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
# Copyright 2024 Specter Ops, Inc.
#
# Licensed under the Apache License, Version 2.0
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# SPDX-License-Identifier: Apache-2.0

parameters:
- $ref: './../parameters/header.prefer.yaml'
- $ref: './../parameters/path.object-id.yaml'
get:
operationId: GetDomainEntityForeignUsers
summary: Get domain entity foreign users
description: |
Get a list, graph, or count of the users outside of this domain that are members
of groups inside this domain.
tags:
- Domains
- Community
- Enterprise
parameters:
- $ref: './../parameters/query.entity.skip.yaml'
- $ref: './../parameters/query.entity.limit.yaml'
- $ref: './../parameters/query.entity.type.yaml'
- $ref: './../parameters/query.entity.sort-by.yaml'
responses:
200:
$ref: './../responses/related-entity-query-results.yaml'
400:
$ref: './../responses/bad-request.yaml'
401:
$ref: './../responses/unauthorized.yaml'
403:
$ref: './../responses/forbidden.yaml'
429:
$ref: './../responses/too-many-requests.yaml'
500:
$ref: './../responses/internal-server-error.yaml'
Loading

0 comments on commit 647da0f

Please sign in to comment.