com.datadog.api.client.v1.api

Class OrganizationsApi

java.lang.Object

com.datadog.api.client.v1.api.OrganizationsApi

@Generated(value="https://github.com/DataDog/datadog-api-client-java/blob/master/.generator")
public class OrganizationsApi
extends Object

Constructor Summary

Constructors

Constructor and Description
OrganizationsApi()
OrganizationsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
OrganizationCreateResponse	createChildOrg(OrganizationCreateBody body) Create a child organization.
CompletableFuture<OrganizationCreateResponse>	createChildOrgAsync(OrganizationCreateBody body) Create a child organization.
ApiResponse<OrganizationCreateResponse>	createChildOrgWithHttpInfo(OrganizationCreateBody body) Create a child organization.
CompletableFuture<ApiResponse<OrganizationCreateResponse>>	createChildOrgWithHttpInfoAsync(OrganizationCreateBody body) Create a child organization.
OrgDowngradedResponse	downgradeOrg(String publicId) Spin-off Child Organization.
CompletableFuture<OrgDowngradedResponse>	downgradeOrgAsync(String publicId) Spin-off Child Organization.
ApiResponse<OrgDowngradedResponse>	downgradeOrgWithHttpInfo(String publicId) Only available for MSP customers.
CompletableFuture<ApiResponse<OrgDowngradedResponse>>	downgradeOrgWithHttpInfoAsync(String publicId) Spin-off Child Organization.
ApiClient	getApiClient() Get the API client.
OrganizationResponse	getOrg(String publicId) Get organization information.
CompletableFuture<OrganizationResponse>	getOrgAsync(String publicId) Get organization information.
ApiResponse<OrganizationResponse>	getOrgWithHttpInfo(String publicId) Get organization information.
CompletableFuture<ApiResponse<OrganizationResponse>>	getOrgWithHttpInfoAsync(String publicId) Get organization information.
OrganizationListResponse	listOrgs() List your managed organizations.
CompletableFuture<OrganizationListResponse>	listOrgsAsync() List your managed organizations.
ApiResponse<OrganizationListResponse>	listOrgsWithHttpInfo() This endpoint returns data on your top-level organization.
CompletableFuture<ApiResponse<OrganizationListResponse>>	listOrgsWithHttpInfoAsync() List your managed organizations.
void	setApiClient(ApiClient apiClient) Set the API client.
OrganizationResponse	updateOrg(String publicId, Organization body) Update your organization.
CompletableFuture<OrganizationResponse>	updateOrgAsync(String publicId, Organization body) Update your organization.
ApiResponse<OrganizationResponse>	updateOrgWithHttpInfo(String publicId, Organization body) Update your organization.
CompletableFuture<ApiResponse<OrganizationResponse>>	updateOrgWithHttpInfoAsync(String publicId, Organization body) Update your organization.
IdpResponse	uploadIdPForOrg(String publicId, File idpFile) Upload IdP metadata.
CompletableFuture<IdpResponse>	uploadIdPForOrgAsync(String publicId, File idpFile) Upload IdP metadata.
ApiResponse<IdpResponse>	uploadIdPForOrgWithHttpInfo(String publicId, File idpFile) There are a couple of options for updating the Identity Provider (IdP) metadata from your SAML IdP.
CompletableFuture<ApiResponse<IdpResponse>>	uploadIdPForOrgWithHttpInfoAsync(String publicId, File idpFile) Upload IdP metadata.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OrganizationsApi

public OrganizationsApi()

OrganizationsApi

public OrganizationsApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

Get the API client.

Returns:

API client

setApiClient

public void setApiClient(ApiClient apiClient)

Set the API client.

Parameters:

apiClient - an instance of API client

createChildOrg

public OrganizationCreateResponse createChildOrg(OrganizationCreateBody body)
                                          throws ApiException

Create a child organization.

See createChildOrgWithHttpInfo(com.datadog.api.client.v1.model.OrganizationCreateBody).

Parameters:

body - Organization object that needs to be created (required)

Returns:

OrganizationCreateResponse

Throws:

ApiException - if fails to make API call

createChildOrgAsync

public CompletableFuture<OrganizationCreateResponse> createChildOrgAsync(OrganizationCreateBody body)

Create a child organization.

See createChildOrgWithHttpInfoAsync(com.datadog.api.client.v1.model.OrganizationCreateBody).

Parameters:

body - Organization object that needs to be created (required)

Returns:

CompletableFuture<OrganizationCreateResponse>

createChildOrgWithHttpInfo

