Skip to content

Add PAT/SAT management API endpoints #3382

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

Open
api-clients-generation-pipeline wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add PAT/SAT management API endpoints #3382

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
748 changes: 748 additions & 0 deletions .generator/schemas/v2/openapi.yaml
View file
Open in desktop

Large diffs are not rendered by default.

147 changes: 147 additions & 0 deletions docs/datadog_api_client.v2.model.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11638,6 +11638,20 @@ datadog\_api\_client.v2.model.full\_custom\_framework\_data\_attributes module
:members:
:show-inheritance:

datadog\_api\_client.v2.model.full\_personal\_access\_token module
------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.full_personal_access_token
:members:
:show-inheritance:

datadog\_api\_client.v2.model.full\_personal\_access\_token\_attributes module
------------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.full_personal_access_token_attributes
:members:
:show-inheritance:

datadog\_api\_client.v2.model.gcp\_credentials module
-----------------------------------------------------

Expand Down Expand Up @@ -15887,6 +15901,13 @@ datadog\_api\_client.v2.model.list\_on\_call\_notification\_rules\_response modu
:members:
:show-inheritance:

datadog\_api\_client.v2.model.list\_personal\_access\_tokens\_response module
-----------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.list_personal_access_tokens_response
:members:
:show-inheritance:

datadog\_api\_client.v2.model.list\_pipelines\_response module
--------------------------------------------------------------

Expand Down Expand Up @@ -21879,6 +21900,111 @@ datadog\_api\_client.v2.model.permissions\_type module
:members:
:show-inheritance:

datadog\_api\_client.v2.model.personal\_access\_token module
------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.personal_access_token
:members:
:show-inheritance:

datadog\_api\_client.v2.model.personal\_access\_token\_attributes module
------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.personal_access_token_attributes
:members:
:show-inheritance:

datadog\_api\_client.v2.model.personal\_access\_token\_create\_attributes module
--------------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.personal_access_token_create_attributes
:members:
:show-inheritance:

datadog\_api\_client.v2.model.personal\_access\_token\_create\_data module
--------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.personal_access_token_create_data
:members:
:show-inheritance:

datadog\_api\_client.v2.model.personal\_access\_token\_create\_request module
-----------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.personal_access_token_create_request
:members:
:show-inheritance:

datadog\_api\_client.v2.model.personal\_access\_token\_create\_response module
------------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.personal_access_token_create_response
:members:
:show-inheritance:

datadog\_api\_client.v2.model.personal\_access\_token\_relationships module
---------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.personal_access_token_relationships
:members:
:show-inheritance:

datadog\_api\_client.v2.model.personal\_access\_token\_response module
----------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.personal_access_token_response
:members:
:show-inheritance:

datadog\_api\_client.v2.model.personal\_access\_token\_response\_meta module
----------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.personal_access_token_response_meta
:members:
:show-inheritance:

datadog\_api\_client.v2.model.personal\_access\_token\_response\_meta\_page module
----------------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.personal_access_token_response_meta_page
:members:
:show-inheritance:

datadog\_api\_client.v2.model.personal\_access\_token\_update\_attributes module
--------------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.personal_access_token_update_attributes
:members:
:show-inheritance:

datadog\_api\_client.v2.model.personal\_access\_token\_update\_data module
--------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.personal_access_token_update_data
:members:
:show-inheritance:

datadog\_api\_client.v2.model.personal\_access\_token\_update\_request module
-----------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.personal_access_token_update_request
:members:
:show-inheritance:

datadog\_api\_client.v2.model.personal\_access\_tokens\_sort module
-------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.personal_access_tokens_sort
:members:
:show-inheritance:

datadog\_api\_client.v2.model.personal\_access\_tokens\_type module
-------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.personal_access_tokens_type
:members:
:show-inheritance:

datadog\_api\_client.v2.model.playlist module
---------------------------------------------

Expand Down Expand Up @@ -27402,6 +27528,27 @@ datadog\_api\_client.v2.model.sensitive\_data\_scanner\_text\_replacement\_type
:members:
:show-inheritance:

datadog\_api\_client.v2.model.service\_account\_access\_token\_create\_attributes module
----------------------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.service_account_access_token_create_attributes
:members:
:show-inheritance:

datadog\_api\_client.v2.model.service\_account\_access\_token\_create\_data module
----------------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.service_account_access_token_create_data
:members:
:show-inheritance:

