Class CreateAuthenticationProviderDetails
Properties required to create a new Authentication Provider.
Inherited Members
Namespace: Oci.OdaService.Models
Assembly: OCI.DotNetSDK.Oda.dll
Syntax
public class CreateAuthenticationProviderDetails
Properties
AuthorizationEndpointUrl
Declaration
[JsonProperty(PropertyName = "authorizationEndpointUrl")]
public string AuthorizationEndpointUrl { get; set; }
Property Value
Type | Description |
---|---|
string | The IDPs URL for the page that users authenticate with by entering the user name and password. |
ClientId
Declaration
[Required(ErrorMessage = "ClientId is required.")]
[JsonProperty(PropertyName = "clientId")]
public string ClientId { get; set; }
Property Value
Type | Description |
---|---|
string | 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. |
Remarks
Required
ClientSecret
Declaration
[Required(ErrorMessage = "ClientSecret is required.")]
[JsonProperty(PropertyName = "clientSecret")]
public string ClientSecret { get; set; }
Property Value
Type | Description |
---|---|
string | The client secret for the IDP application (OAuth Client) that was registered as described in Identity Provider Registration. With Microsoft identity platform, use the application secret. |
Remarks
Required
DefinedTags
Declaration
[JsonProperty(PropertyName = "definedTags")]
public Dictionary<string, Dictionary<string, object>> DefinedTags { get; set; }
Property Value
Type | Description |
---|---|
Dictionary<string, Dictionary<string, object>> | Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace": {"bar-key": "value"}} |
FreeformTags
Declaration
[JsonProperty(PropertyName = "freeformTags")]
public Dictionary<string, string> FreeformTags { get; set; }
Property Value
Type | Description |
---|---|
Dictionary<string, string> | Simple key-value pair that is applied without any predefined name, type, or scope. Example: {"bar-key": "value"} |
GrantType
Declaration
[Required(ErrorMessage = "GrantType is required.")]
[JsonProperty(PropertyName = "grantType")]
[JsonConverter(typeof(StringEnumConverter))]
public AuthenticationGrantType? GrantType { get; set; }
Property Value
Type | Description |
---|---|
AuthenticationGrantType? | The grant type for the Authentication Provider. |
Remarks
Required
IdentityProvider
Declaration
[Required(ErrorMessage = "IdentityProvider is required.")]
[JsonProperty(PropertyName = "identityProvider")]
[JsonConverter(typeof(StringEnumConverter))]
public AuthenticationIdentityProvider? IdentityProvider { get; set; }
Property Value
Type | Description |
---|---|
AuthenticationIdentityProvider? | Which type of Identity Provider (IDP) you are using. |
Remarks
Required
IsVisible
Declaration
[JsonProperty(PropertyName = "isVisible")]
public bool? IsVisible { get; set; }
Property Value
Type | Description |
---|---|
bool? | Whether this Authentication Provider is visible in the ODA UI. |
Name
Declaration
[Required(ErrorMessage = "Name is required.")]
[JsonProperty(PropertyName = "name")]
public string Name { get; set; }
Property Value
Type | Description |
---|---|
string | A name to identify the Authentication Provider. |
Remarks
Required
RedirectUrl
Declaration
[JsonProperty(PropertyName = "redirectUrl")]
public string RedirectUrl { get; set; }
Property Value
Type | Description |
---|---|
string | The OAuth Redirect URL. |
RefreshTokenRetentionPeriodInDays
Declaration
[JsonProperty(PropertyName = "refreshTokenRetentionPeriodInDays")]
public int? RefreshTokenRetentionPeriodInDays { get; set; }
Property Value
Type | Description |
---|---|
int? | The number of days to keep the refresh token in the Digital Assistant cache. |
RevokeTokenEndpointUrl
Declaration
[JsonProperty(PropertyName = "revokeTokenEndpointUrl")]
public string RevokeTokenEndpointUrl { get; set; }
Property Value
Type | Description |
---|---|
string | 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. |
Scopes
Declaration
[Required(ErrorMessage = "Scopes is required.")]
[JsonProperty(PropertyName = "scopes")]
public string Scopes { get; set; }
Property Value
Type | Description |
---|---|
string | 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\u2019s necessary to get the refresh token (typically offline_access). |
Remarks
Required
ShortAuthorizationCodeRequestUrl
Declaration
[JsonProperty(PropertyName = "shortAuthorizationCodeRequestUrl")]
public string ShortAuthorizationCodeRequestUrl { get; set; }
Property Value
Type | Description |
---|---|
string | 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. |
SubjectClaim
Declaration
[JsonProperty(PropertyName = "subjectClaim")]
public string SubjectClaim { get; set; }
Property Value
Type | Description |
---|---|
string | The access-token profile claim to use to identify the user. |
TokenEndpointUrl
Declaration
[Required(ErrorMessage = "TokenEndpointUrl is required.")]
[JsonProperty(PropertyName = "tokenEndpointUrl")]
public string TokenEndpointUrl { get; set; }
Property Value
Type | Description |
---|---|
string | The IDPs URL for requesting access tokens. |
Remarks
Required