public ApiResponse<OrganizationCreateResponse> createChildOrgWithHttpInfo(OrganizationCreateBody body)
                                                                   throws ApiException

Create a child organization.

This endpoint requires the multi-organization account feature and must be enabled by contacting support.

Once a new child organization is created, you can interact with it by using the org.public_id, api_key.key, and application_key.hash provided in the response.

Parameters:

body - Organization object that needs to be created (required)

Returns:

ApiResponse<OrganizationCreateResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	OK	-
400	Bad Request	-
403	Forbidden	-
429	Too many requests	-

createChildOrgWithHttpInfoAsync

public CompletableFuture<ApiResponse<OrganizationCreateResponse>> createChildOrgWithHttpInfoAsync(OrganizationCreateBody body)

Create a child organization.

See createChildOrgWithHttpInfo(com.datadog.api.client.v1.model.OrganizationCreateBody).

Parameters:

body - Organization object that needs to be created (required)

Returns:

CompletableFuture<ApiResponse<OrganizationCreateResponse>>

downgradeOrg

public OrgDowngradedResponse downgradeOrg(String publicId)
                                   throws ApiException

Spin-off Child Organization.

See downgradeOrgWithHttpInfo(java.lang.String).

Parameters:

publicId - The public_id of the organization you are operating within. (required)

Returns:

OrgDowngradedResponse

Throws:

ApiException - if fails to make API call

downgradeOrgAsync

public CompletableFuture<OrgDowngradedResponse> downgradeOrgAsync(String publicId)

Spin-off Child Organization.

See downgradeOrgWithHttpInfoAsync(java.lang.String).

Parameters:

publicId - The public_id of the organization you are operating within. (required)

Returns:

CompletableFuture<OrgDowngradedResponse>

downgradeOrgWithHttpInfo

public ApiResponse<OrgDowngradedResponse> downgradeOrgWithHttpInfo(String publicId)
                                                            throws ApiException

Only available for MSP customers. Removes a child organization from the hierarchy of the master organization and places the child organization on a 30-day trial.

Parameters:

publicId - The public_id of the organization you are operating within. (required)

Returns:

ApiResponse<OrgDowngradedResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	OK	-
400	Bad Request	-
403	Forbidden	-
429	Too many requests	-

downgradeOrgWithHttpInfoAsync

public CompletableFuture<ApiResponse<OrgDowngradedResponse>> downgradeOrgWithHttpInfoAsync(String publicId)

Spin-off Child Organization.

See downgradeOrgWithHttpInfo(java.lang.String).

Parameters:

publicId - The public_id of the organization you are operating within. (required)

Returns:

CompletableFuture<ApiResponse<OrgDowngradedResponse>>

getOrg

public OrganizationResponse getOrg(String publicId)
                            throws ApiException

Get organization information.

See getOrgWithHttpInfo(java.lang.String).

Parameters:

publicId - The public_id of the organization you are operating within. (required)

Returns:

OrganizationResponse

Throws:

ApiException - if fails to make API call

getOrgAsync

public CompletableFuture<OrganizationResponse> getOrgAsync(String publicId)

Get organization information.

See getOrgWithHttpInfoAsync(java.lang.String).

Parameters:

publicId - The public_id of the organization you are operating within. (required)

Returns:

CompletableFuture<OrganizationResponse>

getOrgWithHttpInfo

public ApiResponse<OrganizationResponse> getOrgWithHttpInfo(String publicId)
                                                     throws ApiException

Get organization information.

Parameters:

publicId - The public_id of the organization you are operating within. (required)

Returns:

ApiResponse<OrganizationResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	OK	-
400	Bad Request	-
403	Forbidden	-
429	Too many requests	-

getOrgWithHttpInfoAsync

public CompletableFuture<ApiResponse<OrganizationResponse>> getOrgWithHttpInfoAsync(String publicId)

Get organization information.

See getOrgWithHttpInfo(java.lang.String).

Parameters:

publicId - The public_id of the organization you are operating within. (required)

Returns:

CompletableFuture<ApiResponse<OrganizationResponse>>

listOrgs

public OrganizationListResponse listOrgs()
                                  throws ApiException

List your managed organizations.

See listOrgsWithHttpInfo().

Returns:

OrganizationListResponse

Throws:

ApiException - if fails to make API call

listOrgsAsync

public CompletableFuture<OrganizationListResponse> listOrgsAsync()

List your managed organizations.

See listOrgsWithHttpInfoAsync().

Returns:

CompletableFuture<OrganizationListResponse>

listOrgsWithHttpInfo

public ApiResponse<OrganizationListResponse> listOrgsWithHttpInfo()
                                                           throws ApiException

This endpoint returns data on your top-level organization.

Returns:

ApiResponse<OrganizationListResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	OK	-
403	Forbidden	-
429	Too many requests	-

listOrgsWithHttpInfoAsync

public CompletableFuture<ApiResponse<OrganizationListResponse>> listOrgsWithHttpInfoAsync()

List your managed organizations.

See listOrgsWithHttpInfo().

Returns:

CompletableFuture<ApiResponse<OrganizationListResponse>>

updateOrg

public OrganizationResponse updateOrg(String publicId,
                                      Organization body)
                               throws ApiException

Update your organization.

See updateOrgWithHttpInfo(java.lang.String, com.datadog.api.client.v1.model.Organization).

Parameters:

publicId - The public_id of the organization you are operating within. (required)

body - (required)

Returns:

OrganizationResponse

Throws:

ApiException - if fails to make API call

updateOrgAsync

public CompletableFuture<OrganizationResponse> updateOrgAsync(String publicId,
                                                              Organization body)

Update your organization.

See updateOrgWithHttpInfoAsync(java.lang.String, com.datadog.api.client.v1.model.Organization).

Parameters:

publicId - The public_id of the organization you are operating within. (required)

body - (required)

Returns:

CompletableFuture<OrganizationResponse>

updateOrgWithHttpInfo

public ApiResponse<OrganizationResponse> updateOrgWithHttpInfo(String publicId,
                                                               Organization body)
                                                        throws ApiException

Update your organization.

Parameters:

publicId - The public_id of the organization you are operating within. (required)

body - (required)

Returns:

ApiResponse<OrganizationResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	OK	-
400	Bad Request	-
403	Forbidden	-
429	Too many requests	-

updateOrgWithHttpInfoAsync

public CompletableFuture<ApiResponse<OrganizationResponse>> updateOrgWithHttpInfoAsync(String publicId,
                                                                                       Organization body)

Update your organization.

See updateOrgWithHttpInfo(java.lang.String, com.datadog.api.client.v1.model.Organization).

Parameters:

publicId - The public_id of the organization you are operating within. (required)

body - (required)

Returns:

CompletableFuture<ApiResponse<OrganizationResponse>>

uploadIdPForOrg

public IdpResponse uploadIdPForOrg(String publicId,
                                   File idpFile)
                            throws ApiException

Upload IdP metadata.

See uploadIdPForOrgWithHttpInfo(java.lang.String, java.io.File).

Parameters:

publicId - The public_id of the organization you are operating with (required)

idpFile - The path to the XML metadata file you wish to upload. (required)

Returns:

IdpResponse

Throws:

ApiException - if fails to make API call

uploadIdPForOrgAsync

public CompletableFuture<IdpResponse> uploadIdPForOrgAsync(String publicId,
                                                           File idpFile)

Upload IdP metadata.

See uploadIdPForOrgWithHttpInfoAsync(java.lang.String, java.io.File).

Parameters:

publicId - The public_id of the organization you are operating with (required)

idpFile - The path to the XML metadata file you wish to upload. (required)

Returns:

CompletableFuture<IdpResponse>

uploadIdPForOrgWithHttpInfo

public ApiResponse<IdpResponse> uploadIdPForOrgWithHttpInfo(String publicId,
                                                            File idpFile)
                                                     throws ApiException

There are a couple of options for updating the Identity Provider (IdP) metadata from your SAML IdP.

• Multipart Form-Data: Post the IdP metadata file using a form post.

• XML Body: Post the IdP metadata file as the body of the request.

Parameters:

publicId - The public_id of the organization you are operating with (required)

idpFile - The path to the XML metadata file you wish to upload. (required)

Returns:

ApiResponse<IdpResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	OK	-
400	Bad Request	-
403	Forbidden	-
415	Unsupported Media Type	-
429	Too many requests	-

uploadIdPForOrgWithHttpInfoAsync

public CompletableFuture<ApiResponse<IdpResponse>> uploadIdPForOrgWithHttpInfoAsync(String publicId,
                                                                                    File idpFile)

Upload IdP metadata.

See uploadIdPForOrgWithHttpInfo(java.lang.String, java.io.File).

Parameters:

publicId - The public_id of the organization you are operating with (required)

idpFile - The path to the XML metadata file you wish to upload. (required)

Returns:

CompletableFuture<ApiResponse<IdpResponse>>