Orgs Wx Rules

orgsWxRules := client.OrgsWxRules()

Class Name

OrgsWxRules

Methods

Create Org Wx Rule
Delete Org Wx Rule
Get Org Wx Rule
List Org Wx Rules
Update Org Wx Rule

Create Org Wx Rule

Create Org WxRule

CreateOrgWxRule(
    ctx context.Context,
    orgId uuid.UUID,
    body *models.WxlanRule) (
    models.ApiResponse[models.WxlanRule],
    error)

Parameters

Parameter	Type	Tags	Description
`orgId`	`uuid.UUID`	Template, Required	-
`body`	`*models.WxlanRule`	Body, Optional	Request Body

Response Type

models.WxlanRule

Example Usage

ctx := context.Background()

orgId := uuid.MustParse("000000ab-00ab-00ab-00ab-0000000000ab")

body := models.WxlanRule{
    Action:               models.ToPointer(models.WxlanRuleActionEnum("allow")),
    ApplyTags:            []string{
        "c049dfcd-0c73-5014-1c64-062e9903f1e5",
    },
    BlockedApps:          []string{
        "mist",
        "all-videos",
    },
    DstAllowWxtags:       []string{
        "fff34466-eec0-3756-6765-381c728a6037",
        "eee2c7b0-d1d0-5a30-f349-e35fa43dc3b3",
    },
    DstDenyWxtags:        []string{
        "aaa34466-eec0-3756-6765-381c728a6037",
        "bbb2c7b0-d1d0-5a30-f349-e35fa43dc3b3",
    },
    Enabled:              models.ToPointer(true),
    Order:                1,
    SrcWxtags:            []string{
        "8bfc2490-d726-3587-038d-cb2e71bd2330",
        "3aa8e73f-9f46-d827-8d6a-567bb7e67fc9",
    },
}

apiResponse, err := orgsWxRules.CreateOrgWxRule(ctx, orgId, &body)
if err != nil {
    log.Fatalln(err)
} else {
    // Printing the result and response
    fmt.Println(apiResponse.Data)
    fmt.Println(apiResponse.Response.StatusCode)
}

Example Response (as JSON)

{
  "action": "allow",
  "apply_tags": [
    "c049dfcd-0c73-5014-1c64-062e9903f1e5"
  ],
  "blocked_apps": [
    "mist",
    "all-videos"
  ],
  "created_time": 0,
  "dst_allow_wxtags": [
    "fff34466-eec0-3756-6765-381c728a6037",
    "eee2c7b0-d1d0-5a30-f349-e35fa43dc3b3"
  ],
  "dst_deny_wxtags": [
    "aaa34466-eec0-3756-6765-381c728a6037",
    "bbb2c7b0-d1d0-5a30-f349-e35fa43dc3b3"
  ],
  "enabled": true,
  "for_site": true,
  "id": "497f6eca-6276-4993-9feb-53cbbbba6f08",
  "modified_time": 0,
  "order": 1,
  "org_id": "a40f5d1f-d889-42e9-94ea-b9b33585fc6b",
  "site_id": "72771e6a-6f5e-4de4-a5b9-1266c4197811",
  "src_wxtags": [
    "8bfc2490-d726-3587-038d-cb2e71bd2330",
    "3aa8e73f-9f46-d827-8d6a-567bb7e67fc9"
  ]
}

Errors

HTTP Status Code	Error Description	Exception Class
400	Bad Syntax	`ResponseHttp400Exception`
401	Unauthorized	`ResponseHttp401ErrorException`
403	Permission Denied	`ResponseHttp403ErrorException`
404	Not found. The API endpoint doesn’t exist or resource doesn’ t exist	`ResponseHttp404Exception`
429	Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold	`ResponseHttp429ErrorException`

Delete Org Wx Rule

Delete Org WxRule

DeleteOrgWxRule(
    ctx context.Context,
    orgId uuid.UUID,
    wxruleId uuid.UUID) (
    http.Response,
    error)

Parameters

Parameter	Type	Tags	Description
`orgId`	`uuid.UUID`	Template, Required	-
`wxruleId`	`uuid.UUID`	Template, Required	-

Response Type

``

Example Usage

ctx := context.Background()

orgId := uuid.MustParse("000000ab-00ab-00ab-00ab-0000000000ab")

wxruleId := uuid.MustParse("000000ab-00ab-00ab-00ab-0000000000ab")

resp, err := orgsWxRules.DeleteOrgWxRule(ctx, orgId, wxruleId)
if err != nil {
    log.Fatalln(err)
} else {
    fmt.Println(resp.StatusCode)
}

Errors

HTTP Status Code	Error Description	Exception Class
400	Bad Syntax	`ResponseHttp400Exception`
401	Unauthorized	`ResponseHttp401ErrorException`
403	Permission Denied	`ResponseHttp403ErrorException`
404	Not found. The API endpoint doesn’t exist or resource doesn’ t exist	`ResponseHttp404Exception`
429	Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold	`ResponseHttp429ErrorException`

Get Org Wx Rule

Get Org WxRule Details

