Class OrganizationsApi

Hierarchy

OrganizationsApi

Index

Constructors

Properties

configuration requestFactory responseProcessor

Methods

getOrgConfig listOrgConfigs updateOrgConfig uploadIdPMetadata

Constructors

constructor

new OrganizationsApi(configuration: Configuration, requestFactory?: OrganizationsApiRequestFactory, responseProcessor?: OrganizationsApiResponseProcessor): v2.OrganizationsApi
Parameters
- configuration: Configuration
- Optional requestFactory: OrganizationsApiRequestFactory
- Optional responseProcessor: OrganizationsApiResponseProcessor
Returns v2.OrganizationsApi
- Defined in packages/datadog-api-client-v2/apis/OrganizationsApi.ts:446

Properties

`Private` configuration

configuration: Configuration

`Private` requestFactory

requestFactory: OrganizationsApiRequestFactory

`Private` responseProcessor

responseProcessor: OrganizationsApiResponseProcessor

Methods

getOrgConfig

getOrgConfig(param: OrganizationsApiGetOrgConfigRequest, options?: Configuration): Promise<OrgConfigGetResponse>
Return the name, description, and value of a specific Org Config.
Parameters
- param: OrganizationsApiGetOrgConfigRequest
  
  The request object
- Optional options: Configuration
Returns Promise<OrgConfigGetResponse>
- Defined in packages/datadog-api-client-v2/apis/OrganizationsApi.ts:462

listOrgConfigs

listOrgConfigs(options?: Configuration): Promise<OrgConfigListResponse>
Returns all Org Configs (name, description, and value).
Parameters
- Optional options: Configuration
Returns Promise<OrgConfigListResponse>
- Defined in packages/datadog-api-client-v2/apis/OrganizationsApi.ts:483

updateOrgConfig

updateOrgConfig(param: OrganizationsApiUpdateOrgConfigRequest, options?: Configuration): Promise<OrgConfigGetResponse>
Update the value of a specific Org Config.
Parameters
- param: OrganizationsApiUpdateOrgConfigRequest
  
  The request object
- Optional options: Configuration
Returns Promise<OrgConfigGetResponse>
- Defined in packages/datadog-api-client-v2/apis/OrganizationsApi.ts:500

uploadIdPMetadata

uploadIdPMetadata(param?: OrganizationsApiUploadIdPMetadataRequest, options?: Configuration): Promise<void>
Endpoint for uploading IdP metadata for SAML setup.

Use this endpoint to upload or replace IdP metadata for SAML login configuration.
Parameters
- param: OrganizationsApiUploadIdPMetadataRequest = {}
  
  The request object
- Optional options: Configuration
Returns Promise<void>
- Defined in packages/datadog-api-client-v2/apis/OrganizationsApi.ts:524

Generated using TypeDoc