GetRealmKeys

# 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.

Argument Reference

The following arguments are supported:

  • realm_id - (Required) The realm of which the keys are retrieved.
  • algorithms - (Optional) When specified, keys are filtered by algorithm (values for algorithm: HS256, RS256,AES, …)
  • status - (Optional) When specified, keys are filtered by status (values for status: ACTIVE, DISABLED and PASSIVE)

Using GetRealmKeys

function getRealmKeys(args: GetRealmKeysArgs, opts?: InvokeOptions): Promise<GetRealmKeysResult>
function  get_realm_keys(algorithms=None, realm_id=None, statuses=None, opts=None)
func GetRealmKeys(ctx *Context, args *GetRealmKeysArgs, opts ...InvokeOption) (*GetRealmKeysResult, error)
public static class GetRealmKeys {
    public static Task<GetRealmKeysResult> InvokeAsync(GetRealmKeysArgs args, InvokeOptions? opts = null)
}

The following arguments are supported:

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

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 GetRealmKeysKey[]
realmId string
algorithms string[]
statuses string[]
id str

The provider-assigned unique ID for this managed resource.

keys List[GetRealmKeysKey]
realm_id str
algorithms List[str]
statuses List[str]

Supporting Types

GetRealmKeysKey

See the output API doc for this type.

See the output API doc for this type.

See the output API doc for this type.

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 number
publicKey string
status string
type string
algorithm str
certificate str
kid str
providerPriority float
provider_id str
publicKey str
status str
type str

Package Details

Repository
https://github.com/pulumi/pulumi-keycloak
License
Apache-2.0
Notes
This Pulumi package is based on the keycloak Terraform Provider.