Class DataplaneClient
Service client instance for Dataplane.
Implements
Inherited Members
Namespace: Oci.IdentitydataplaneService
Assembly: OCI.DotNetSDK.Identitydataplane.dll
Syntax
public class DataplaneClient : RegionalClientBase, IDisposable
Constructors
DataplaneClient(IBasicAuthenticationDetailsProvider, ClientConfiguration, string)
Creates a new service instance using the given authentication provider and/or client configuration and/or endpoint. A client configuration can also be provided optionally to adjust REST client behaviors.
Declaration
public DataplaneClient(IBasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration clientConfiguration = null, string endpoint = null)
Parameters
Type | Name | Description |
---|---|---|
IBasicAuthenticationDetailsProvider | authenticationDetailsProvider | The authentication details provider. Required. |
ClientConfiguration | clientConfiguration | The client configuration that contains settings to adjust REST client behaviors. Optional. |
string | endpoint | The endpoint of the service. If not provided and the client is a regional client, the endpoint will be constructed based on region information. Optional. |
Methods
GenerateScopedAccessToken(GenerateScopedAccessTokenRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Based on the calling Principal and the input payload, derive the claims, and generate a scoped-access token for specific resources. For example, set scope to urn:oracle:db::id::<compartment-id> for access to a database in a compartment.
Declaration
public Task<GenerateScopedAccessTokenResponse> GenerateScopedAccessToken(GenerateScopedAccessTokenRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GenerateScopedAccessTokenRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GenerateScopedAccessTokenResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GenerateScopedAccessToken API.
GenerateUserSecurityToken(GenerateUserSecurityTokenRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Exchanges a valid user token-based signature (API key and UPST) for a short-lived UPST of the authenticated user principal. When not specified, the user session duration is set to a default of 60 minutes in all realms. Resulting UPSTs are refreshable while the user session has not expired.
Declaration
public Task<GenerateUserSecurityTokenResponse> GenerateUserSecurityToken(GenerateUserSecurityTokenRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GenerateUserSecurityTokenRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GenerateUserSecurityTokenResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GenerateUserSecurityToken API.