1. Packages
  2. Juniper Mist
  3. API Docs
  4. site
  5. getWebhooks
Juniper Mist v0.1.1 published on Monday, Nov 4, 2024 by Pulumi

junipermist.site.getWebhooks

Explore with Pulumi AI

junipermist logo
Juniper Mist v0.1.1 published on Monday, Nov 4, 2024 by Pulumi

    This data source provides the list of Site Webhooks.

    Example Usage

    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.junipermist.site.SiteFunctions;
    import com.pulumi.junipermist.site.inputs.GetWebhooksArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            final var webhooks = SiteFunctions.getWebhooks(GetWebhooksArgs.builder()
                .orgId("15fca2ac-b1a6-47cc-9953-cc6906281550")
                .build());
    
        }
    }
    
    variables:
      webhooks:
        fn::invoke:
          Function: junipermist:site:getWebhooks
          Arguments:
            orgId: 15fca2ac-b1a6-47cc-9953-cc6906281550
    

    Using getWebhooks

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getWebhooks(args: GetWebhooksArgs, opts?: InvokeOptions): Promise<GetWebhooksResult>
    function getWebhooksOutput(args: GetWebhooksOutputArgs, opts?: InvokeOptions): Output<GetWebhooksResult>
    def get_webhooks(limit: Optional[int] = None,
                     page: Optional[int] = None,
                     site_id: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetWebhooksResult
    def get_webhooks_output(limit: Optional[pulumi.Input[int]] = None,
                     page: Optional[pulumi.Input[int]] = None,
                     site_id: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetWebhooksResult]
    func GetWebhooks(ctx *Context, args *GetWebhooksArgs, opts ...InvokeOption) (*GetWebhooksResult, error)
    func GetWebhooksOutput(ctx *Context, args *GetWebhooksOutputArgs, opts ...InvokeOption) GetWebhooksResultOutput

    > Note: This function is named GetWebhooks in the Go SDK.

    public static class GetWebhooks 
    {
        public static Task<GetWebhooksResult> InvokeAsync(GetWebhooksArgs args, InvokeOptions? opts = null)
        public static Output<GetWebhooksResult> Invoke(GetWebhooksInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetWebhooksResult> getWebhooks(GetWebhooksArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: junipermist:site/getWebhooks:getWebhooks
      arguments:
        # arguments dictionary

    The following arguments are supported:

    SiteId string
    Limit int
    Page int
    SiteId string
    Limit int
    Page int
    siteId String
    limit Integer
    page Integer
    siteId string
    limit number
    page number
    site_id str
    limit int
    page int
    siteId String
    limit Number
    page Number

    getWebhooks Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    SiteId string
    SiteWebhooks List<Pulumi.JuniperMist.Site.Outputs.GetWebhooksSiteWebhook>
    Limit int
    Page int
    Id string
    The provider-assigned unique ID for this managed resource.
    SiteId string
    SiteWebhooks []GetWebhooksSiteWebhook
    Limit int
    Page int
    id String
    The provider-assigned unique ID for this managed resource.
    siteId String
    siteWebhooks List<GetWebhooksSiteWebhook>
    limit Integer
    page Integer
    id string
    The provider-assigned unique ID for this managed resource.
    siteId string
    siteWebhooks GetWebhooksSiteWebhook[]
    limit number
    page number
    id str
    The provider-assigned unique ID for this managed resource.
    site_id str
    site_webhooks Sequence[GetWebhooksSiteWebhook]
    limit int
    page int
    id String
    The provider-assigned unique ID for this managed resource.
    siteId String
    siteWebhooks List<Property Map>
    limit Number
    page Number

    Supporting Types

    GetWebhooksSiteWebhook

    CreatedTime double
    Enabled bool
    whether webhook is enabled
    Headers Dictionary<string, string>
    if type=http-post, additional custom HTTP headers to add the headers name and value must be string, total bytes of headers name and value must be less than 1000
    Id string
    ModifiedTime double
    Name string
    name of the webhook
    Oauth2ClientId string
    required when oauth2_grant_type==client_credentials
    Oauth2ClientSecret string
    required when oauth2_grant_type==client_credentials
    Oauth2GrantType string
    required when type==oauth2. enum: client_credentials, password
    Oauth2Password string
    required when oauth2_grant_type==password
    Oauth2Scopes List<string>
    required when type==oauth2, if provided, will be used in the token request
    Oauth2TokenUrl string
    required when type==oauth2
    Oauth2Username string
    required when oauth2_grant_type==password
    OrgId string
    Secret string
    only if type=http-post
    SiteId string
    SplunkToken string
    required if type=splunk If splunk_token is not defined for a type Splunk webhook, it will not send, regardless if the webhook receiver is configured to accept it.'
    Topics List<string>
    N.B. For org webhooks, only device_events/alarms/audits/client-join/client-sessions/nac-sessions/nac_events topics are supported.
    Type string
    enum: aws-sns, google-pubsub, http-post, oauth2, splunk
    Url string
    VerifyCert bool
    when url uses HTTPS, whether to verify the certificate
    CreatedTime float64
    Enabled bool
    whether webhook is enabled
    Headers map[string]string
    if type=http-post, additional custom HTTP headers to add the headers name and value must be string, total bytes of headers name and value must be less than 1000
    Id string
    ModifiedTime float64
    Name string
    name of the webhook
    Oauth2ClientId string
    required when oauth2_grant_type==client_credentials
    Oauth2ClientSecret string
    required when oauth2_grant_type==client_credentials
    Oauth2GrantType string
    required when type==oauth2. enum: client_credentials, password
    Oauth2Password string
    required when oauth2_grant_type==password
    Oauth2Scopes []string
    required when type==oauth2, if provided, will be used in the token request
    Oauth2TokenUrl string
    required when type==oauth2
    Oauth2Username string
    required when oauth2_grant_type==password
    OrgId string
    Secret string
    only if type=http-post
    SiteId string
    SplunkToken string
    required if type=splunk If splunk_token is not defined for a type Splunk webhook, it will not send, regardless if the webhook receiver is configured to accept it.'
    Topics []string
    N.B. For org webhooks, only device_events/alarms/audits/client-join/client-sessions/nac-sessions/nac_events topics are supported.
    Type string
    enum: aws-sns, google-pubsub, http-post, oauth2, splunk
    Url string
    VerifyCert bool
    when url uses HTTPS, whether to verify the certificate
    createdTime Double
    enabled Boolean
    whether webhook is enabled
    headers Map<String,String>
    if type=http-post, additional custom HTTP headers to add the headers name and value must be string, total bytes of headers name and value must be less than 1000
    id String
    modifiedTime Double
    name String
    name of the webhook
    oauth2ClientId String
    required when oauth2_grant_type==client_credentials
    oauth2ClientSecret String
    required when oauth2_grant_type==client_credentials
    oauth2GrantType String
    required when type==oauth2. enum: client_credentials, password
    oauth2Password String
    required when oauth2_grant_type==password
    oauth2Scopes List<String>
    required when type==oauth2, if provided, will be used in the token request
    oauth2TokenUrl String
    required when type==oauth2
    oauth2Username String
    required when oauth2_grant_type==password
    orgId String
    secret String
    only if type=http-post
    siteId String
    splunkToken String
    required if type=splunk If splunk_token is not defined for a type Splunk webhook, it will not send, regardless if the webhook receiver is configured to accept it.'
    topics List<String>
    N.B. For org webhooks, only device_events/alarms/audits/client-join/client-sessions/nac-sessions/nac_events topics are supported.
    type String
    enum: aws-sns, google-pubsub, http-post, oauth2, splunk
    url String
    verifyCert Boolean
    when url uses HTTPS, whether to verify the certificate
    createdTime number
    enabled boolean
    whether webhook is enabled
    headers {[key: string]: string}
    if type=http-post, additional custom HTTP headers to add the headers name and value must be string, total bytes of headers name and value must be less than 1000
    id string
    modifiedTime number
    name string
    name of the webhook
    oauth2ClientId string
    required when oauth2_grant_type==client_credentials
    oauth2ClientSecret string
    required when oauth2_grant_type==client_credentials
    oauth2GrantType string
    required when type==oauth2. enum: client_credentials, password
    oauth2Password string
    required when oauth2_grant_type==password
    oauth2Scopes string[]
    required when type==oauth2, if provided, will be used in the token request
    oauth2TokenUrl string
    required when type==oauth2
    oauth2Username string
    required when oauth2_grant_type==password
    orgId string
    secret string
    only if type=http-post
    siteId string
    splunkToken string
    required if type=splunk If splunk_token is not defined for a type Splunk webhook, it will not send, regardless if the webhook receiver is configured to accept it.'
    topics string[]
    N.B. For org webhooks, only device_events/alarms/audits/client-join/client-sessions/nac-sessions/nac_events topics are supported.
    type string
    enum: aws-sns, google-pubsub, http-post, oauth2, splunk
    url string
    verifyCert boolean
    when url uses HTTPS, whether to verify the certificate
    created_time float
    enabled bool
    whether webhook is enabled
    headers Mapping[str, str]
    if type=http-post, additional custom HTTP headers to add the headers name and value must be string, total bytes of headers name and value must be less than 1000
    id str
    modified_time float
    name str
    name of the webhook
    oauth2_client_id str
    required when oauth2_grant_type==client_credentials
    oauth2_client_secret str
    required when oauth2_grant_type==client_credentials
    oauth2_grant_type str
    required when type==oauth2. enum: client_credentials, password
    oauth2_password str
    required when oauth2_grant_type==password
    oauth2_scopes Sequence[str]
    required when type==oauth2, if provided, will be used in the token request
    oauth2_token_url str
    required when type==oauth2
    oauth2_username str
    required when oauth2_grant_type==password
    org_id str
    secret str
    only if type=http-post
    site_id str
    splunk_token str
    required if type=splunk If splunk_token is not defined for a type Splunk webhook, it will not send, regardless if the webhook receiver is configured to accept it.'
    topics Sequence[str]
    N.B. For org webhooks, only device_events/alarms/audits/client-join/client-sessions/nac-sessions/nac_events topics are supported.
    type str
    enum: aws-sns, google-pubsub, http-post, oauth2, splunk
    url str
    verify_cert bool
    when url uses HTTPS, whether to verify the certificate
    createdTime Number
    enabled Boolean
    whether webhook is enabled
    headers Map<String>
    if type=http-post, additional custom HTTP headers to add the headers name and value must be string, total bytes of headers name and value must be less than 1000
    id String
    modifiedTime Number
    name String
    name of the webhook
    oauth2ClientId String
    required when oauth2_grant_type==client_credentials
    oauth2ClientSecret String
    required when oauth2_grant_type==client_credentials
    oauth2GrantType String
    required when type==oauth2. enum: client_credentials, password
    oauth2Password String
    required when oauth2_grant_type==password
    oauth2Scopes List<String>
    required when type==oauth2, if provided, will be used in the token request
    oauth2TokenUrl String
    required when type==oauth2
    oauth2Username String
    required when oauth2_grant_type==password
    orgId String
    secret String
    only if type=http-post
    siteId String
    splunkToken String
    required if type=splunk If splunk_token is not defined for a type Splunk webhook, it will not send, regardless if the webhook receiver is configured to accept it.'
    topics List<String>
    N.B. For org webhooks, only device_events/alarms/audits/client-join/client-sessions/nac-sessions/nac_events topics are supported.
    type String
    enum: aws-sns, google-pubsub, http-post, oauth2, splunk
    url String
    verifyCert Boolean
    when url uses HTTPS, whether to verify the certificate

    Package Details

    Repository
    junipermist pulumi/pulumi-junipermist
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the mist Terraform Provider.
    junipermist logo
    Juniper Mist v0.1.1 published on Monday, Nov 4, 2024 by Pulumi