Class IssuerRequest.Builder
- All Implemented Interfaces:
IssuerRequest._FinalStage,IssuerRequest.AudienceStage,IssuerRequest.ContextIdStage,IssuerRequest.IssuerIdStage,IssuerRequest.IssuerStage,IssuerRequest.JwksUriStage
- Enclosing class:
IssuerRequest
-
Method Summary
Modifier and TypeMethodDescriptionadditionalProperties(Map<String, Object> additionalProperties) additionalProperty(String key, Object value) Theaudclaim value this contract requires a presented subject_token to carry.build()Which of your app contexts an exchanged token targets.emailClaim(String emailClaim) The claim in the IdP's token that carries the subject's email, used for first-login invite matching.emailClaim(Optional<String> emailClaim) The claim in the IdP's token that carries the subject's email, used for first-login invite matching.from(IssuerRequest other) The IdP'sissclaim value, exactly as it appears in tokens it issues.Short slug identifying this issuer within your tenant: 3-31 characters, a lowercase letter first, then lowercase letters, digits, or hyphens.The IdP's remote JWKS endpoint, used to verify presented tokens' signatures.selfSignupPolicies(List<SelfSignupPolicy> selfSignupPolicies) Opt-in self-service signup: a list of {signup_type, role_id} pairs.selfSignupPolicies(Optional<List<SelfSignupPolicy>> selfSignupPolicies) Opt-in self-service signup: a list of {signup_type, role_id} pairs.The claim in the IdP's token that carries the subject identifier.The claim in the IdP's token that carries the subject identifier.
-
Method Details
-
from
- Specified by:
fromin interfaceIssuerRequest.IssuerIdStage
-
issuerId
Short slug identifying this issuer within your tenant: 3-31 characters, a lowercase letter first, then lowercase letters, digits, or hyphens. Immutable once registered.
Short slug identifying this issuer within your tenant: 3-31 characters, a lowercase letter first, then lowercase letters, digits, or hyphens. Immutable once registered.
- Specified by:
issuerIdin interfaceIssuerRequest.IssuerIdStage- Returns:
- Reference to
thisso that method calls can be chained together.
-
issuer
The IdP's
issclaim value, exactly as it appears in tokens it issues.The IdP's
issclaim value, exactly as it appears in tokens it issues.- Specified by:
issuerin interfaceIssuerRequest.IssuerStage- Returns:
- Reference to
thisso that method calls can be chained together.
-
jwksUri
The IdP's remote JWKS endpoint, used to verify presented tokens' signatures.
The IdP's remote JWKS endpoint, used to verify presented tokens' signatures.
- Specified by:
jwksUriin interfaceIssuerRequest.JwksUriStage- Returns:
- Reference to
thisso that method calls can be chained together.
-
audience
The
audclaim value this contract requires a presented subject_token to carry. Must be globally unique in combination withissuer— use a distinct audience per environment/context sharing one IdP account (most OIDC providers support this as an ordinary per-API/application default).The
audclaim value this contract requires a presented subject_token to carry. Must be globally unique in combination withissuer— use a distinct audience per environment/context sharing one IdP account (most OIDC providers support this as an ordinary per-API/application default).- Specified by:
audiencein interfaceIssuerRequest.AudienceStage- Returns:
- Reference to
thisso that method calls can be chained together.
-
contextId
Which of your app contexts an exchanged token targets. Must be an existing app context (create it first via
POST /v1/app-contexts). A credential authorized via the CLI bootstrap's provisioning capability may only name the app context it is itself bound to; naming another one is refused. A root API key may name any of its contexts.Which of your app contexts an exchanged token targets. Must be an existing app context (create it first via
POST /v1/app-contexts). A credential authorized via the CLI bootstrap's provisioning capability may only name the app context it is itself bound to; naming another one is refused. A root API key may name any of its contexts.- Specified by:
contextIdin interfaceIssuerRequest.ContextIdStage- Returns:
- Reference to
thisso that method calls can be chained together.
-
selfSignupPolicies
Opt-in self-service signup: a list of {signup_type, role_id} pairs. When a first-time exchange caller presents no invite token but names a signup_type matching one of these (or omits signup_type and exactly one entry exists), a brand-new user is created and bound to that entry's role — no invite required. Every entry must, by construction, be something you're willing to grant to ANY caller who can present a token from this issuer: no entry may target a role carrying elevated (provisioning or wildcard) scope — rejected. Omit entirely to leave self-signup disabled (the default).
- Specified by:
selfSignupPoliciesin interfaceIssuerRequest._FinalStage- Returns:
- Reference to
thisso that method calls can be chained together.
-
selfSignupPolicies
public IssuerRequest._FinalStage selfSignupPolicies(Optional<List<SelfSignupPolicy>> selfSignupPolicies) Opt-in self-service signup: a list of {signup_type, role_id} pairs. When a first-time exchange caller presents no invite token but names a signup_type matching one of these (or omits signup_type and exactly one entry exists), a brand-new user is created and bound to that entry's role — no invite required. Every entry must, by construction, be something you're willing to grant to ANY caller who can present a token from this issuer: no entry may target a role carrying elevated (provisioning or wildcard) scope — rejected. Omit entirely to leave self-signup disabled (the default).
- Specified by:
selfSignupPoliciesin interfaceIssuerRequest._FinalStage
-
emailClaim
The claim in the IdP's token that carries the subject's email, used for first-login invite matching. Defaults to
emailif omitted.- Specified by:
emailClaimin interfaceIssuerRequest._FinalStage- Returns:
- Reference to
thisso that method calls can be chained together.
-
emailClaim
The claim in the IdP's token that carries the subject's email, used for first-login invite matching. Defaults to
emailif omitted.- Specified by:
emailClaimin interfaceIssuerRequest._FinalStage
-
subClaim
The claim in the IdP's token that carries the subject identifier. Defaults to
subif omitted.- Specified by:
subClaimin interfaceIssuerRequest._FinalStage- Returns:
- Reference to
thisso that method calls can be chained together.
-
subClaim
The claim in the IdP's token that carries the subject identifier. Defaults to
subif omitted.- Specified by:
subClaimin interfaceIssuerRequest._FinalStage
-
build
- Specified by:
buildin interfaceIssuerRequest._FinalStage
-
additionalProperty
- Specified by:
additionalPropertyin interfaceIssuerRequest._FinalStage
-
additionalProperties
- Specified by:
additionalPropertiesin interfaceIssuerRequest._FinalStage
-