GetOrgWxRule(
    ctx context.Context,
    orgId uuid.UUID,
    wxruleId uuid.UUID) (
    models.ApiResponse[models.WxlanRule],
    error)

Parameters

Parameter	Type	Tags	Description
`orgId`	`uuid.UUID`	Template, Required	-
`wxruleId`	`uuid.UUID`	Template, Required	-

Response Type

models.WxlanRule

Example Usage

ctx := context.Background()

orgId := uuid.MustParse("000000ab-00ab-00ab-00ab-0000000000ab")

wxruleId := uuid.MustParse("000000ab-00ab-00ab-00ab-0000000000ab")

apiResponse, err := orgsWxRules.GetOrgWxRule(ctx, orgId, wxruleId)
if err != nil {
    log.Fatalln(err)
} else {
    // Printing the result and response
    fmt.Println(apiResponse.Data)
    fmt.Println(apiResponse.Response.StatusCode)
}

Example Response (as JSON)

{
  "action": "allow",
  "apply_tags": [
    "c049dfcd-0c73-5014-1c64-062e9903f1e5"
  ],
  "blocked_apps": [
    "mist",
    "all-videos"
  ],
  "created_time": 0,
  "dst_allow_wxtags": [
    "fff34466-eec0-3756-6765-381c728a6037",
    "eee2c7b0-d1d0-5a30-f349-e35fa43dc3b3"
  ],
  "dst_deny_wxtags": [
    "aaa34466-eec0-3756-6765-381c728a6037",
    "bbb2c7b0-d1d0-5a30-f349-e35fa43dc3b3"
  ],
  "enabled": true,
  "for_site": true,
  "id": "497f6eca-6276-4993-9feb-53cbbbba6f08",
  "modified_time": 0,
  "order": 1,
  "org_id": "a40f5d1f-d889-42e9-94ea-b9b33585fc6b",
  "site_id": "72771e6a-6f5e-4de4-a5b9-1266c4197811",
  "src_wxtags": [
    "8bfc2490-d726-3587-038d-cb2e71bd2330",
    "3aa8e73f-9f46-d827-8d6a-567bb7e67fc9"
  ]
}

Errors

HTTP Status Code	Error Description	Exception Class
400	Bad Syntax	`ResponseHttp400Exception`
401	Unauthorized	`ResponseHttp401ErrorException`
403	Permission Denied	`ResponseHttp403ErrorException`
404	Not found. The API endpoint doesn’t exist or resource doesn’ t exist	`ResponseHttp404Exception`
429	Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold	`ResponseHttp429ErrorException`

List Org Wx Rules

Get List of Org WxRules

ListOrgWxRules(
    ctx context.Context,
    orgId uuid.UUID,
    limit *int,
    page *int) (
    models.ApiResponse[[]models.WxlanRule],
    error)

Parameters

Parameter	Type	Tags	Description
`orgId`	`uuid.UUID`	Template, Required	-
`limit`	`*int`	Query, Optional	Default: `100` Constraints: `>= 0`
`page`	`*int`	Query, Optional	Default: `1` Constraints: `>= 1`

Response Type

[]models.WxlanRule

Example Usage

ctx := context.Background()

orgId := uuid.MustParse("000000ab-00ab-00ab-00ab-0000000000ab")

limit := 100

page := 1

apiResponse, err := orgsWxRules.ListOrgWxRules(ctx, orgId, &limit, &page)
if err != nil {
    log.Fatalln(err)
} else {
    // Printing the result and response
    fmt.Println(apiResponse.Data)
    fmt.Println(apiResponse.Response.StatusCode)
}

Example Response (as JSON)

[
  {
    "action": "allow",
    "apply_tags": [
      "c049dfcd-0c73-5014-1c64-062e9903f1e5"
    ],
    "blocked_apps": [
      "mist",
      "all-videos"
    ],
    "created_time": 0,
    "dst_allow_wxtags": [
      "fff34466-eec0-3756-6765-381c728a6037",
      "eee2c7b0-d1d0-5a30-f349-e35fa43dc3b3"
    ],
    "dst_deny_wxtags": [
      "aaa34466-eec0-3756-6765-381c728a6037",
      "bbb2c7b0-d1d0-5a30-f349-e35fa43dc3b3"
    ],
    "enabled": true,
    "for_site": true,
    "id": "497f6eca-6276-4993-bfeb-53ebbbba6f08",
    "modified_time": 0,
    "order": 1,
    "org_id": "a40f5d1f-d889-42e9-94ea-b9b33585fc6b",
    "site_id": "72771e6a-6f5e-4de4-a5b9-1266c4197811",
    "src_wxtags": [
      "8bfc2490-d726-3587-038d-cb2e71bd2330",
      "3aa8e73f-9f46-d827-8d6a-567bb7e67fc9"
    ]
  }
]

Errors

HTTP Status Code	Error Description	Exception Class
400	Bad Syntax	`ResponseHttp400Exception`
401	Unauthorized	`ResponseHttp401ErrorException`
403	Permission Denied	`ResponseHttp403ErrorException`
404	Not found. The API endpoint doesn’t exist or resource doesn’ t exist	`ResponseHttp404Exception`
429	Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold	`ResponseHttp429ErrorException`

