/
authentication_provider.go
111 lines (85 loc) · 5.65 KB
/
authentication_provider.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
// Copyright (c) 2016, 2018, 2024, Oracle and/or its affiliates. All rights reserved.
// This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
// Code generated. DO NOT EDIT.
// Digital Assistant Service Instance API
//
// API to create and maintain Oracle Digital Assistant service instances.
//
package oda
import (
"fmt"
"github.com/oracle/oci-go-sdk/v65/common"
"strings"
)
// AuthenticationProvider Settings for the Authentication Provider.
type AuthenticationProvider struct {
// Unique immutable identifier that was assigned when the Authentication Provider was created.
Id *string `mandatory:"true" json:"id"`
// The grant type for the Authentication Provider.
GrantType AuthenticationGrantTypeEnum `mandatory:"true" json:"grantType"`
// Which type of Identity Provider (IDP) you are using.
IdentityProvider AuthenticationIdentityProviderEnum `mandatory:"true" json:"identityProvider"`
// A name to identify the Authentication Provider.
Name *string `mandatory:"true" json:"name"`
// The IDPs URL for requesting access tokens.
TokenEndpointUrl *string `mandatory:"true" json:"tokenEndpointUrl"`
// The client ID for the IDP application (OAuth Client) that was registered as described in Identity Provider Registration.
// With Microsoft identity platform, use the application ID.
ClientId *string `mandatory:"true" json:"clientId"`
// A space-separated list of the scopes that must be included when Digital Assistant requests an access token from
// the provider. Include all the scopes that are required to access the resources. If refresh tokens are enabled,
// include the scope that’s necessary to get the refresh token (typically offline_access).
Scopes *string `mandatory:"true" json:"scopes"`
// Whether this Authentication Provider is visible in the ODA UI.
IsVisible *bool `mandatory:"true" json:"isVisible"`
// The Authentication Provider's current state.
LifecycleState LifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// When the resource was created. A date-time string as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339), section 14.29.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// When the resource was last updated. A date-time string as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339), section 14.29.
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// The IDPs URL for the page that users authenticate with by entering the user name and password.
AuthorizationEndpointUrl *string `mandatory:"false" json:"authorizationEndpointUrl"`
// A shortened version of the authorization URL, which you can get from a URL shortener service (one that allows
// you to send query parameters). You might need this because the generated authorization-code-request URL
// could be too long for SMS and older smart phones.
ShortAuthorizationCodeRequestUrl *string `mandatory:"false" json:"shortAuthorizationCodeRequestUrl"`
// If you want to revoke all the refresh tokens and access tokens of the logged-in user from a dialog flow, then
// you need the IDP's revoke refresh token URL. If you provide this URL, then you can use the System.OAuth2ResetTokens
// component to revoke the user's tokens for this service.
RevokeTokenEndpointUrl *string `mandatory:"false" json:"revokeTokenEndpointUrl"`
// The access-token profile claim to use to identify the user.
SubjectClaim *string `mandatory:"false" json:"subjectClaim"`
// The number of days to keep the refresh token in the Digital Assistant cache.
RefreshTokenRetentionPeriodInDays *int `mandatory:"false" json:"refreshTokenRetentionPeriodInDays"`
// The OAuth Redirect URL.
RedirectUrl *string `mandatory:"false" json:"redirectUrl"`
// Simple key-value pair that is applied without any predefined name, type, or scope.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Usage of predefined tag keys. These predefined keys are scoped to namespaces.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m AuthenticationProvider) String() string {
return common.PointerString(m)
}
// ValidateEnumValue returns an error when providing an unsupported enum value
// This function is being called during constructing API request process
// Not recommended for calling this function directly
func (m AuthenticationProvider) ValidateEnumValue() (bool, error) {
errMessage := []string{}
if _, ok := GetMappingAuthenticationGrantTypeEnum(string(m.GrantType)); !ok && m.GrantType != "" {
errMessage = append(errMessage, fmt.Sprintf("unsupported enum value for GrantType: %s. Supported values are: %s.", m.GrantType, strings.Join(GetAuthenticationGrantTypeEnumStringValues(), ",")))
}
if _, ok := GetMappingAuthenticationIdentityProviderEnum(string(m.IdentityProvider)); !ok && m.IdentityProvider != "" {
errMessage = append(errMessage, fmt.Sprintf("unsupported enum value for IdentityProvider: %s. Supported values are: %s.", m.IdentityProvider, strings.Join(GetAuthenticationIdentityProviderEnumStringValues(), ",")))
}
if _, ok := GetMappingLifecycleStateEnum(string(m.LifecycleState)); !ok && m.LifecycleState != "" {
errMessage = append(errMessage, fmt.Sprintf("unsupported enum value for LifecycleState: %s. Supported values are: %s.", m.LifecycleState, strings.Join(GetLifecycleStateEnumStringValues(), ",")))
}
if len(errMessage) > 0 {
return true, fmt.Errorf(strings.Join(errMessage, "\n"))
}
return false, nil
}