Class OrganizationsApi
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classManage optional parameters to listGlobalOrgs.static classManage optional parameters to listOrgs.static classManage optional parameters to uploadIdPMetadata. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionGet the API client.getOrgConfig(String orgConfigName) Get a specific Org Config value.getOrgConfigAsync(String orgConfigName) Get a specific Org Config value.getOrgConfigWithHttpInfo(String orgConfigName) Return the name, description, and value of a specific Org Config.getOrgConfigWithHttpInfoAsync(String orgConfigName) Get a specific Org Config value.getSAMLConfiguration(String samlConfigUuid) Get a SAML configuration.getSAMLConfigurationAsync(String samlConfigUuid) Get a SAML configuration.getSAMLConfigurationWithHttpInfo(String samlConfigUuid) Get a single SAML configuration for the current organization by its UUID.getSAMLConfigurationWithHttpInfoAsync(String samlConfigUuid) Get a SAML configuration.listGlobalOrgs(String userHandle) List global orgs.listGlobalOrgs(String userHandle, OrganizationsApi.ListGlobalOrgsOptionalParameters parameters) List global orgs.listGlobalOrgsAsync(String userHandle) List global orgs.listGlobalOrgsAsync(String userHandle, OrganizationsApi.ListGlobalOrgsOptionalParameters parameters) List global orgs.listGlobalOrgsWithHttpInfo(String userHandle, OrganizationsApi.ListGlobalOrgsOptionalParameters parameters) Returns organizations across regions for the authenticated user.listGlobalOrgsWithHttpInfoAsync(String userHandle, OrganizationsApi.ListGlobalOrgsOptionalParameters parameters) List global orgs.listGlobalOrgsWithPagination(String userHandle) List global orgs.listGlobalOrgsWithPagination(String userHandle, OrganizationsApi.ListGlobalOrgsOptionalParameters parameters) List global orgs.List Org Configs.List Org Configs.Returns all Org Configs (name, description, and value).List Org Configs.listOrgs()List your managed organizations.listOrgs(OrganizationsApi.ListOrgsOptionalParameters parameters) List your managed organizations.List your managed organizations.List your managed organizations.Returns the current organization and its managed organizations in JSON:API format.List your managed organizations.List SAML configurations.List SAML configurations.Get the list of SAML configurations for the current organization.List SAML configurations.voidsetApiClient(ApiClient apiClient) Set the API client.voidUpdate the maximum session duration.Update the maximum session duration.Update the maximum session duration for the current organization.Update the maximum session duration.updateOrgConfig(String orgConfigName, OrgConfigWriteRequest body) Update a specific Org Config.updateOrgConfigAsync(String orgConfigName, OrgConfigWriteRequest body) Update a specific Org Config.updateOrgConfigWithHttpInfo(String orgConfigName, OrgConfigWriteRequest body) Update the value of a specific Org Config.updateOrgConfigWithHttpInfoAsync(String orgConfigName, OrgConfigWriteRequest body) Update a specific Org Config.voidUpdate organization SAML preferences.Update organization SAML preferences.Update the SAML preferences for the current organization.Update organization SAML preferences.updateSAMLConfiguration(String samlConfigUuid, SAMLConfigurationUpdateRequest body) Update a SAML configuration.updateSAMLConfigurationAsync(String samlConfigUuid, SAMLConfigurationUpdateRequest body) Update a SAML configuration.updateSAMLConfigurationWithHttpInfo(String samlConfigUuid, SAMLConfigurationUpdateRequest body) Update a single SAML configuration for the current organization.updateSAMLConfigurationWithHttpInfoAsync(String samlConfigUuid, SAMLConfigurationUpdateRequest body) Update a SAML configuration.voidUpload IdP metadata.voidUpload IdP metadata.Upload IdP metadata.Upload IdP metadata.Endpoint for uploading IdP metadata for SAML setup.Upload IdP metadata.
-
Constructor Details
-
OrganizationsApi
public OrganizationsApi() -
OrganizationsApi
-
-
Method Details
-
getApiClient
Get the API client.- Returns:
- API client
-
setApiClient
Set the API client.- Parameters:
apiClient- an instance of API client
-
getOrgConfig
Get a specific Org Config value.- Parameters:
orgConfigName- The name of an Org Config. (required)- Returns:
- OrgConfigGetResponse
- Throws:
ApiException- if fails to make API call
-
getOrgConfigAsync
Get a specific Org Config value.- Parameters:
orgConfigName- The name of an Org Config. (required)- Returns:
- CompletableFuture<OrgConfigGetResponse>
-
getOrgConfigWithHttpInfo
public ApiResponse<OrgConfigGetResponse> getOrgConfigWithHttpInfo(String orgConfigName) throws ApiException Return the name, description, and value of a specific Org Config.- Parameters:
orgConfigName- The name of an Org Config. (required)- Returns:
- ApiResponse<OrgConfigGetResponse>
- Throws:
ApiException- if fails to make API call- Http Response Details:
Response details Status Code Description Response Headers 200 OK - 400 Bad Request - 401 Unauthorized - 403 Forbidden - 404 Not Found - 429 Too many requests -
-
getOrgConfigWithHttpInfoAsync
public CompletableFuture<ApiResponse<OrgConfigGetResponse>> getOrgConfigWithHttpInfoAsync(String orgConfigName) Get a specific Org Config value.- Parameters:
orgConfigName- The name of an Org Config. (required)- Returns:
- CompletableFuture<ApiResponse<OrgConfigGetResponse>>
-
getSAMLConfiguration
Get a SAML configuration.- Parameters:
samlConfigUuid- The UUID of the SAML configuration. (required)- Returns:
- SAMLConfigurationResponse
- Throws:
ApiException- if fails to make API call
-
getSAMLConfigurationAsync
public CompletableFuture<SAMLConfigurationResponse> getSAMLConfigurationAsync(String samlConfigUuid) Get a SAML configuration.See
getSAMLConfigurationWithHttpInfoAsync(java.lang.String).- Parameters:
samlConfigUuid- The UUID of the SAML configuration. (required)- Returns:
- CompletableFuture<SAMLConfigurationResponse>
-
getSAMLConfigurationWithHttpInfo
public ApiResponse<SAMLConfigurationResponse> getSAMLConfigurationWithHttpInfo(String samlConfigUuid) throws ApiException Get a single SAML configuration for the current organization by its UUID.- Parameters:
samlConfigUuid- The UUID of the SAML configuration. (required)- Returns:
- ApiResponse<SAMLConfigurationResponse>
- Throws:
ApiException- if fails to make API call- Http Response Details:
Response details Status Code Description Response Headers 200 OK - 403 Authentication Error - 404 Not Found - 429 Too many requests -
-
getSAMLConfigurationWithHttpInfoAsync
public CompletableFuture<ApiResponse<SAMLConfigurationResponse>> getSAMLConfigurationWithHttpInfoAsync(String samlConfigUuid) Get a SAML configuration.- Parameters:
samlConfigUuid- The UUID of the SAML configuration. (required)- Returns:
- CompletableFuture<ApiResponse<SAMLConfigurationResponse>>
-
listGlobalOrgs
List global orgs.- Parameters:
userHandle- The handle of the authenticated user. (required)- Returns:
- GlobalOrgsResponse
- Throws:
ApiException- if fails to make API call
-
listGlobalOrgsAsync
List global orgs.- Parameters:
userHandle- The handle of the authenticated user. (required)- Returns:
- CompletableFuture<GlobalOrgsResponse>
-
listGlobalOrgs
public GlobalOrgsResponse listGlobalOrgs(String userHandle, OrganizationsApi.ListGlobalOrgsOptionalParameters parameters) throws ApiException List global orgs.- Parameters:
userHandle- The handle of the authenticated user. (required)parameters- Optional parameters for the request.- Returns:
- GlobalOrgsResponse
- Throws:
ApiException- if fails to make API call
-
listGlobalOrgsAsync
public CompletableFuture<GlobalOrgsResponse> listGlobalOrgsAsync(String userHandle, OrganizationsApi.ListGlobalOrgsOptionalParameters parameters) List global orgs.- Parameters:
userHandle- The handle of the authenticated user. (required)parameters- Optional parameters for the request.- Returns:
- CompletableFuture<GlobalOrgsResponse>
-
listGlobalOrgsWithPagination
List global orgs.- Parameters:
userHandle- The handle of the authenticated user. (required)- Returns:
- PaginationIterable<GlobalOrgData>
-
listGlobalOrgsWithPagination
public PaginationIterable<GlobalOrgData> listGlobalOrgsWithPagination(String userHandle, OrganizationsApi.ListGlobalOrgsOptionalParameters parameters) List global orgs.- Parameters:
userHandle- The handle of the authenticated user. (required)- Returns:
- GlobalOrgsResponse
-
listGlobalOrgsWithHttpInfo
public ApiResponse<GlobalOrgsResponse> listGlobalOrgsWithHttpInfo(String userHandle, OrganizationsApi.ListGlobalOrgsOptionalParameters parameters) throws ApiException Returns organizations across regions for the authenticated user. Theuser_handlequery parameter must match the authenticated user's handle.- Parameters:
userHandle- The handle of the authenticated user. (required)parameters- Optional parameters for the request.- Returns:
- ApiResponse<GlobalOrgsResponse>
- Throws:
ApiException- if fails to make API call- Http Response Details:
Response details Status Code Description Response Headers 200 OK - 400 Bad Request - 401 Unauthorized - 403 Forbidden - 429 Too many requests -
-
listGlobalOrgsWithHttpInfoAsync
public CompletableFuture<ApiResponse<GlobalOrgsResponse>> listGlobalOrgsWithHttpInfoAsync(String userHandle, OrganizationsApi.ListGlobalOrgsOptionalParameters parameters) List global orgs.- Parameters:
userHandle- The handle of the authenticated user. (required)parameters- Optional parameters for the request.- Returns:
- CompletableFuture<ApiResponse<GlobalOrgsResponse>>
-
listOrgConfigs
List Org Configs.- Returns:
- OrgConfigListResponse
- Throws:
ApiException- if fails to make API call
-
listOrgConfigsAsync
List Org Configs.- Returns:
- CompletableFuture<OrgConfigListResponse>
-
listOrgConfigsWithHttpInfo
Returns all Org Configs (name, description, and value).- Returns:
- ApiResponse<OrgConfigListResponse>
- Throws:
ApiException- if fails to make API call- Http Response Details:
Response details Status Code Description Response Headers 200 OK - 400 Bad Request - 401 Unauthorized - 403 Forbidden - 429 Too many requests -
-
listOrgConfigsWithHttpInfoAsync
List Org Configs.- Returns:
- CompletableFuture<ApiResponse<OrgConfigListResponse>>
-
listOrgs
List your managed organizations.See
listOrgsWithHttpInfo(com.datadog.api.client.v2.api.OrganizationsApi.ListOrgsOptionalParameters).- Returns:
- ManagedOrgsResponse
- Throws:
ApiException- if fails to make API call
-
listOrgsAsync
List your managed organizations.See
listOrgsWithHttpInfoAsync(com.datadog.api.client.v2.api.OrganizationsApi.ListOrgsOptionalParameters).- Returns:
- CompletableFuture<ManagedOrgsResponse>
-
listOrgs
public ManagedOrgsResponse listOrgs(OrganizationsApi.ListOrgsOptionalParameters parameters) throws ApiException List your managed organizations.See
listOrgsWithHttpInfo(com.datadog.api.client.v2.api.OrganizationsApi.ListOrgsOptionalParameters).- Parameters:
parameters- Optional parameters for the request.- Returns:
- ManagedOrgsResponse
- Throws:
ApiException- if fails to make API call
-
listOrgsAsync
public CompletableFuture<ManagedOrgsResponse> listOrgsAsync(OrganizationsApi.ListOrgsOptionalParameters parameters) List your managed organizations.See
listOrgsWithHttpInfoAsync(com.datadog.api.client.v2.api.OrganizationsApi.ListOrgsOptionalParameters).- Parameters:
parameters- Optional parameters for the request.- Returns:
- CompletableFuture<ManagedOrgsResponse>
-
listOrgsWithHttpInfo
public ApiResponse<ManagedOrgsResponse> listOrgsWithHttpInfo(OrganizationsApi.ListOrgsOptionalParameters parameters) throws ApiException Returns the current organization and its managed organizations in JSON:API format.- Parameters:
parameters- Optional parameters for the request.- Returns:
- ApiResponse<ManagedOrgsResponse>
- Throws:
ApiException- if fails to make API call- Http Response Details:
Response details Status Code Description Response Headers 200 OK - 401 Unauthorized - 403 Forbidden - 429 Too many requests -
-
listOrgsWithHttpInfoAsync
public CompletableFuture<ApiResponse<ManagedOrgsResponse>> listOrgsWithHttpInfoAsync(OrganizationsApi.ListOrgsOptionalParameters parameters) List your managed organizations.See
listOrgsWithHttpInfo(com.datadog.api.client.v2.api.OrganizationsApi.ListOrgsOptionalParameters).- Parameters:
parameters- Optional parameters for the request.- Returns:
- CompletableFuture<ApiResponse<ManagedOrgsResponse>>
-
listSAMLConfigurations
List SAML configurations.- Returns:
- SAMLConfigurationsResponse
- Throws:
ApiException- if fails to make API call
-
listSAMLConfigurationsAsync
List SAML configurations.- Returns:
- CompletableFuture<SAMLConfigurationsResponse>
-
listSAMLConfigurationsWithHttpInfo
public ApiResponse<SAMLConfigurationsResponse> listSAMLConfigurationsWithHttpInfo() throws ApiExceptionGet the list of SAML configurations for the current organization. An organization has at most one SAML configuration.- Returns:
- ApiResponse<SAMLConfigurationsResponse>
- Throws:
ApiException- if fails to make API call- Http Response Details:
Response details Status Code Description Response Headers 200 OK - 403 Authentication Error - 429 Too many requests -
-
listSAMLConfigurationsWithHttpInfoAsync
public CompletableFuture<ApiResponse<SAMLConfigurationsResponse>> listSAMLConfigurationsWithHttpInfoAsync()List SAML configurations.- Returns:
- CompletableFuture<ApiResponse<SAMLConfigurationsResponse>>
-
updateLoginOrgConfigsMaxSessionDuration
public void updateLoginOrgConfigsMaxSessionDuration(MaxSessionDurationUpdateRequest body) throws ApiException Update the maximum session duration.- Parameters:
body- (required)- Throws:
ApiException- if fails to make API call
-
updateLoginOrgConfigsMaxSessionDurationAsync
public CompletableFuture<Void> updateLoginOrgConfigsMaxSessionDurationAsync(MaxSessionDurationUpdateRequest body) Update the maximum session duration.- Parameters:
body- (required)- Returns:
- CompletableFuture
-
updateLoginOrgConfigsMaxSessionDurationWithHttpInfo
public ApiResponse<Void> updateLoginOrgConfigsMaxSessionDurationWithHttpInfo(MaxSessionDurationUpdateRequest body) throws ApiException Update the maximum session duration for the current organization. The duration is specified in seconds.- Parameters:
body- (required)- Returns:
- ApiResponse<Void>
- Throws:
ApiException- if fails to make API call- Http Response Details:
Response details Status Code Description Response Headers 204 No Content - 400 Bad Request - 401 Unauthorized - 403 Forbidden - 429 Too many requests -
-
updateLoginOrgConfigsMaxSessionDurationWithHttpInfoAsync
public CompletableFuture<ApiResponse<Void>> updateLoginOrgConfigsMaxSessionDurationWithHttpInfoAsync(MaxSessionDurationUpdateRequest body) Update the maximum session duration.- Parameters:
body- (required)- Returns:
- CompletableFuture<ApiResponse<Void>>
-
updateOrgConfig
public OrgConfigGetResponse updateOrgConfig(String orgConfigName, OrgConfigWriteRequest body) throws ApiException Update a specific Org Config.See
updateOrgConfigWithHttpInfo(java.lang.String, com.datadog.api.client.v2.model.OrgConfigWriteRequest).- Parameters:
orgConfigName- The name of an Org Config. (required)body- (required)- Returns:
- OrgConfigGetResponse
- Throws:
ApiException- if fails to make API call
-
updateOrgConfigAsync
public CompletableFuture<OrgConfigGetResponse> updateOrgConfigAsync(String orgConfigName, OrgConfigWriteRequest body) Update a specific Org Config.- Parameters:
orgConfigName- The name of an Org Config. (required)body- (required)- Returns:
- CompletableFuture<OrgConfigGetResponse>
-
updateOrgConfigWithHttpInfo
public ApiResponse<OrgConfigGetResponse> updateOrgConfigWithHttpInfo(String orgConfigName, OrgConfigWriteRequest body) throws ApiException Update the value of a specific Org Config.- Parameters:
orgConfigName- The name of an Org Config. (required)body- (required)- Returns:
- ApiResponse<OrgConfigGetResponse>
- Throws:
ApiException- if fails to make API call- Http Response Details:
Response details Status Code Description Response Headers 200 OK - 400 Bad Request - 401 Unauthorized - 403 Forbidden - 404 Not Found - 429 Too many requests -
-
updateOrgConfigWithHttpInfoAsync
public CompletableFuture<ApiResponse<OrgConfigGetResponse>> updateOrgConfigWithHttpInfoAsync(String orgConfigName, OrgConfigWriteRequest body) Update a specific Org Config.See
updateOrgConfigWithHttpInfo(java.lang.String, com.datadog.api.client.v2.model.OrgConfigWriteRequest).- Parameters:
orgConfigName- The name of an Org Config. (required)body- (required)- Returns:
- CompletableFuture<ApiResponse<OrgConfigGetResponse>>
-
updateOrgSamlConfigurations
Update organization SAML preferences.- Parameters:
body- (required)- Throws:
ApiException- if fails to make API call
-
updateOrgSamlConfigurationsAsync
public CompletableFuture<Void> updateOrgSamlConfigurationsAsync(OrgSAMLPreferencesUpdateRequest body) Update organization SAML preferences.- Parameters:
body- (required)- Returns:
- CompletableFuture
-
updateOrgSamlConfigurationsWithHttpInfo
public ApiResponse<Void> updateOrgSamlConfigurationsWithHttpInfo(OrgSAMLPreferencesUpdateRequest body) throws ApiException Update the SAML preferences for the current organization.Use this endpoint to set the just-in-time (JIT) provisioning domains and the default role assigned to just-in-time provisioned users.
- Parameters:
body- (required)- Returns:
- ApiResponse<Void>
- Throws:
ApiException- if fails to make API call- Http Response Details:
Response details Status Code Description Response Headers 204 No Content - 400 Bad Request - 403 Forbidden - 404 Not Found - 429 Too many requests -
-
updateOrgSamlConfigurationsWithHttpInfoAsync
public CompletableFuture<ApiResponse<Void>> updateOrgSamlConfigurationsWithHttpInfoAsync(OrgSAMLPreferencesUpdateRequest body) Update organization SAML preferences.- Parameters:
body- (required)- Returns:
- CompletableFuture<ApiResponse<Void>>
-
updateSAMLConfiguration
public SAMLConfigurationResponse updateSAMLConfiguration(String samlConfigUuid, SAMLConfigurationUpdateRequest body) throws ApiException Update a SAML configuration.- Parameters:
samlConfigUuid- The UUID of the SAML configuration. (required)body- (required)- Returns:
- SAMLConfigurationResponse
- Throws:
ApiException- if fails to make API call
-
updateSAMLConfigurationAsync
public CompletableFuture<SAMLConfigurationResponse> updateSAMLConfigurationAsync(String samlConfigUuid, SAMLConfigurationUpdateRequest body) Update a SAML configuration.- Parameters:
samlConfigUuid- The UUID of the SAML configuration. (required)body- (required)- Returns:
- CompletableFuture<SAMLConfigurationResponse>
-
updateSAMLConfigurationWithHttpInfo
public ApiResponse<SAMLConfigurationResponse> updateSAMLConfigurationWithHttpInfo(String samlConfigUuid, SAMLConfigurationUpdateRequest body) throws ApiException Update a single SAML configuration for the current organization.Use this endpoint to enable or disable identity-provider-initiated login, set the just-in-time provisioning domains, and set the default role assigned to just-in-time provisioned users. A default role is required to enable just-in-time provisioning.
- Parameters:
samlConfigUuid- The UUID of the SAML configuration. (required)body- (required)- Returns:
- ApiResponse<SAMLConfigurationResponse>
- Throws:
ApiException- if fails to make API call- Http Response Details:
Response details Status Code Description Response Headers 200 OK - 400 Bad Request - 403 Authentication Error - 404 Not Found - 422 Unprocessable Entity - 429 Too many requests -
-
updateSAMLConfigurationWithHttpInfoAsync
public CompletableFuture<ApiResponse<SAMLConfigurationResponse>> updateSAMLConfigurationWithHttpInfoAsync(String samlConfigUuid, SAMLConfigurationUpdateRequest body) Update a SAML configuration.- Parameters:
samlConfigUuid- The UUID of the SAML configuration. (required)body- (required)- Returns:
- CompletableFuture<ApiResponse<SAMLConfigurationResponse>>
-
uploadIdPMetadata
Upload IdP metadata.- Throws:
ApiException- if fails to make API call
-
uploadIdPMetadataAsync
Upload IdP metadata.- Returns:
- CompletableFuture
-
uploadIdPMetadata
public void uploadIdPMetadata(OrganizationsApi.UploadIdPMetadataOptionalParameters parameters) throws ApiException Upload IdP metadata.- Parameters:
parameters- Optional parameters for the request.- Throws:
ApiException- if fails to make API call
-
uploadIdPMetadataAsync
public CompletableFuture<Void> uploadIdPMetadataAsync(OrganizationsApi.UploadIdPMetadataOptionalParameters parameters) Upload IdP metadata.- Parameters:
parameters- Optional parameters for the request.- Returns:
- CompletableFuture
-
uploadIdPMetadataWithHttpInfo
public ApiResponse<Void> uploadIdPMetadataWithHttpInfo(OrganizationsApi.UploadIdPMetadataOptionalParameters parameters) throws ApiException Endpoint for uploading IdP metadata for SAML setup.Use this endpoint to upload or replace IdP metadata for SAML login configuration.
- Parameters:
parameters- Optional parameters for the request.- Returns:
- ApiResponse<Void>
- 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 -
-
uploadIdPMetadataWithHttpInfoAsync
public CompletableFuture<ApiResponse<Void>> uploadIdPMetadataWithHttpInfoAsync(OrganizationsApi.UploadIdPMetadataOptionalParameters parameters) Upload IdP metadata.- Parameters:
parameters- Optional parameters for the request.- Returns:
- CompletableFuture<ApiResponse<Void>>
-