GetClient

# keycloak.openid.Client data source

This data source can be used to fetch properties of a Keycloak OpenID client for usage with other resources.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as keycloak from "@pulumi/keycloak";

const realmManagement = keycloak.openid.getClient({
    realmId: "my-realm",
    clientId: "realm-management",
});
const admin = realmManagement.then(realmManagement => keycloak.getRole({
    realmId: "my-realm",
    clientId: realmManagement.id,
    name: "realm-admin",
}));
import pulumi
import pulumi_keycloak as keycloak

realm_management = keycloak.openid.get_client(realm_id="my-realm",
    client_id="realm-management")
admin = keycloak.get_role(realm_id="my-realm",
    client_id=realm_management.id,
    name="realm-admin")
using Pulumi;
using Keycloak = Pulumi.Keycloak;

class MyStack : Stack
{
    public MyStack()
    {
        var realmManagement = Output.Create(Keycloak.OpenId.GetClient.InvokeAsync(new Keycloak.OpenId.GetClientArgs
        {
            RealmId = "my-realm",
            ClientId = "realm-management",
        }));
        var admin = realmManagement.Apply(realmManagement => Output.Create(Keycloak.GetRole.InvokeAsync(new Keycloak.GetRoleArgs
        {
            RealmId = "my-realm",
            ClientId = realmManagement.Id,
            Name = "realm-admin",
        })));
    }

}

Argument Reference

The following arguments are supported:

  • realm_id - (Required) The realm id.
  • client_id - (Required) The client id.

Attributes Reference

See the docs for the keycloak.openid.Client resource for details on the exported attributes.

Using GetClient

function getClient(args: GetClientArgs, opts?: InvokeOptions): Promise<GetClientResult>
function  get_client(client_id=None, realm_id=None, opts=None)
func LookupClient(ctx *Context, args *LookupClientArgs, opts ...InvokeOption) (*LookupClientResult, error)

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

public static class GetClient {
    public static Task<GetClientResult> InvokeAsync(GetClientArgs args, InvokeOptions? opts = null)
}

The following arguments are supported:

ClientId string
RealmId string
ClientId string
RealmId string
clientId string
realmId string
client_id str
realm_id str

GetClient Result

The following output properties are available:

AccessType string
AuthenticationFlowBindingOverrides GetClientAuthenticationFlowBindingOverrides
Authorization GetClientAuthorization
ClientId string
ClientSecret string
ConsentRequired bool
Description string
DirectAccessGrantsEnabled bool
Enabled bool
FullScopeAllowed bool
Id string

The provider-assigned unique ID for this managed resource.

ImplicitFlowEnabled bool
LoginTheme string
Name string
RealmId string
ResourceServerId string
RootUrl string
ServiceAccountUserId string
ServiceAccountsEnabled bool
StandardFlowEnabled bool
ValidRedirectUris List<string>
WebOrigins List<string>
AccessType string
AuthenticationFlowBindingOverrides GetClientAuthenticationFlowBindingOverrides
Authorization GetClientAuthorization
ClientId string
ClientSecret string
ConsentRequired bool
Description string
DirectAccessGrantsEnabled bool
Enabled bool
FullScopeAllowed bool
Id string

The provider-assigned unique ID for this managed resource.

ImplicitFlowEnabled bool
LoginTheme string
Name string
RealmId string
ResourceServerId string
RootUrl string
ServiceAccountUserId string
ServiceAccountsEnabled bool
StandardFlowEnabled bool
ValidRedirectUris []string
WebOrigins []string
accessType string
authenticationFlowBindingOverrides GetClientAuthenticationFlowBindingOverrides
authorization GetClientAuthorization
clientId string
clientSecret string
consentRequired boolean
description string
directAccessGrantsEnabled boolean
enabled boolean
fullScopeAllowed boolean
id string

The provider-assigned unique ID for this managed resource.

implicitFlowEnabled boolean
loginTheme string
name string
realmId string
resourceServerId string
rootUrl string
serviceAccountUserId string
serviceAccountsEnabled boolean
standardFlowEnabled boolean
validRedirectUris string[]
webOrigins string[]
access_type str
authentication_flow_binding_overrides Dict[GetClientAuthenticationFlowBindingOverrides]
authorization Dict[GetClientAuthorization]
client_id str
client_secret str
consent_required bool
description str
direct_access_grants_enabled bool
enabled bool
full_scope_allowed bool
id str

The provider-assigned unique ID for this managed resource.

implicit_flow_enabled bool
login_theme str
name str
realm_id str
resource_server_id str
root_url str
service_account_user_id str
service_accounts_enabled bool
standard_flow_enabled bool
valid_redirect_uris List[str]
web_origins List[str]

Supporting Types

GetClientAuthenticationFlowBindingOverrides

See the output API doc for this type.

See the output API doc for this type.

See the output API doc for this type.

BrowserId string
DirectGrantId string
BrowserId string
DirectGrantId string
browserId string
directGrantId string
browserId str
directGrantId str

GetClientAuthorization

See the output API doc for this type.

See the output API doc for this type.

See the output API doc for this type.

AllowRemoteResourceManagement bool
PolicyEnforcementMode string
AllowRemoteResourceManagement bool
PolicyEnforcementMode string
allowRemoteResourceManagement boolean
policyEnforcementMode string
allowRemoteResourceManagement bool
policyEnforcementMode 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.