OauthClientState class
Input properties used for looking up and filtering OauthClient resources.
Constructors
-
OauthClientState({Input<
List< ? allowedGrantTypes, Input<String> ?>List< ? allowedRedirectUris, Input<String> ?>List< ? allowedScopes, Input<String> ?>String?> ? clientId, Input<String?> ? clientType, Input<String?> ? deletionPolicy, Input<String?> ? description, Input<bool?> ? disabled, Input<String?> ? displayName, Input<String?> ? expireTime, Input<String?> ? location, Input<String?> ? name, Input<String?> ? oauthClientId, Input<String?> ? project, Input<String?> ? state}) -
Creates a new OauthClientState.
allowedGrantTypesRequired. The list of OAuth grant types is allowed for the OauthClient.allowedRedirectUrisRequired. The list of redirect uris that is allowed to redirect backallowedScopesRequired. The list of scopes that the OauthClient is allowed to request duringclientIdOutput only. The system-generated OauthClient id.clientTypeImmutable. The type of OauthClient. Either public or private.deletionPolicyWhether Terraform will be prevented from destroying the resource. Defaults to DELETE.descriptionA user-specified description of the OauthClient.disabledWhether the OauthClient is disabled. You cannot use a disabled OAuthdisplayNameA user-specified display name of the OauthClient.expireTimeTime after which the OauthClient will be permanently purged and cannotlocationResource ID segment making up resourcename. It identifies the resource within its parent collection as described in https://google.aip.dev/122.nameImmutable. Identifier. The resource name of the OauthClient.oauthClientIdRequired. The ID to use for the OauthClient, which becomes the final component ofprojectThe ID of the project in which the resource belongs.stateThe state of the OauthClient.const -
OauthClientState.fromMap(Map<
String, dynamic> map) -
factory
Properties
-
allowedGrantTypes
→ Input<
List< ?String> ?> -
Required. The list of OAuth grant types is allowed for the OauthClient.
final
-
allowedRedirectUris
→ Input<
List< ?String> ?> -
Required. The list of redirect uris that is allowed to redirect back
when authorization process is completed.
final
-
allowedScopes
→ Input<
List< ?String> ?> -
Required. The list of scopes that the OauthClient is allowed to request during
OAuth flows.
The following scopes are supported:
final
-
clientId
→ Input<
String?> ? -
Output only. The system-generated OauthClient id.
final
-
clientType
→ Input<
String?> ? -
Immutable. The type of OauthClient. Either public or private.
For private clients, the client secret can be managed using the dedicated
OauthClientCredential resource.
Possible values:
CLIENT_TYPE_UNSPECIFIED
PUBLIC_CLIENT
CONFIDENTIAL_CLIENT
final
-
deletionPolicy
→ Input<
String?> ? -
Whether Terraform will be prevented from destroying the resource. Defaults to DELETE.
When a 'terraform destroy' or 'pulumi up' would delete the resource,
the command will fail if this field is set to "PREVENT" in Terraform state.
When set to "ABANDON", the command will remove the resource from Terraform
management without updating or deleting the resource in the API.
When set to "DELETE", deleting the resource is allowed.
final
-
description
→ Input<
String?> ? -
A user-specified description of the OauthClient.
Cannot exceed 256 characters.
final
-
disabled
→ Input<
bool?> ? -
Whether the OauthClient is disabled. You cannot use a disabled OAuth
client.
final
-
displayName
→ Input<
String?> ? -
A user-specified display name of the OauthClient.
Cannot exceed 32 characters.
final
-
expireTime
→ Input<
String?> ? -
Time after which the OauthClient will be permanently purged and cannot
be recovered.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
-
location
→ Input<
String?> ? -
Resource ID segment making up resource
name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.final -
name
→ Input<
String?> ? -
Immutable. Identifier. The resource name of the OauthClient.
Format:
projects/{project}/locations/{location}/oauthClients/{oauth_client}.final -
oauthClientId
→ Input<
String?> ? -
Required. The ID to use for the OauthClient, which becomes the final component of
the resource name. This value should be a string of 6 to 63 lowercase
letters, digits, or hyphens. It must start with a letter, and cannot have a
trailing hyphen. The prefix
gcp-is reserved for use by Google, and may not be specified.final -
project
→ Input<
String?> ? -
The ID of the project in which the resource belongs.
If it is not provided, the provider project is used.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
state
→ Input<
String?> ? -
The state of the OauthClient.
Possible values:
STATE_UNSPECIFIED
ACTIVE
DELETED
final
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toMap(
) → Map< String, dynamic> -
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited