com.pulumi.azure.appservice.outputs.LinuxWebAppAuthSettingsV2CustomOidcV2 Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of azure Show documentation
Show all versions of azure Show documentation
A Pulumi package for creating and managing Microsoft Azure cloud resources, based on the Terraform azurerm provider. We recommend using the [Azure Native provider](https://github.com/pulumi/pulumi-azure-native) to provision Azure infrastructure. Azure Native provides complete coverage of Azure resources and same-day access to new resources and resource updates.
// *** WARNING: this file was generated by pulumi-java-gen. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
package com.pulumi.azure.appservice.outputs;
import com.pulumi.core.annotations.CustomType;
import com.pulumi.exceptions.MissingRequiredPropertyException;
import java.lang.String;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import javax.annotation.Nullable;
@CustomType
public final class LinuxWebAppAuthSettingsV2CustomOidcV2 {
/**
* @return The endpoint to make the Authorisation Request as supplied by `openid_configuration_endpoint` response.
*
*/
private @Nullable String authorisationEndpoint;
/**
* @return The endpoint that provides the keys necessary to validate the token as supplied by `openid_configuration_endpoint` response.
*
*/
private @Nullable String certificationUri;
/**
* @return The Client Credential Method used.
*
*/
private @Nullable String clientCredentialMethod;
/**
* @return The ID of the Client to use to authenticate with the Custom OIDC.
*
*/
private String clientId;
/**
* @return The App Setting name that contains the secret for this Custom OIDC Client. This is generated from `name` above and suffixed with `_PROVIDER_AUTHENTICATION_SECRET`.
*
*/
private @Nullable String clientSecretSettingName;
/**
* @return The endpoint that issued the Token as supplied by `openid_configuration_endpoint` response.
*
*/
private @Nullable String issuerEndpoint;
/**
* @return The name of the Custom OIDC Authentication Provider.
*
* > **NOTE:** An `app_setting` matching this value in upper case with the suffix of `_PROVIDER_AUTHENTICATION_SECRET` is required. e.g. `MYOIDC_PROVIDER_AUTHENTICATION_SECRET` for a value of `myoidc`.
*
*/
private String name;
/**
* @return The name of the claim that contains the users name.
*
*/
private @Nullable String nameClaimType;
/**
* @return Specifies the endpoint used for OpenID Connect Discovery. For example `https://example.com/.well-known/openid-configuration`.
*
*/
private String openidConfigurationEndpoint;
/**
* @return The list of the scopes that should be requested while authenticating.
*
*/
private @Nullable List scopes;
/**
* @return The endpoint used to request a Token as supplied by `openid_configuration_endpoint` response.
*
*/
private @Nullable String tokenEndpoint;
private LinuxWebAppAuthSettingsV2CustomOidcV2() {}
/**
* @return The endpoint to make the Authorisation Request as supplied by `openid_configuration_endpoint` response.
*
*/
public Optional authorisationEndpoint() {
return Optional.ofNullable(this.authorisationEndpoint);
}
/**
* @return The endpoint that provides the keys necessary to validate the token as supplied by `openid_configuration_endpoint` response.
*
*/
public Optional certificationUri() {
return Optional.ofNullable(this.certificationUri);
}
/**
* @return The Client Credential Method used.
*
*/
public Optional clientCredentialMethod() {
return Optional.ofNullable(this.clientCredentialMethod);
}
/**
* @return The ID of the Client to use to authenticate with the Custom OIDC.
*
*/
public String clientId() {
return this.clientId;
}
/**
* @return The App Setting name that contains the secret for this Custom OIDC Client. This is generated from `name` above and suffixed with `_PROVIDER_AUTHENTICATION_SECRET`.
*
*/
public Optional clientSecretSettingName() {
return Optional.ofNullable(this.clientSecretSettingName);
}
/**
* @return The endpoint that issued the Token as supplied by `openid_configuration_endpoint` response.
*
*/
public Optional issuerEndpoint() {
return Optional.ofNullable(this.issuerEndpoint);
}
/**
* @return The name of the Custom OIDC Authentication Provider.
*
* > **NOTE:** An `app_setting` matching this value in upper case with the suffix of `_PROVIDER_AUTHENTICATION_SECRET` is required. e.g. `MYOIDC_PROVIDER_AUTHENTICATION_SECRET` for a value of `myoidc`.
*
*/
public String name() {
return this.name;
}
/**
* @return The name of the claim that contains the users name.
*
*/
public Optional nameClaimType() {
return Optional.ofNullable(this.nameClaimType);
}
/**
* @return Specifies the endpoint used for OpenID Connect Discovery. For example `https://example.com/.well-known/openid-configuration`.
*
*/
public String openidConfigurationEndpoint() {
return this.openidConfigurationEndpoint;
}
/**
* @return The list of the scopes that should be requested while authenticating.
*
*/
public List scopes() {
return this.scopes == null ? List.of() : this.scopes;
}
/**
* @return The endpoint used to request a Token as supplied by `openid_configuration_endpoint` response.
*
*/
public Optional tokenEndpoint() {
return Optional.ofNullable(this.tokenEndpoint);
}
public static Builder builder() {
return new Builder();
}
public static Builder builder(LinuxWebAppAuthSettingsV2CustomOidcV2 defaults) {
return new Builder(defaults);
}
@CustomType.Builder
public static final class Builder {
private @Nullable String authorisationEndpoint;
private @Nullable String certificationUri;
private @Nullable String clientCredentialMethod;
private String clientId;
private @Nullable String clientSecretSettingName;
private @Nullable String issuerEndpoint;
private String name;
private @Nullable String nameClaimType;
private String openidConfigurationEndpoint;
private @Nullable List scopes;
private @Nullable String tokenEndpoint;
public Builder() {}
public Builder(LinuxWebAppAuthSettingsV2CustomOidcV2 defaults) {
Objects.requireNonNull(defaults);
this.authorisationEndpoint = defaults.authorisationEndpoint;
this.certificationUri = defaults.certificationUri;
this.clientCredentialMethod = defaults.clientCredentialMethod;
this.clientId = defaults.clientId;
this.clientSecretSettingName = defaults.clientSecretSettingName;
this.issuerEndpoint = defaults.issuerEndpoint;
this.name = defaults.name;
this.nameClaimType = defaults.nameClaimType;
this.openidConfigurationEndpoint = defaults.openidConfigurationEndpoint;
this.scopes = defaults.scopes;
this.tokenEndpoint = defaults.tokenEndpoint;
}
@CustomType.Setter
public Builder authorisationEndpoint(@Nullable String authorisationEndpoint) {
this.authorisationEndpoint = authorisationEndpoint;
return this;
}
@CustomType.Setter
public Builder certificationUri(@Nullable String certificationUri) {
this.certificationUri = certificationUri;
return this;
}
@CustomType.Setter
public Builder clientCredentialMethod(@Nullable String clientCredentialMethod) {
this.clientCredentialMethod = clientCredentialMethod;
return this;
}
@CustomType.Setter
public Builder clientId(String clientId) {
if (clientId == null) {
throw new MissingRequiredPropertyException("LinuxWebAppAuthSettingsV2CustomOidcV2", "clientId");
}
this.clientId = clientId;
return this;
}
@CustomType.Setter
public Builder clientSecretSettingName(@Nullable String clientSecretSettingName) {
this.clientSecretSettingName = clientSecretSettingName;
return this;
}
@CustomType.Setter
public Builder issuerEndpoint(@Nullable String issuerEndpoint) {
this.issuerEndpoint = issuerEndpoint;
return this;
}
@CustomType.Setter
public Builder name(String name) {
if (name == null) {
throw new MissingRequiredPropertyException("LinuxWebAppAuthSettingsV2CustomOidcV2", "name");
}
this.name = name;
return this;
}
@CustomType.Setter
public Builder nameClaimType(@Nullable String nameClaimType) {
this.nameClaimType = nameClaimType;
return this;
}
@CustomType.Setter
public Builder openidConfigurationEndpoint(String openidConfigurationEndpoint) {
if (openidConfigurationEndpoint == null) {
throw new MissingRequiredPropertyException("LinuxWebAppAuthSettingsV2CustomOidcV2", "openidConfigurationEndpoint");
}
this.openidConfigurationEndpoint = openidConfigurationEndpoint;
return this;
}
@CustomType.Setter
public Builder scopes(@Nullable List scopes) {
this.scopes = scopes;
return this;
}
public Builder scopes(String... scopes) {
return scopes(List.of(scopes));
}
@CustomType.Setter
public Builder tokenEndpoint(@Nullable String tokenEndpoint) {
this.tokenEndpoint = tokenEndpoint;
return this;
}
public LinuxWebAppAuthSettingsV2CustomOidcV2 build() {
final var _resultValue = new LinuxWebAppAuthSettingsV2CustomOidcV2();
_resultValue.authorisationEndpoint = authorisationEndpoint;
_resultValue.certificationUri = certificationUri;
_resultValue.clientCredentialMethod = clientCredentialMethod;
_resultValue.clientId = clientId;
_resultValue.clientSecretSettingName = clientSecretSettingName;
_resultValue.issuerEndpoint = issuerEndpoint;
_resultValue.name = name;
_resultValue.nameClaimType = nameClaimType;
_resultValue.openidConfigurationEndpoint = openidConfigurationEndpoint;
_resultValue.scopes = scopes;
_resultValue.tokenEndpoint = tokenEndpoint;
return _resultValue;
}
}
}