1. Packages
  2. Keycloak
  3. API Docs
  4. getRealmKeys
Keycloak v5.3.1 published on Monday, Mar 11, 2024 by Pulumi

keycloak.getRealmKeys

Explore with Pulumi AI

keycloak logo
Keycloak v5.3.1 published on Monday, Mar 11, 2024 by Pulumi

    # keycloak.getRealmKeys data source

    Use this data source to get the keys of a realm. Keys can be filtered by algorithm and status.

    Remarks:

    • A key must meet all filter criteria
    • This datasource may return more than one value.
    • If no key matches the filter criteria, then an error is returned.

    Using getRealmKeys

    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 getRealmKeys(args: GetRealmKeysArgs, opts?: InvokeOptions): Promise<GetRealmKeysResult>
    function getRealmKeysOutput(args: GetRealmKeysOutputArgs, opts?: InvokeOptions): Output<GetRealmKeysResult>
    def get_realm_keys(algorithms: Optional[Sequence[str]] = None,
                       realm_id: Optional[str] = None,
                       statuses: Optional[Sequence[str]] = None,
                       opts: Optional[InvokeOptions] = None) -> GetRealmKeysResult
    def get_realm_keys_output(algorithms: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                       realm_id: Optional[pulumi.Input[str]] = None,
                       statuses: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetRealmKeysResult]
    func GetRealmKeys(ctx *Context, args *GetRealmKeysArgs, opts ...InvokeOption) (*GetRealmKeysResult, error)
    func GetRealmKeysOutput(ctx *Context, args *GetRealmKeysOutputArgs, opts ...InvokeOption) GetRealmKeysResultOutput

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

    public static class GetRealmKeys 
    {
        public static Task<GetRealmKeysResult> InvokeAsync(GetRealmKeysArgs args, InvokeOptions? opts = null)
        public static Output<GetRealmKeysResult> Invoke(GetRealmKeysInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetRealmKeysResult> getRealmKeys(GetRealmKeysArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: keycloak:index/getRealmKeys:getRealmKeys
      arguments:
        # arguments dictionary

    The following arguments are supported:

    RealmId string
    Algorithms List<string>
    Statuses List<string>
    RealmId string
    Algorithms []string
    Statuses []string
    realmId String
    algorithms List<String>
    statuses List<String>
    realmId string
    algorithms string[]
    statuses string[]
    realm_id str
    algorithms Sequence[str]
    statuses Sequence[str]
    realmId String
    algorithms List<String>
    statuses List<String>

    getRealmKeys Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    Keys List<GetRealmKeysKey>
    RealmId string
    Algorithms List<string>
    Statuses List<string>
    Id string
    The provider-assigned unique ID for this managed resource.
    Keys []GetRealmKeysKey
    RealmId string
    Algorithms []string
    Statuses []string
    id String
    The provider-assigned unique ID for this managed resource.
    keys List<GetRealmKeysKey>
    realmId String
    algorithms List<String>
    statuses List<String>
    id string
    The provider-assigned unique ID for this managed resource.
    keys GetRealmKeysKey[]
    realmId string
    algorithms string[]
    statuses string[]
    id str
    The provider-assigned unique ID for this managed resource.
    keys Sequence[GetRealmKeysKey]
    realm_id str
    algorithms Sequence[str]
    statuses Sequence[str]
    id String
    The provider-assigned unique ID for this managed resource.
    keys List<Property Map>
    realmId String
    algorithms List<String>
    statuses List<String>

    Supporting Types

    GetRealmKeysKey

    Algorithm string
    Certificate string
    Kid string
    ProviderId string
    ProviderPriority int
    PublicKey string
    Status string
    Type string
    Algorithm string
    Certificate string
    Kid string
    ProviderId string
    ProviderPriority int
    PublicKey string
    Status string
    Type string
    algorithm String
    certificate String
    kid String
    providerId String
    providerPriority Integer
    publicKey String
    status String
    type String
    algorithm string
    certificate string
    kid string
    providerId string
    providerPriority number
    publicKey string
    status string
    type string
    algorithm String
    certificate String
    kid String
    providerId String
    providerPriority Number
    publicKey String
    status String
    type String

    Package Details

    Repository
    Keycloak pulumi/pulumi-keycloak
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the keycloak Terraform Provider.
    keycloak logo
    Keycloak v5.3.1 published on Monday, Mar 11, 2024 by Pulumi