Update Org Wx Rule

Update Org WxRule

UpdateOrgWxRule(
    ctx context.Context,
    orgId uuid.UUID,
    wxruleId uuid.UUID,
    body *models.WxlanRule) (
    models.ApiResponse[models.WxlanRule],
    error)

Parameters

Parameter	Type	Tags	Description
`orgId`	`uuid.UUID`	Template, Required	-
`wxruleId`	`uuid.UUID`	Template, Required	-
`body`	`*models.WxlanRule`	Body, Optional	Request Body

Response Type

models.WxlanRule

Example Usage

ctx := context.Background()

orgId := uuid.MustParse("000000ab-00ab-00ab-00ab-0000000000ab")

wxruleId := uuid.MustParse("000000ab-00ab-00ab-00ab-0000000000ab")

body := models.WxlanRule{
    Action:               models.ToPointer(models.WxlanRuleActionEnum("allow")),
    ApplyTags:            []string{
        "c049dfcd-0c73-5014-1c64-062e9903f1e5",
    },
    BlockedApps:          []string{
        "mist",
        "all-videos",
    },
    DstAllowWxtags:       []string{
        "fff34466-eec0-3756-6765-381c728a6037",
        "eee2c7b0-d1d0-5a30-f349-e35fa43dc3b3",
    },
    DstDenyWxtags:        []string{
        "aaa34466-eec0-3756-6765-381c728a6037",
        "bbb2c7b0-d1d0-5a30-f349-e35fa43dc3b3",
    },
    Enabled:              models.ToPointer(true),
    Order:                1,
    SrcWxtags:            []string{
        "8bfc2490-d726-3587-038d-cb2e71bd2330",
        "3aa8e73f-9f46-d827-8d6a-567bb7e67fc9",
    },
}

apiResponse, err := orgsWxRules.UpdateOrgWxRule(ctx, orgId, wxruleId, &body)
if err != nil {
    log.Fatalln(err)
} else {
    // Printing the result and response
    fmt.Println(apiResponse.Data)
    fmt.Println(apiResponse.Response.StatusCode)
}

Example Response (as JSON)

{
  "action": "allow",
  "apply_tags": [
    "c049dfcd-0c73-5014-1c64-062e9903f1e5"
  ],
  "blocked_apps": [
    "mist",
    "all-videos"
  ],
  "created_time": 0,
  "dst_allow_wxtags": [
    "fff34466-eec0-3756-6765-381c728a6037",
    "eee2c7b0-d1d0-5a30-f349-e35fa43dc3b3"
  ],
  "dst_deny_wxtags": [
    "aaa34466-eec0-3756-6765-381c728a6037",
    "bbb2c7b0-d1d0-5a30-f349-e35fa43dc3b3"
  ],
  "enabled": true,
  "for_site": true,
  "id": "497f6eca-6276-4993-9feb-53cbbbba6f08",
  "modified_time": 0,
  "order": 1,
  "org_id": "a40f5d1f-d889-42e9-94ea-b9b33585fc6b",
  "site_id": "72771e6a-6f5e-4de4-a5b9-1266c4197811",
  "src_wxtags": [
    "8bfc2490-d726-3587-038d-cb2e71bd2330",
    "3aa8e73f-9f46-d827-8d6a-567bb7e67fc9"
  ]
}

Errors

HTTP Status Code	Error Description	Exception Class
400	Bad Syntax	`ResponseHttp400Exception`
401	Unauthorized	`ResponseHttp401ErrorException`
403	Permission Denied	`ResponseHttp403ErrorException`
404	Not found. The API endpoint doesn’t exist or resource doesn’ t exist	`ResponseHttp404Exception`
429	Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold	`ResponseHttp429ErrorException`

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

orgs-wx-rules.md

orgs-wx-rules.md

Orgs Wx Rules

Class Name

Methods

Create Org Wx Rule

Parameters

Response Type

Example Usage

Example Response (as JSON)

Errors

Delete Org Wx Rule

Parameters

Response Type

Example Usage

Errors

Get Org Wx Rule

Parameters

Response Type

Example Usage

Example Response (as JSON)

Errors

List Org Wx Rules

Parameters

Response Type

Example Usage

Example Response (as JSON)

Errors

Update Org Wx Rule

Parameters

Response Type

Example Usage

Example Response (as JSON)

Errors

Files

orgs-wx-rules.md

Latest commit

History

orgs-wx-rules.md

File metadata and controls

Orgs Wx Rules

Class Name

Methods

Create Org Wx Rule

Parameters

Response Type

Example Usage

Example Response (as JSON)

Errors

Delete Org Wx Rule

Parameters

Response Type

Example Usage

Errors

Get Org Wx Rule

Parameters

Response Type

Example Usage

Example Response (as JSON)

Errors

List Org Wx Rules

Parameters

Response Type

Example Usage

Example Response (as JSON)

Errors

Update Org Wx Rule

Parameters

Response Type

Example Usage

Example Response (as JSON)

Errors