Skip to content

Commit 2df1d3f

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
andauthored
Add OpenAPI spec for current user endpoints (#4055)
Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>
1 parent 70b5e1a commit 2df1d3f

9 files changed

Lines changed: 521 additions & 40 deletions

File tree

.generator/schemas/v2/openapi.yaml

Lines changed: 167 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -81788,55 +81788,57 @@ components:
8178881788
description: Attributes of user object returned by the API.
8178981789
properties:
8179081790
created_at:
81791-
description: Creation time of the user.
81791+
description: The ISO 8601 timestamp of when the user account was created.
8179281792
format: date-time
8179381793
type: string
8179481794
disabled:
81795-
description: Whether the user is disabled.
81795+
description: Whether the user account is deactivated. Disabled users cannot log in.
8179681796
type: boolean
8179781797
email:
81798-
description: Email of the user.
81798+
description: The email address of the user, used for login and notifications.
8179981799
type: string
8180081800
handle:
81801-
description: Handle of the user.
81801+
description: The unique handle (username) of the user, typically matching their email prefix.
8180281802
type: string
8180381803
icon:
81804-
description: URL of the user's icon.
81804+
description: URL of the user's profile icon, typically a Gravatar URL derived from the email address.
8180581805
type: string
8180681806
last_login_time:
81807-
description: The last time the user logged in.
81807+
description: The ISO 8601 timestamp of the user's most recent login, or null if the user has never logged in.
8180881808
format: date-time
8180981809
nullable: true
8181081810
readOnly: true
8181181811
type: string
8181281812
mfa_enabled:
81813-
description: If user has MFA enabled.
81813+
description: Whether multi-factor authentication (MFA) is enabled for the user's account.
8181481814
readOnly: true
8181581815
type: boolean
8181681816
modified_at:
81817-
description: Time that the user was last modified.
81817+
description: The ISO 8601 timestamp of when the user account was last modified.
8181881818
format: date-time
8181981819
type: string
8182081820
name:
81821-
description: Name of the user.
81821+
description: The full display name of the user as shown in the Datadog UI.
8182281822
nullable: true
8182381823
type: string
8182481824
service_account:
81825-
description: Whether the user is a service account.
81825+
description: |-
81826+
Whether this is a service account rather than a human user.
81827+
Service accounts are used for programmatic API access.
8182681828
type: boolean
8182781829
status:
81828-
description: Status of the user.
81830+
description: The current status of the user account (for example, `Active`, `Pending`, or `Disabled`).
8182981831
type: string
8183081832
title:
81831-
description: Title of the user.
81833+
description: The job title of the user (for example, "Senior Engineer" or "Product Manager").
8183281834
nullable: true
8183381835
type: string
8183481836
uuid:
81835-
description: UUID of the user.
81837+
description: The globally unique identifier (UUID) of the user.
8183681838
readOnly: true
8183781839
type: string
8183881840
verified:
81839-
description: Whether the user is verified.
81841+
description: Whether the user's email address has been verified.
8184081842
type: boolean
8184181843
type: object
8184281844
UserAttributesStatus:
@@ -82238,13 +82240,23 @@ components:
8223882240
description: Attributes of the edited user.
8223982241
properties:
8224082242
disabled:
82241-
description: If the user is enabled or disabled.
82243+
description: |-
82244+
When set to `true`, the user is deactivated and can no longer log in.
82245+
When `false`, the user is active.
8224282246
type: boolean
8224382247
email:
82244-
description: The email of the user.
82248+
description: |-
82249+
The email address of the user, used for login and notifications.
82250+
Must be a valid email format.
8224582251
type: string
8224682252
name:
82247-
description: The name of the user.
82253+
description: |-
82254+
The full display name of the user as shown in the Datadog UI.
82255+
Maximum 55 characters, cannot contain `<` or `>`.
82256+
type: string
82257+
title:
82258+
description: The job title of the user (for example, "Senior Engineer" or "Product Manager").
82259+
nullable: true
8224882260
type: string
8224982261
type: object
8225082262
UserUpdateData:
@@ -97139,6 +97151,144 @@ paths:
9713997151
$ref: "#/components/responses/TooManyRequestsResponse"
9714097152
summary: Get all CSM Serverless Agents
9714197153
tags: ["CSM Agents"]
97154+
/api/v2/current_user:
97155+
get:
97156+
description: |-
97157+
Get the user associated with the current authentication context.
97158+
The response includes the user's profile attributes (name, email, handle,
97159+
status, MFA state), along with related resources: the user's organization,
97160+
assigned roles with their granted permissions, and team-scoped roles.
97161+
No additional permissions are required beyond valid authentication.
97162+
operationId: GetCurrentUser
97163+
responses:
97164+
"200":
97165+
content:
97166+
application/json:
97167+
examples:
97168+
default:
97169+
value:
97170+
data:
97171+
attributes:
97172+
created_at: "2024-01-15T10:30:00+00:00"
97173+
disabled: false
97174+
email: jane.doe@example.com
97175+
handle: jane.doe
97176+
icon: "https://secure.gravatar.com/avatar/abc123"
97177+
mfa_enabled: true
97178+
modified_at: "2024-06-01T12:00:00+00:00"
97179+
name: Jane Doe
97180+
service_account: false
97181+
status: Active
97182+
title: Senior Engineer
97183+
verified: true
97184+
id: 00000000-0000-9999-0000-000000000000
97185+
type: users
97186+
included: []
97187+
schema:
97188+
$ref: "#/components/schemas/UserResponse"
97189+
description: OK
97190+
"403":
97191+
content:
97192+
application/json:
97193+
schema:
97194+
$ref: "#/components/schemas/APIErrorResponse"
97195+
description: Authentication error
97196+
"429":
97197+
$ref: "#/components/responses/TooManyRequestsResponse"
97198+
security:
97199+
- apiKeyAuth: []
97200+
appKeyAuth: []
97201+
summary: Get current user
97202+
tags:
97203+
- Users
97204+
patch:
97205+
description: |-
97206+
Edit the profile of the currently authenticated user. Updatable fields
97207+
include `name`, `title`, `email`, and `disabled` status. The `id` field
97208+
in the request body must match the authenticated user's UUID; a mismatch
97209+
returns a 422 error. Email address changes are recorded in the audit trail.
97210+
Requires the `user_self_profile_write` permission.
97211+
operationId: UpdateCurrentUser
97212+
requestBody:
97213+
content:
97214+
application/json:
97215+
examples:
97216+
default:
97217+
value:
97218+
data:
97219+
attributes:
97220+
email: jane.doe@example.com
97221+
name: Jane Doe
97222+
title: Staff Engineer
97223+
id: 00000000-0000-9999-0000-000000000000
97224+
type: users
97225+
schema:
97226+
$ref: "#/components/schemas/UserUpdateRequest"
97227+
required: true
97228+
responses:
97229+
"200":
97230+
content:
97231+
application/json:
97232+
examples:
97233+
default:
97234+
value:
97235+
data:
97236+
attributes:
97237+
created_at: "2024-01-15T10:30:00+00:00"
97238+
disabled: false
97239+
email: jane.doe@example.com
97240+
handle: jane.doe
97241+
icon: "https://secure.gravatar.com/avatar/abc123"
97242+
mfa_enabled: true
97243+
modified_at: "2024-06-01T12:00:00+00:00"
97244+
name: Jane Doe
97245+
service_account: false
97246+
status: Active
97247+
title: Staff Engineer
97248+
verified: true
97249+
id: 00000000-0000-9999-0000-000000000000
97250+
type: users
97251+
included: []
97252+
schema:
97253+
$ref: "#/components/schemas/UserResponse"
97254+
description: OK
97255+
"400":
97256+
content:
97257+
application/json:
97258+
schema:
97259+
$ref: "#/components/schemas/APIErrorResponse"
97260+
description: Bad Request
97261+
"403":
97262+
content:
97263+
application/json:
97264+
schema:
97265+
$ref: "#/components/schemas/APIErrorResponse"
97266+
description: Authentication error
97267+
"404":
97268+
content:
97269+
application/json:
97270+
schema:
97271+
$ref: "#/components/schemas/APIErrorResponse"
97272+
description: Not found
97273+
"422":
97274+
content:
97275+
application/json:
97276+
schema:
97277+
$ref: "#/components/schemas/APIErrorResponse"
97278+
description: Unprocessable Entity
97279+
"429":
97280+
$ref: "#/components/responses/TooManyRequestsResponse"
97281+
security:
97282+
- apiKeyAuth: []
97283+
appKeyAuth: []
97284+
summary: Update current user
97285+
tags:
97286+
- Users
97287+
x-codegen-request-body-name: body
97288+
"x-permission":
97289+
operator: OR
97290+
permissions:
97291+
- user_self_profile_write
9714297292
/api/v2/current_user/application_keys:
9714397293
get:
9714497294
description: List all application keys available for current user

0 commit comments

Comments
 (0)