1. Packages
  2. Cisco Meraki
  3. API Docs
  4. getOrganizations
Cisco Meraki v0.2.10 published on Wednesday, Jul 24, 2024 by Pulumi

meraki.getOrganizations

Explore with Pulumi AI

meraki logo
Cisco Meraki v0.2.10 published on Wednesday, Jul 24, 2024 by Pulumi

    Example Usage

    Using getOrganizations

    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 getOrganizations(args: GetOrganizationsArgs, opts?: InvokeOptions): Promise<GetOrganizationsResult>
    function getOrganizationsOutput(args: GetOrganizationsOutputArgs, opts?: InvokeOptions): Output<GetOrganizationsResult>
    def get_organizations(ending_before: Optional[str] = None,
                          organization_id: Optional[str] = None,
                          per_page: Optional[int] = None,
                          starting_after: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetOrganizationsResult
    def get_organizations_output(ending_before: Optional[pulumi.Input[str]] = None,
                          organization_id: Optional[pulumi.Input[str]] = None,
                          per_page: Optional[pulumi.Input[int]] = None,
                          starting_after: Optional[pulumi.Input[str]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetOrganizationsResult]
    func GetOrganizations(ctx *Context, args *GetOrganizationsArgs, opts ...InvokeOption) (*GetOrganizationsResult, error)
    func GetOrganizationsOutput(ctx *Context, args *GetOrganizationsOutputArgs, opts ...InvokeOption) GetOrganizationsResultOutput

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

    public static class GetOrganizations 
    {
        public static Task<GetOrganizationsResult> InvokeAsync(GetOrganizationsArgs args, InvokeOptions? opts = null)
        public static Output<GetOrganizationsResult> Invoke(GetOrganizationsInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetOrganizationsResult> getOrganizations(GetOrganizationsArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: meraki:index/getOrganizations:getOrganizations
      arguments:
        # arguments dictionary

    The following arguments are supported:

    EndingBefore string
    endingBefore query parameter. A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.
    OrganizationId string
    organizationId path parameter. Organization ID
    PerPage int
    perPage query parameter. The number of entries per page returned. Acceptable range is 3 9000. Default is 9000.
    StartingAfter string
    startingAfter query parameter. A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.
    EndingBefore string
    endingBefore query parameter. A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.
    OrganizationId string
    organizationId path parameter. Organization ID
    PerPage int
    perPage query parameter. The number of entries per page returned. Acceptable range is 3 9000. Default is 9000.
    StartingAfter string
    startingAfter query parameter. A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.
    endingBefore String
    endingBefore query parameter. A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.
    organizationId String
    organizationId path parameter. Organization ID
    perPage Integer
    perPage query parameter. The number of entries per page returned. Acceptable range is 3 9000. Default is 9000.
    startingAfter String
    startingAfter query parameter. A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.
    endingBefore string
    endingBefore query parameter. A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.
    organizationId string
    organizationId path parameter. Organization ID
    perPage number
    perPage query parameter. The number of entries per page returned. Acceptable range is 3 9000. Default is 9000.
    startingAfter string
    startingAfter query parameter. A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.
    ending_before str
    endingBefore query parameter. A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.
    organization_id str
    organizationId path parameter. Organization ID
    per_page int
    perPage query parameter. The number of entries per page returned. Acceptable range is 3 9000. Default is 9000.
    starting_after str
    startingAfter query parameter. A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.
    endingBefore String
    endingBefore query parameter. A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.
    organizationId String
    organizationId path parameter. Organization ID
    perPage Number
    perPage query parameter. The number of entries per page returned. Acceptable range is 3 9000. Default is 9000.
    startingAfter String
    startingAfter query parameter. A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.

    getOrganizations Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    Item GetOrganizationsItem
    Items List<GetOrganizationsItem>
    Array of ResponseOrganizationsGetOrganizations
    EndingBefore string
    endingBefore query parameter. A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.
    OrganizationId string
    organizationId path parameter. Organization ID
    PerPage int
    perPage query parameter. The number of entries per page returned. Acceptable range is 3 9000. Default is 9000.
    StartingAfter string
    startingAfter query parameter. A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.
    Id string
    The provider-assigned unique ID for this managed resource.
    Item GetOrganizationsItem
    Items []GetOrganizationsItem
    Array of ResponseOrganizationsGetOrganizations
    EndingBefore string
    endingBefore query parameter. A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.
    OrganizationId string
    organizationId path parameter. Organization ID
    PerPage int
    perPage query parameter. The number of entries per page returned. Acceptable range is 3 9000. Default is 9000.
    StartingAfter string
    startingAfter query parameter. A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.
    id String
    The provider-assigned unique ID for this managed resource.
    item GetOrganizationsItem
    items List<GetOrganizationsItem>
    Array of ResponseOrganizationsGetOrganizations
    endingBefore String
    endingBefore query parameter. A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.
    organizationId String
    organizationId path parameter. Organization ID
    perPage Integer
    perPage query parameter. The number of entries per page returned. Acceptable range is 3 9000. Default is 9000.
    startingAfter String
    startingAfter query parameter. A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.
    id string
    The provider-assigned unique ID for this managed resource.
    item GetOrganizationsItem
    items GetOrganizationsItem[]
    Array of ResponseOrganizationsGetOrganizations
    endingBefore string
    endingBefore query parameter. A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.
    organizationId string
    organizationId path parameter. Organization ID
    perPage number
    perPage query parameter. The number of entries per page returned. Acceptable range is 3 9000. Default is 9000.
    startingAfter string
    startingAfter query parameter. A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.
    id str
    The provider-assigned unique ID for this managed resource.
    item GetOrganizationsItem
    items Sequence[GetOrganizationsItem]
    Array of ResponseOrganizationsGetOrganizations
    ending_before str
    endingBefore query parameter. A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.
    organization_id str
    organizationId path parameter. Organization ID
    per_page int
    perPage query parameter. The number of entries per page returned. Acceptable range is 3 9000. Default is 9000.
    starting_after str
    startingAfter query parameter. A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.
    id String
    The provider-assigned unique ID for this managed resource.
    item Property Map
    items List<Property Map>
    Array of ResponseOrganizationsGetOrganizations
    endingBefore String
    endingBefore query parameter. A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.
    organizationId String
    organizationId path parameter. Organization ID
    perPage Number
    perPage query parameter. The number of entries per page returned. Acceptable range is 3 9000. Default is 9000.
    startingAfter String
    startingAfter query parameter. A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.

    Supporting Types

    GetOrganizationsItem

    Api GetOrganizationsItemApi
    API related settings
    Cloud GetOrganizationsItemCloud
    Data for this organization
    Id string
    Organization ID
    Licensing GetOrganizationsItemLicensing
    Licensing related settings
    Management GetOrganizationsItemManagement
    Information about the organization's management system
    Name string
    Organization name
    Url string
    Organization URL
    Api GetOrganizationsItemApi
    API related settings
    Cloud GetOrganizationsItemCloud
    Data for this organization
    Id string
    Organization ID
    Licensing GetOrganizationsItemLicensing
    Licensing related settings
    Management GetOrganizationsItemManagement
    Information about the organization's management system
    Name string
    Organization name
    Url string
    Organization URL
    api GetOrganizationsItemApi
    API related settings
    cloud GetOrganizationsItemCloud
    Data for this organization
    id String
    Organization ID
    licensing GetOrganizationsItemLicensing
    Licensing related settings
    management GetOrganizationsItemManagement
    Information about the organization's management system
    name String
    Organization name
    url String
    Organization URL
    api GetOrganizationsItemApi
    API related settings
    cloud GetOrganizationsItemCloud
    Data for this organization
    id string
    Organization ID
    licensing GetOrganizationsItemLicensing
    Licensing related settings
    management GetOrganizationsItemManagement
    Information about the organization's management system
    name string
    Organization name
    url string
    Organization URL
    api GetOrganizationsItemApi
    API related settings
    cloud GetOrganizationsItemCloud
    Data for this organization
    id str
    Organization ID
    licensing GetOrganizationsItemLicensing
    Licensing related settings
    management GetOrganizationsItemManagement
    Information about the organization's management system
    name str
    Organization name
    url str
    Organization URL
    api Property Map
    API related settings
    cloud Property Map
    Data for this organization
    id String
    Organization ID
    licensing Property Map
    Licensing related settings
    management Property Map
    Information about the organization's management system
    name String
    Organization name
    url String
    Organization URL

    GetOrganizationsItemApi

    Enabled bool
    Enable API access
    Enabled bool
    Enable API access
    enabled Boolean
    Enable API access
    enabled boolean
    Enable API access
    enabled bool
    Enable API access
    enabled Boolean
    Enable API access

    GetOrganizationsItemCloud

    region Property Map
    Region info

    GetOrganizationsItemCloudRegion

    Name string
    Name of region
    Name string
    Name of region
    name String
    Name of region
    name string
    Name of region
    name str
    Name of region
    name String
    Name of region

    GetOrganizationsItemLicensing

    Model string
    Organization licensing model. Can be 'co-term', 'per-device', or 'subscription'.
    Model string
    Organization licensing model. Can be 'co-term', 'per-device', or 'subscription'.
    model String
    Organization licensing model. Can be 'co-term', 'per-device', or 'subscription'.
    model string
    Organization licensing model. Can be 'co-term', 'per-device', or 'subscription'.
    model str
    Organization licensing model. Can be 'co-term', 'per-device', or 'subscription'.
    model String
    Organization licensing model. Can be 'co-term', 'per-device', or 'subscription'.

    GetOrganizationsItemManagement

    Details List<GetOrganizationsItemManagementDetail>
    Details related to organization management, possibly empty. Details may be named 'MSP ID', 'IP restriction mode for API', or 'IP restriction mode for dashboard', if the organization admin has configured any.
    Details []GetOrganizationsItemManagementDetail
    Details related to organization management, possibly empty. Details may be named 'MSP ID', 'IP restriction mode for API', or 'IP restriction mode for dashboard', if the organization admin has configured any.
    details List<GetOrganizationsItemManagementDetail>
    Details related to organization management, possibly empty. Details may be named 'MSP ID', 'IP restriction mode for API', or 'IP restriction mode for dashboard', if the organization admin has configured any.
    details GetOrganizationsItemManagementDetail[]
    Details related to organization management, possibly empty. Details may be named 'MSP ID', 'IP restriction mode for API', or 'IP restriction mode for dashboard', if the organization admin has configured any.
    details Sequence[GetOrganizationsItemManagementDetail]
    Details related to organization management, possibly empty. Details may be named 'MSP ID', 'IP restriction mode for API', or 'IP restriction mode for dashboard', if the organization admin has configured any.
    details List<Property Map>
    Details related to organization management, possibly empty. Details may be named 'MSP ID', 'IP restriction mode for API', or 'IP restriction mode for dashboard', if the organization admin has configured any.

    GetOrganizationsItemManagementDetail

    Name string
    Name of management data
    Value string
    Value of management data
    Name string
    Name of management data
    Value string
    Value of management data
    name String
    Name of management data
    value String
    Value of management data
    name string
    Name of management data
    value string
    Value of management data
    name str
    Name of management data
    value str
    Value of management data
    name String
    Name of management data
    value String
    Value of management data

    Package Details

    Repository
    meraki pulumi/pulumi-meraki
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the meraki Terraform Provider.
    meraki logo
    Cisco Meraki v0.2.10 published on Wednesday, Jul 24, 2024 by Pulumi