Ready to level-up your engineering skills? Join a Pulumi Workshop. Register Now

getRealmKeys

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 data source may return more than one value.
  • If no key matches the filter criteria, then an error will be returned.

Using getRealmKeys

function getRealmKeys(args: GetRealmKeysArgs, opts?: InvokeOptions): Promise<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
func GetRealmKeys(ctx *Context, args *GetRealmKeysArgs, opts ...InvokeOption) (*GetRealmKeysResult, error)

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

public static class GetRealmKeys {
    public static Task<GetRealmKeysResult> InvokeAsync(GetRealmKeysArgs args, InvokeOptions? opts = null)
}

The following arguments are supported:

RealmId string

The realm from which the keys will be retrieved.

Algorithms List<string>

When specified, keys will be filtered by algorithm. The algorithms can be any of HS256, RS256,AES, etc.

Statuses List<string>

When specified, keys will be filtered by status. The statuses can be any of ACTIVE, DISABLED and PASSIVE.

RealmId string

The realm from which the keys will be retrieved.

Algorithms []string

When specified, keys will be filtered by algorithm. The algorithms can be any of HS256, RS256,AES, etc.

Statuses []string

When specified, keys will be filtered by status. The statuses can be any of ACTIVE, DISABLED and PASSIVE.

realmId string

The realm from which the keys will be retrieved.

algorithms string[]

When specified, keys will be filtered by algorithm. The algorithms can be any of HS256, RS256,AES, etc.

statuses string[]

When specified, keys will be filtered by status. The statuses can be any of ACTIVE, DISABLED and PASSIVE.

realm_id str

The realm from which the keys will be retrieved.

algorithms Sequence[str]

When specified, keys will be filtered by algorithm. The algorithms can be any of HS256, RS256,AES, etc.

statuses Sequence[str]

When specified, keys will be filtered by status. The statuses can be any of ACTIVE, DISABLED and PASSIVE.

getRealmKeys Result

The following output properties are available:

Id string

The provider-assigned unique ID for this managed resource.

Keys List<GetRealmKeysKey>

(Computed) A list of keys that match the filter criteria. Each key has the following attributes:

RealmId string
Algorithms List<string>
Statuses List<string>

Key status (string)

Id string

The provider-assigned unique ID for this managed resource.

Keys []GetRealmKeysKey

(Computed) A list of keys that match the filter criteria. Each key has the following attributes:

RealmId string
Algorithms []string
Statuses []string

Key status (string)

id string

The provider-assigned unique ID for this managed resource.

keys GetRealmKeysKey[]

(Computed) A list of keys that match the filter criteria. Each key has the following attributes:

realmId string
algorithms string[]
statuses string[]

Key status (string)

id str

The provider-assigned unique ID for this managed resource.

keys Sequence[GetRealmKeysKey]

(Computed) A list of keys that match the filter criteria. Each key has the following attributes:

realm_id str
algorithms Sequence[str]
statuses Sequence[str]

Key status (string)

Supporting Types

GetRealmKeysKey

Algorithm string

Key algorithm (string)

Certificate string

Key certificate (string)

Kid string

Key ID (string)

ProviderId string

Key provider ID (string)

ProviderPriority int

Key provider priority (int64)

PublicKey string

Key public key (string)

Status string

When specified, keys will be filtered by status. The statuses can be any of ACTIVE, DISABLED and PASSIVE.

Type string

Key type (string)

Algorithm string

Key algorithm (string)

Certificate string

Key certificate (string)

Kid string

Key ID (string)

ProviderId string

Key provider ID (string)

ProviderPriority int

Key provider priority (int64)

PublicKey string

Key public key (string)

Status string

When specified, keys will be filtered by status. The statuses can be any of ACTIVE, DISABLED and PASSIVE.

Type string

Key type (string)

algorithm string

Key algorithm (string)

certificate string

Key certificate (string)

kid string

Key ID (string)

providerId string

Key provider ID (string)

providerPriority number

Key provider priority (int64)

publicKey string

Key public key (string)

status string

When specified, keys will be filtered by status. The statuses can be any of ACTIVE, DISABLED and PASSIVE.

type string

Key type (string)

algorithm str

Key algorithm (string)

certificate str

Key certificate (string)

kid str

Key ID (string)

provider_id str

Key provider ID (string)

provider_priority int

Key provider priority (int64)

public_key str

Key public key (string)

status str

When specified, keys will be filtered by status. The statuses can be any of ACTIVE, DISABLED and PASSIVE.

type str

Key type (string)

Package Details

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