Skip to content

Commit ba375cd

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
andauthored
Add seats API v2 endpoints with error responses and required fields (#3172)
Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>
1 parent 52579f2 commit ba375cd

File tree

42 files changed

+1817
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

42 files changed

+1817
-0
lines changed

.generator/schemas/v2/openapi.yaml

Lines changed: 296 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5385,6 +5385,72 @@ components:
53855385
example: _latest
53865386
type: string
53875387
type: object
5388+
AssignSeatsUserRequest:
5389+
properties:
5390+
data:
5391+
$ref: '#/components/schemas/AssignSeatsUserRequestData'
5392+
description: The data for the assign seats user request.
5393+
type: object
5394+
AssignSeatsUserRequestData:
5395+
properties:
5396+
attributes:
5397+
$ref: '#/components/schemas/AssignSeatsUserRequestDataAttributes'
5398+
description: The attributes of the assign seats user request.
5399+
id:
5400+
description: The ID of the assign seats user request.
5401+
type: string
5402+
type:
5403+
$ref: '#/components/schemas/SeatAssignmentsDataType'
5404+
description: The type of the assign seats user request.
5405+
required:
5406+
- type
5407+
- attributes
5408+
type: object
5409+
AssignSeatsUserRequestDataAttributes:
5410+
properties:
5411+
product_code:
5412+
description: The product code for which to assign seats.
5413+
example: ''
5414+
type: string
5415+
user_uuids:
5416+
description: The list of user IDs to assign seats to.
5417+
example:
5418+
- ''
5419+
items:
5420+
type: string
5421+
type: array
5422+
required:
5423+
- product_code
5424+
- user_uuids
5425+
type: object
5426+
AssignSeatsUserResponse:
5427+
properties:
5428+
data:
5429+
$ref: '#/components/schemas/AssignSeatsUserResponseData'
5430+
description: The data for the assign seats user response.
5431+
type: object
5432+
AssignSeatsUserResponseData:
5433+
properties:
5434+
attributes:
5435+
$ref: '#/components/schemas/AssignSeatsUserResponseDataAttributes'
5436+
description: The attributes of the assign seats user response.
5437+
id:
5438+
description: The ID of the assign seats user response.
5439+
type: string
5440+
type:
5441+
$ref: '#/components/schemas/SeatAssignmentsDataType'
5442+
type: object
5443+
AssignSeatsUserResponseDataAttributes:
5444+
properties:
5445+
assigned_ids:
5446+
description: The list of user IDs to which the seats were assigned.
5447+
items:
5448+
type: string
5449+
type: array
5450+
product_code:
5451+
description: The product code for which the seats were assigned.
5452+
type: string
5453+
type: object
53885454
AttachCaseRequest:
53895455
description: Request for attaching security findings to a case.
53905456
properties:
@@ -52643,6 +52709,80 @@ components:
5264352709
- ISSUE_ASSIGNEE
5264452710
- ISSUE_CASE
5264552711
- ISSUE_TEAM_OWNERS
52712+
SeatAssignmentsDataType:
52713+
default: seat-assignments
52714+
description: Seat assignments resource type.
52715+
enum:
52716+
- seat-assignments
52717+
example: seat-assignments
52718+
type: string
52719+
x-enum-varnames:
52720+
- SEAT_ASSIGNMENTS
52721+
SeatUserData:
52722+
properties:
52723+
attributes:
52724+
$ref: '#/components/schemas/SeatUserDataAttributes'
52725+
description: The attributes of the seat user.
52726+
id:
52727+
description: The ID of the seat user.
52728+
example: 00000000-0000-0000-0000-000000000000
52729+
nullable: true
52730+
type: string
52731+
type:
52732+
$ref: '#/components/schemas/SeatUserDataType'
52733+
type: object
52734+
SeatUserDataArray:
52735+
properties:
52736+
data:
52737+
description: The list of seat users.
52738+
items:
52739+
$ref: '#/components/schemas/SeatUserData'
52740+
type: array
52741+
meta:
52742+
$ref: '#/components/schemas/SeatUserMeta'
52743+
description: The metadata of the seat users.
52744+
type: object
52745+
SeatUserDataAttributes:
52746+
properties:
52747+
assigned_at:
52748+
description: The date and time the seat was assigned.
52749+
example: '2021-01-01T00:00:00Z'
52750+
format: date-time
52751+
nullable: true
52752+
type: string
52753+
email:
52754+
description: The email of the user.
52755+
example: user@example.com
52756+
nullable: true
52757+
type: string
52758+
name:
52759+
description: The name of the user.
52760+
example: John Doe
52761+
nullable: true
52762+
type: string
52763+
type: object
52764+
SeatUserDataType:
52765+
default: seat-users
52766+
description: Seat users resource type.
52767+
enum:
52768+
- seat-users
52769+
example: seat-users
52770+
type: string
52771+
x-enum-varnames:
52772+
- SEAT_USERS
52773+
SeatUserMeta:
52774+
properties:
52775+
cursor:
52776+
description: The cursor for the seat users.
52777+
type: string
52778+
limit:
52779+
description: The limit for the seat users.
52780+
format: int64
52781+
type: integer
52782+
next_cursor:
52783+
description: The next cursor for the seat users.
52784+
type: string
52785+
type: object
5264652786
SecretRuleArray:
5264752787
properties:
5264852788
data:
@@ -64824,6 +64964,44 @@ components:
6482464964
type: string
6482564965
x-enum-varnames:
6482664966
- AZURE_UC_CONFIGS
64967+
UnassignSeatsUserRequest:
64968+
properties:
64969+
data:
64970+
$ref: '#/components/schemas/UnassignSeatsUserRequestData'
64971+
description: The data for the unassign seats user request.
64972+
type: object
64973+
UnassignSeatsUserRequestData:
64974+
properties:
64975+
attributes:
64976+
$ref: '#/components/schemas/UnassignSeatsUserRequestDataAttributes'
64977+
description: The attributes of the unassign seats user request.
64978+
id:
64979+
description: The ID of the unassign seats user request.
64980+
type: string
64981+
type:
64982+
$ref: '#/components/schemas/SeatAssignmentsDataType'
64983+
description: The type of the unassign seats user request.
64984+
required:
64985+
- type
64986+
- attributes
64987+
type: object
64988+
UnassignSeatsUserRequestDataAttributes:
64989+
properties:
64990+
product_code:
64991+
description: The product code for which to unassign seats.
64992+
example: ''
64993+
type: string
64994+
user_uuids:
64995+
description: The list of user IDs to unassign seats from.
64996+
example:
64997+
- ''
64998+
items:
64999+
type: string
65000+
type: array
65001+
required:
65002+
- product_code
65003+
- user_uuids
65004+
type: object
6482765005
Unit:
6482865006
description: Object containing the metric unit family, scale factor, name, and
6482965007
short name.
@@ -93305,6 +93483,121 @@ paths:
9330593483
x-unstable: '**Note**: This endpoint is in public beta.
9330693484

9330793485
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
93486+
/api/v2/seats/users:
93487+
delete:
93488+
description: Unassign seats from users for a product code.
93489+
operationId: UnassignSeatsUser
93490+
requestBody:
93491+
content:
93492+
application/json:
93493+
schema:
93494+
$ref: '#/components/schemas/UnassignSeatsUserRequest'
93495+
required: true
93496+
responses:
93497+
'204':
93498+
description: No Content
93499+
'400':
93500+
$ref: '#/components/responses/BadRequestResponse'
93501+
'422':
93502+
content:
93503+
application/json:
93504+
schema:
93505+
$ref: '#/components/schemas/APIErrorResponse'
93506+
description: Unprocessable Entity
93507+
'429':
93508+
$ref: '#/components/responses/TooManyRequestsResponse'
93509+
summary: Unassign seats from users
93510+
tags:
93511+
- Seats
93512+
x-permission:
93513+
operator: OR
93514+
permissions:
93515+
- billing_edit
93516+
- incident_write
93517+
- on_call_write
93518+
get:
93519+
description: Get the list of users assigned seats for a product code.
93520+
operationId: GetSeatsUsers
93521+
parameters:
93522+
- description: The product code for which to retrieve seat users.
93523+
in: query
93524+
name: product_code
93525+
required: true
93526+
schema:
93527+
type: string
93528+
- description: Maximum number of results to return.
93529+
in: query
93530+
name: page[limit]
93531+
required: false
93532+
schema:
93533+
type: integer
93534+
- description: Cursor for pagination.
93535+
in: query
93536+
name: page[cursor]
93537+
required: false
93538+
schema:
93539+
type: string
93540+
responses:
93541+
'200':
93542+
content:
93543+
application/json:
93544+
schema:
93545+
$ref: '#/components/schemas/SeatUserDataArray'
93546+
description: OK
93547+
'400':
93548+
$ref: '#/components/responses/BadRequestResponse'
93549+
'422':
93550+
content:
93551+
application/json:
93552+
schema:
93553+
$ref: '#/components/schemas/APIErrorResponse'
93554+
description: Unprocessable Entity
93555+
'429':
93556+
$ref: '#/components/responses/TooManyRequestsResponse'
93557+
summary: Get users with seats
93558+
tags:
93559+
- Seats
93560+
x-permission:
93561+
operator: OR
93562+
permissions:
93563+
- billing_read
93564+
- incident_read
93565+
- on_call_read
93566+
post:
93567+
description: Assign seats to users for a product code.
93568+
operationId: AssignSeatsUser
93569+
requestBody:
93570+
content:
93571+
application/json:
93572+
schema:
93573+
$ref: '#/components/schemas/AssignSeatsUserRequest'
93574+
required: true
93575+
responses:
93576+
'201':
93577+
content:
93578+
application/json:
93579+
schema:
93580+
$ref: '#/components/schemas/AssignSeatsUserResponse'
93581+
description: Created
93582+
'400':
93583+
$ref: '#/components/responses/BadRequestResponse'
93584+
'422':
93585+
content:
93586+
application/json:
93587+
schema:
93588+
$ref: '#/components/schemas/APIErrorResponse'
93589+
description: Unprocessable Entity
93590+
'429':
93591+
$ref: '#/components/responses/TooManyRequestsResponse'
93592+
summary: Assign seats to users
93593+
tags:
93594+
- Seats
93595+
x-permission:
93596+
operator: OR
93597+
permissions:
93598+
- billing_edit
93599+
- incident_write
93600+
- on_call_write
9330893601
/api/v2/security-entities/risk-scores:
9330993602
get:
9331093603
description: Get a list of entity risk scores for your organization. Entity
@@ -104454,6 +104747,9 @@ tags:
104454104747
- description: Manage retention filters through [Manage Applications](https://app.datadoghq.com/rum/list)
104455104748
of RUM for your organization.
104456104749
name: Rum Retention Filters
104750+
- description: The seats API allows you to view, assign, and unassign seats for your
104751+
organization.
104752+
name: Seats
104457104753
- description: Create and manage your security rules, signals, filters, and more.
104458104754
See the [Datadog Security page](https://docs.datadoghq.com/security/) for more
104459104755
information.

docs/datadog_api_client.v2.api.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -550,6 +550,13 @@ datadog\_api\_client.v2.api.rum\_retention\_filters\_api module
550550
:members:
551551
:show-inheritance:
552552

553+
datadog\_api\_client.v2.api.seats\_api module
554+
---------------------------------------------
555+
556+
.. automodule:: datadog_api_client.v2.api.seats_api
557+
:members:
558+
:show-inheritance:
559+
553560
datadog\_api\_client.v2.api.security\_monitoring\_api module
554561
------------------------------------------------------------
555562

0 commit comments

Comments
 (0)