com.pulumi.okta.auth.ServerClaimArgs Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of okta Show documentation
Show all versions of okta Show documentation
A Pulumi package for creating and managing okta resources.
// *** 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.okta.auth;
import com.pulumi.core.Output;
import com.pulumi.core.annotations.Import;
import com.pulumi.exceptions.MissingRequiredPropertyException;
import java.lang.Boolean;
import java.lang.String;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import javax.annotation.Nullable;
public final class ServerClaimArgs extends com.pulumi.resources.ResourceArgs {
public static final ServerClaimArgs Empty = new ServerClaimArgs();
/**
* Specifies whether to include claims in token, by default it is set to `true`.
*
*/
@Import(name="alwaysIncludeInToken")
private @Nullable Output alwaysIncludeInToken;
/**
* @return Specifies whether to include claims in token, by default it is set to `true`.
*
*/
public Optional> alwaysIncludeInToken() {
return Optional.ofNullable(this.alwaysIncludeInToken);
}
/**
* ID of the authorization server.
*
*/
@Import(name="authServerId", required=true)
private Output authServerId;
/**
* @return ID of the authorization server.
*
*/
public Output authServerId() {
return this.authServerId;
}
/**
* Specifies whether the claim is for an access token `RESOURCE` or ID token `IDENTITY`.
*
*/
@Import(name="claimType", required=true)
private Output claimType;
/**
* @return Specifies whether the claim is for an access token `RESOURCE` or ID token `IDENTITY`.
*
*/
public Output claimType() {
return this.claimType;
}
/**
* Specifies the type of group filter if `value_type` is `GROUPS`. Can be set to one of the following `STARTS_WITH`, `EQUALS`, `CONTAINS`, `REGEX`.
*
*/
@Import(name="groupFilterType")
private @Nullable Output groupFilterType;
/**
* @return Specifies the type of group filter if `value_type` is `GROUPS`. Can be set to one of the following `STARTS_WITH`, `EQUALS`, `CONTAINS`, `REGEX`.
*
*/
public Optional> groupFilterType() {
return Optional.ofNullable(this.groupFilterType);
}
/**
* The name of the claim.
*
*/
@Import(name="name")
private @Nullable Output name;
/**
* @return The name of the claim.
*
*/
public Optional> name() {
return Optional.ofNullable(this.name);
}
/**
* The list of scopes the auth server claim is tied to.
*
*/
@Import(name="scopes")
private @Nullable Output> scopes;
/**
* @return The list of scopes the auth server claim is tied to.
*
*/
public Optional>> scopes() {
return Optional.ofNullable(this.scopes);
}
/**
* Default to `ACTIVE`
*
*/
@Import(name="status")
private @Nullable Output status;
/**
* @return Default to `ACTIVE`
*
*/
public Optional> status() {
return Optional.ofNullable(this.status);
}
/**
* The value of the claim.
*
*/
@Import(name="value", required=true)
private Output value;
/**
* @return The value of the claim.
*
*/
public Output value() {
return this.value;
}
/**
* The type of value of the claim. It can be set to `EXPRESSION` or `GROUPS`. It defaults to `EXPRESSION`.
*
*/
@Import(name="valueType")
private @Nullable Output valueType;
/**
* @return The type of value of the claim. It can be set to `EXPRESSION` or `GROUPS`. It defaults to `EXPRESSION`.
*
*/
public Optional> valueType() {
return Optional.ofNullable(this.valueType);
}
private ServerClaimArgs() {}
private ServerClaimArgs(ServerClaimArgs $) {
this.alwaysIncludeInToken = $.alwaysIncludeInToken;
this.authServerId = $.authServerId;
this.claimType = $.claimType;
this.groupFilterType = $.groupFilterType;
this.name = $.name;
this.scopes = $.scopes;
this.status = $.status;
this.value = $.value;
this.valueType = $.valueType;
}
public static Builder builder() {
return new Builder();
}
public static Builder builder(ServerClaimArgs defaults) {
return new Builder(defaults);
}
public static final class Builder {
private ServerClaimArgs $;
public Builder() {
$ = new ServerClaimArgs();
}
public Builder(ServerClaimArgs defaults) {
$ = new ServerClaimArgs(Objects.requireNonNull(defaults));
}
/**
* @param alwaysIncludeInToken Specifies whether to include claims in token, by default it is set to `true`.
*
* @return builder
*
*/
public Builder alwaysIncludeInToken(@Nullable Output alwaysIncludeInToken) {
$.alwaysIncludeInToken = alwaysIncludeInToken;
return this;
}
/**
* @param alwaysIncludeInToken Specifies whether to include claims in token, by default it is set to `true`.
*
* @return builder
*
*/
public Builder alwaysIncludeInToken(Boolean alwaysIncludeInToken) {
return alwaysIncludeInToken(Output.of(alwaysIncludeInToken));
}
/**
* @param authServerId ID of the authorization server.
*
* @return builder
*
*/
public Builder authServerId(Output authServerId) {
$.authServerId = authServerId;
return this;
}
/**
* @param authServerId ID of the authorization server.
*
* @return builder
*
*/
public Builder authServerId(String authServerId) {
return authServerId(Output.of(authServerId));
}
/**
* @param claimType Specifies whether the claim is for an access token `RESOURCE` or ID token `IDENTITY`.
*
* @return builder
*
*/
public Builder claimType(Output claimType) {
$.claimType = claimType;
return this;
}
/**
* @param claimType Specifies whether the claim is for an access token `RESOURCE` or ID token `IDENTITY`.
*
* @return builder
*
*/
public Builder claimType(String claimType) {
return claimType(Output.of(claimType));
}
/**
* @param groupFilterType Specifies the type of group filter if `value_type` is `GROUPS`. Can be set to one of the following `STARTS_WITH`, `EQUALS`, `CONTAINS`, `REGEX`.
*
* @return builder
*
*/
public Builder groupFilterType(@Nullable Output groupFilterType) {
$.groupFilterType = groupFilterType;
return this;
}
/**
* @param groupFilterType Specifies the type of group filter if `value_type` is `GROUPS`. Can be set to one of the following `STARTS_WITH`, `EQUALS`, `CONTAINS`, `REGEX`.
*
* @return builder
*
*/
public Builder groupFilterType(String groupFilterType) {
return groupFilterType(Output.of(groupFilterType));
}
/**
* @param name The name of the claim.
*
* @return builder
*
*/
public Builder name(@Nullable Output name) {
$.name = name;
return this;
}
/**
* @param name The name of the claim.
*
* @return builder
*
*/
public Builder name(String name) {
return name(Output.of(name));
}
/**
* @param scopes The list of scopes the auth server claim is tied to.
*
* @return builder
*
*/
public Builder scopes(@Nullable Output> scopes) {
$.scopes = scopes;
return this;
}
/**
* @param scopes The list of scopes the auth server claim is tied to.
*
* @return builder
*
*/
public Builder scopes(List scopes) {
return scopes(Output.of(scopes));
}
/**
* @param scopes The list of scopes the auth server claim is tied to.
*
* @return builder
*
*/
public Builder scopes(String... scopes) {
return scopes(List.of(scopes));
}
/**
* @param status Default to `ACTIVE`
*
* @return builder
*
*/
public Builder status(@Nullable Output status) {
$.status = status;
return this;
}
/**
* @param status Default to `ACTIVE`
*
* @return builder
*
*/
public Builder status(String status) {
return status(Output.of(status));
}
/**
* @param value The value of the claim.
*
* @return builder
*
*/
public Builder value(Output value) {
$.value = value;
return this;
}
/**
* @param value The value of the claim.
*
* @return builder
*
*/
public Builder value(String value) {
return value(Output.of(value));
}
/**
* @param valueType The type of value of the claim. It can be set to `EXPRESSION` or `GROUPS`. It defaults to `EXPRESSION`.
*
* @return builder
*
*/
public Builder valueType(@Nullable Output valueType) {
$.valueType = valueType;
return this;
}
/**
* @param valueType The type of value of the claim. It can be set to `EXPRESSION` or `GROUPS`. It defaults to `EXPRESSION`.
*
* @return builder
*
*/
public Builder valueType(String valueType) {
return valueType(Output.of(valueType));
}
public ServerClaimArgs build() {
if ($.authServerId == null) {
throw new MissingRequiredPropertyException("ServerClaimArgs", "authServerId");
}
if ($.claimType == null) {
throw new MissingRequiredPropertyException("ServerClaimArgs", "claimType");
}
if ($.value == null) {
throw new MissingRequiredPropertyException("ServerClaimArgs", "value");
}
return $;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy