Class IdentityProvidersApi

Hierarchy

IdentityProvidersApi

Index

Constructors

Properties

configuration requestFactory responseProcessor

Methods

listIdentityProviderUsers listIdentityProviderUsersWithPagination listIdentityProviders updateIdentityProvider

Constructors

constructor

new IdentityProvidersApi(configuration: Configuration, requestFactory?: IdentityProvidersApiRequestFactory, responseProcessor?: IdentityProvidersApiResponseProcessor): IdentityProvidersApi
Parameters
- configuration: Configuration
- Optional requestFactory: IdentityProvidersApiRequestFactory
- Optional responseProcessor: IdentityProvidersApiResponseProcessor
Returns IdentityProvidersApi
- Defined in packages/datadog-api-client-v2/apis/IdentityProvidersApi.ts:500

Properties

`Private` configuration

configuration: Configuration

`Private` requestFactory

requestFactory: IdentityProvidersApiRequestFactory

`Private` responseProcessor

responseProcessor: IdentityProvidersApiResponseProcessor

Methods

listIdentityProviderUsers

listIdentityProviderUsers(param: IdentityProvidersApiListIdentityProviderUsersRequest, options?: Configuration): Promise<UsersResponse>
Get all users in the organization whose login method has been overridden to use the specified identity provider.
Parameters
- param: IdentityProvidersApiListIdentityProviderUsersRequest
  
  The request object
- Optional options: Configuration
Returns Promise<UsersResponse>
- Defined in packages/datadog-api-client-v2/apis/IdentityProvidersApi.ts:535

listIdentityProviderUsersWithPagination

listIdentityProviderUsersWithPagination(param: IdentityProvidersApiListIdentityProviderUsersRequest, options?: Configuration): AsyncGenerator<v2.User, any, unknown>
Provide a paginated version of listIdentityProviderUsers returning a generator with all the items.
Parameters
- param: IdentityProvidersApiListIdentityProviderUsersRequest
- Optional options: Configuration
Returns AsyncGenerator<v2.User, any, unknown>
- Defined in packages/datadog-api-client-v2/apis/IdentityProvidersApi.ts:563

listIdentityProviders

listIdentityProviders(options?: Configuration): Promise<IdentityProvidersResponse>
Get all identity providers available for the current organization.
Parameters
- Optional options: Configuration
Returns Promise<IdentityProvidersResponse>
- Defined in packages/datadog-api-client-v2/apis/IdentityProvidersApi.ts:516

updateIdentityProvider

updateIdentityProvider(param: IdentityProvidersApiUpdateIdentityProviderRequest, options?: Configuration): Promise<IdentityProviderResponse>
Enable or disable an identity provider for the current organization.
Parameters
- param: IdentityProvidersApiUpdateIdentityProviderRequest
  
  The request object
- Optional options: Configuration
Returns Promise<IdentityProviderResponse>
- Defined in packages/datadog-api-client-v2/apis/IdentityProvidersApi.ts:611

Generated using TypeDoc