datadog\_api\_client.v2.model.service\_account\_access\_token\_create\_request module
-------------------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.service_account_access_token_create_request
:members:
:show-inheritance:

datadog\_api\_client.v2.model.service\_account\_create\_attributes module
-------------------------------------------------------------------------

Expand Down
32 changes: 32 additions & 0 deletions examples/v2/key-management/CreatePersonalAccessToken.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
"""
Create a personal access token returns "Created" response
"""

from datetime import datetime
from dateutil.relativedelta import relativedelta
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.key_management_api import KeyManagementApi
from datadog_api_client.v2.model.personal_access_token_create_attributes import PersonalAccessTokenCreateAttributes
from datadog_api_client.v2.model.personal_access_token_create_data import PersonalAccessTokenCreateData
from datadog_api_client.v2.model.personal_access_token_create_request import PersonalAccessTokenCreateRequest
from datadog_api_client.v2.model.personal_access_tokens_type import PersonalAccessTokensType

body = PersonalAccessTokenCreateRequest(
data=PersonalAccessTokenCreateData(
type=PersonalAccessTokensType.PERSONAL_ACCESS_TOKENS,
attributes=PersonalAccessTokenCreateAttributes(
name="Example-Personal-Access-Token",
scopes=[
"dashboards_read",
],
expires_at=(datetime.now() + relativedelta(days=365)),
),
),
)

configuration = Configuration()
with ApiClient(configuration) as api_client:
api_instance = KeyManagementApi(api_client)
response = api_instance.create_personal_access_token(body=body)

print(response)
19 changes: 19 additions & 0 deletions examples/v2/key-management/GetPersonalAccessToken.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
"""
Get a personal access token returns "OK" response
"""

from os import environ
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.key_management_api import KeyManagementApi

# there is a valid "personal_access_token" in the system
PERSONAL_ACCESS_TOKEN_DATA_ID = environ["PERSONAL_ACCESS_TOKEN_DATA_ID"]

configuration = Configuration()
with ApiClient(configuration) as api_client:
api_instance = KeyManagementApi(api_client)
response = api_instance.get_personal_access_token(
pat_uuid=PERSONAL_ACCESS_TOKEN_DATA_ID,
)

print(response)
13 changes: 13 additions & 0 deletions examples/v2/key-management/ListPersonalAccessTokens.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
"""
Get all personal access tokens returns "OK" response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.key_management_api import KeyManagementApi

configuration = Configuration()
with ApiClient(configuration) as api_client:
api_instance = KeyManagementApi(api_client)
response = api_instance.list_personal_access_tokens()

print(response)
17 changes: 17 additions & 0 deletions examples/v2/key-management/RevokePersonalAccessToken.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
"""
Revoke a personal access token returns "No Content" response
"""

from os import environ
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.key_management_api import KeyManagementApi

# there is a valid "personal_access_token" in the system
PERSONAL_ACCESS_TOKEN_DATA_ID = environ["PERSONAL_ACCESS_TOKEN_DATA_ID"]

configuration = Configuration()
with ApiClient(configuration) as api_client:
api_instance = KeyManagementApi(api_client)
api_instance.revoke_personal_access_token(
pat_uuid=PERSONAL_ACCESS_TOKEN_DATA_ID,
)
31 changes: 31 additions & 0 deletions examples/v2/key-management/UpdatePersonalAccessToken.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
"""
Update a personal access token returns "OK" response
"""

from os import environ
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.key_management_api import KeyManagementApi
from datadog_api_client.v2.model.personal_access_token_update_attributes import PersonalAccessTokenUpdateAttributes
from datadog_api_client.v2.model.personal_access_token_update_data import PersonalAccessTokenUpdateData
from datadog_api_client.v2.model.personal_access_token_update_request import PersonalAccessTokenUpdateRequest
from datadog_api_client.v2.model.personal_access_tokens_type import PersonalAccessTokensType

# there is a valid "personal_access_token" in the system
PERSONAL_ACCESS_TOKEN_DATA_ID = environ["PERSONAL_ACCESS_TOKEN_DATA_ID"]

body = PersonalAccessTokenUpdateRequest(
data=PersonalAccessTokenUpdateData(
type=PersonalAccessTokensType.PERSONAL_ACCESS_TOKENS,
id=PERSONAL_ACCESS_TOKEN_DATA_ID,
attributes=PersonalAccessTokenUpdateAttributes(
name="Example-Personal-Access-Token-updated",
),
),
)

configuration = Configuration()
with ApiClient(configuration) as api_client:
api_instance = KeyManagementApi(api_client)
response = api_instance.update_personal_access_token(pat_uuid=PERSONAL_ACCESS_TOKEN_DATA_ID, body=body)

print(response)
39 changes: 39 additions & 0 deletions examples/v2/service-accounts/CreateServiceAccountAccessToken.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
"""
Create an access token for a service account returns "Created" response
"""

from os import environ
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.service_accounts_api import ServiceAccountsApi
from datadog_api_client.v2.model.personal_access_tokens_type import PersonalAccessTokensType
from datadog_api_client.v2.model.service_account_access_token_create_attributes import (
ServiceAccountAccessTokenCreateAttributes,
)
from datadog_api_client.v2.model.service_account_access_token_create_data import ServiceAccountAccessTokenCreateData
from datadog_api_client.v2.model.service_account_access_token_create_request import (
ServiceAccountAccessTokenCreateRequest,
)

# there is a valid "service_account_user" in the system
SERVICE_ACCOUNT_USER_DATA_ID = environ["SERVICE_ACCOUNT_USER_DATA_ID"]

body = ServiceAccountAccessTokenCreateRequest(
data=ServiceAccountAccessTokenCreateData(
type=PersonalAccessTokensType.PERSONAL_ACCESS_TOKENS,
attributes=ServiceAccountAccessTokenCreateAttributes(
name="Example-Service-Account",
scopes=[
"dashboards_read",
],
),
),
)

configuration = Configuration()
with ApiClient(configuration) as api_client:
api_instance = ServiceAccountsApi(api_client)
response = api_instance.create_service_account_access_token(
service_account_id=SERVICE_ACCOUNT_USER_DATA_ID, body=body
)

print(response)
39 changes: 39 additions & 0 deletions examples/v2/service-accounts/CreateServiceAccountAccessToken_4212922277.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
"""
Create a service account access token returns "Created" response
"""

from os import environ
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.key_management_api import KeyManagementApi
from datadog_api_client.v2.model.personal_access_tokens_type import PersonalAccessTokensType
from datadog_api_client.v2.model.service_account_access_token_create_attributes import (
ServiceAccountAccessTokenCreateAttributes,
)
from datadog_api_client.v2.model.service_account_access_token_create_data import ServiceAccountAccessTokenCreateData
from datadog_api_client.v2.model.service_account_access_token_create_request import (
ServiceAccountAccessTokenCreateRequest,
)

# there is a valid "service_account_user" in the system
SERVICE_ACCOUNT_USER_DATA_ID = environ["SERVICE_ACCOUNT_USER_DATA_ID"]

body = ServiceAccountAccessTokenCreateRequest(
data=ServiceAccountAccessTokenCreateData(
type=PersonalAccessTokensType.PERSONAL_ACCESS_TOKENS,
attributes=ServiceAccountAccessTokenCreateAttributes(
name="Example-Personal-Access-Token",
scopes=[
"dashboards_read",
],
),
),
)

configuration = Configuration()
with ApiClient(configuration) as api_client:
api_instance = KeyManagementApi(api_client)
response = api_instance.create_service_account_access_token(
service_account_id=SERVICE_ACCOUNT_USER_DATA_ID, body=body
)

print(response)
23 changes: 23 additions & 0 deletions examples/v2/service-accounts/GetServiceAccountAccessToken.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
"""
Get an access token for a service account returns "OK" response
"""

from os import environ
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.service_accounts_api import ServiceAccountsApi

# there is a valid "service_account_user" in the system
SERVICE_ACCOUNT_USER_DATA_ID = environ["SERVICE_ACCOUNT_USER_DATA_ID"]

# there is a valid "service_account_access_token" for "service_account_user"
SERVICE_ACCOUNT_ACCESS_TOKEN_DATA_ID = environ["SERVICE_ACCOUNT_ACCESS_TOKEN_DATA_ID"]

configuration = Configuration()
with ApiClient(configuration) as api_client:
api_instance = ServiceAccountsApi(api_client)
response = api_instance.get_service_account_access_token(
service_account_id=SERVICE_ACCOUNT_USER_DATA_ID,
pat_uuid=SERVICE_ACCOUNT_ACCESS_TOKEN_DATA_ID,
)

print(response)
Loading
Loading