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
LookupClientin the Go SDK.
public static class GetClient {
public static Task<GetClientResult> InvokeAsync(GetClientArgs args, InvokeOptions? opts = null)
}The following arguments are supported:
GetClient Result
The following output properties are available:
- Access
Type string - Authentication
Flow GetBinding Overrides Client Authentication Flow Binding Overrides -
Get
Client Authorization - Client
Id string - Client
Secret string - Consent
Required bool - Description string
- Direct
Access boolGrants Enabled - Enabled bool
- Full
Scope boolAllowed - Id string
The provider-assigned unique ID for this managed resource.
- Implicit
Flow boolEnabled - Login
Theme string - Name string
- Realm
Id string - Resource
Server stringId - Root
Url string - Service
Account stringUser Id - Service
Accounts boolEnabled - Standard
Flow boolEnabled - Valid
Redirect List<string>Uris - Web
Origins List<string>
- Access
Type string - Authentication
Flow GetBinding Overrides Client Authentication Flow Binding Overrides -
Get
Client Authorization - Client
Id string - Client
Secret string - Consent
Required bool - Description string
- Direct
Access boolGrants Enabled - Enabled bool
- Full
Scope boolAllowed - Id string
The provider-assigned unique ID for this managed resource.
- Implicit
Flow boolEnabled - Login
Theme string - Name string
- Realm
Id string - Resource
Server stringId - Root
Url string - Service
Account stringUser Id - Service
Accounts boolEnabled - Standard
Flow boolEnabled - Valid
Redirect []stringUris - Web
Origins []string
- access
Type string - authentication
Flow GetBinding Overrides Client Authentication Flow Binding Overrides -
Get
Client Authorization - client
Id string - client
Secret string - consent
Required boolean - description string
- direct
Access booleanGrants Enabled - enabled boolean
- full
Scope booleanAllowed - id string
The provider-assigned unique ID for this managed resource.
- implicit
Flow booleanEnabled - login
Theme string - name string
- realm
Id string - resource
Server stringId - root
Url string - service
Account stringUser Id - service
Accounts booleanEnabled - standard
Flow booleanEnabled - valid
Redirect string[]Uris - web
Origins string[]
- access_
type str - authentication_
flow_ Dict[Getbinding_ overrides Client Authentication Flow Binding Overrides] -
Dict[Get
Client Authorization] - client_
id str - client_
secret str - consent_
required bool - description str
- direct_
access_ boolgrants_ enabled - enabled bool
- full_
scope_ boolallowed - id str
The provider-assigned unique ID for this managed resource.
- implicit_
flow_ boolenabled - login_
theme str - name str
- realm_
id str - resource_
server_ strid - root_
url str - service_
account_ struser_ id - service_
accounts_ boolenabled - standard_
flow_ boolenabled - valid_
redirect_ List[str]uris - 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.
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.
Package Details
- Repository
- https://github.com/pulumi/pulumi-keycloak
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
keycloakTerraform Provider.