From 476244caba11e5933ab5412ecb36e350eb7fa7cb Mon Sep 17 00:00:00 2001
From: Frederik Prijck Full documentation on the Auth0 Authentication API is available at https://auth0.com/docs/api/authentication Optional IAuthenticationConnection used to influence connection behavior.
-Defaults to a freshly created HttpClientAuthenticationConnection that uses a single System.Net.Http.HttpClient. To use a custom System.Net.Http.HttpClient or System.Net.Http.HttpMessageHandler create a
+ To use a custom Initializes a new instance of the AuthenticationApiClient class. Your Auth0 domain URI, e.g. https://tenant.auth0.com Optional IAuthenticationConnection used to influence connection behavior.
-Defaults to a freshly created HttpClientAuthenticationConnection that uses a single System.Net.Http.HttpClient. To use a custom System.Net.Http.HttpClient or System.Net.Http.HttpMessageHandler create a
+ To use a custom Requests a password change email for a given email address and connection. The cancellation token to cancel operation. System.Threading.Tasks.Task representing the async operation containing either the JSON error response or the plain text success message response. Obtains a one-time link that can be used to log in as a specific user. The cancellation token to cancel operation. System.Threading.Tasks.Task which can be used to sign in as the specified user. This feature has been deprecated and will be removed from Auth0 and this library in a future release. Exchanges an Authorization Code using PKCE for an Access Token. The cancellation token to cancel operation. System.Threading.Tasks.Task representing the async operation containing
+ Exchanges an Authorization Code for an Access Token. The cancellation token to cancel operation. System.Threading.Tasks.Task representing the async operation containing
+ Requests an Access Token using the Client Credentials Grant flow. The cancellation token to cancel operation. System.Threading.Tasks.Task representing the async operation containing
+ Requests an Access Token using the Device Authorization flow The cancellation token to cancel operation. System.Threading.Tasks.Task representing the async operation containing
+ This must be polled while the user is completing their part of the flow at an interval no more frequent than that returned by StartDeviceFlowAsync(DeviceCodeRequest, CancellationToken). This must be polled while the user is completing their part of the flow at an interval no more frequent than that returned by StartDeviceFlowAsync(DeviceCodeRequest, CancellationToken). Requests an Access Token using the Passwordless flow through email. The cancellation token to cancel operation. System.Threading.Tasks.Task representing the async operation containing
+ Requests an Access Token using the Passwordless flow through SMS. The cancellation token to cancel operation. System.Threading.Tasks.Task representing the async operation containing
+ Refreshes all tokens by way of the the Refresh Token obtained during authorization. The cancellation token to cancel operation. System.Threading.Tasks.Task representing the async operation containing
+ Performs authentication by providing user-supplied information in a ResourceOwnerTokenRequest. The cancellation token to cancel operation. System.Threading.Tasks.Task representing the async operation containing
+ The grant_type parameter required by the /oauth/token endpoint will automatically be inferred from the Returns user information based on the access token that was obtained during login. The cancellation token to cancel operation. System.Threading.Tasks.Task representing the async operation containing the
+ Information included in the response depends on the scopes initially granted. Revokes refresh token provided in request. The cancellation token to cancel operation. System.Threading.Tasks.Task representing the async operation. Creates a new user given the user details specified. The cancellation token to cancel operation. System.Threading.Tasks.Task representing the async operation containing
+ Starts a new Device Authorization flow The cancellation token to cancel operation. System.Threading.Tasks.Task representing the async operation containing
+ Starts a new Passwordless email flow. The cancellation token to cancel operation. System.Threading.Tasks.Task representing the async operation containing
+ Starts a new Passwordless SMS flow. The cancellation token to cancel operation. System.Threading.Tasks.Task representing the async operation containing
+ Base URL of the Authentication API represented as a System.String. Base URL of the Authentication API represented as a Initializes a new instance of the AuthorizationUrlBuilder class. Base URL of the Authentication API represented as a System.Uri. Base URL of the Authentication API represented as a Adds the System.Uri to redirect to. Base URL of the Authentication API represented as a System.String. Base URL of the Authentication API represented as a Initializes a new instance of the LogoutUrlBuilder class. Base URL of the Authentication API represented as a System.Uri. Base URL of the Authentication API represented as a Adds the System.Uri to redirect to. Base URL of the Authentication API represented as a System.String. Base URL of the Authentication API represented as a Initializes a new instance of the SamlUrlBuilder class. Base URL of the Authentication API represented as a System.Uri. Base URL of the Authentication API represented as a Adds the Dictionary containing key-value pairs for the See https://auth0.com/docs/protocols/saml/saml-configuration/special-configuration-scenarios/idp-initiated-sso#auth0-as-identity-provider-where-idp-initiates-sso for more details on RelayState. Base URL represented as a System.String. Base URL represented as a Initializes a new instance of the UrlBuilderBase<T> class. Base URL represented as a System.Uri. Base URL represented as a System.Uri containing the complete URL. Base URL of the Authentication API represented as a System.String. Base URL of the Authentication API represented as a Initializes a new instance of the WsFedUrlBuilder class. Base URL of the Authentication API represented as a System.Uri. Base URL of the Authentication API represented as a Adds the Dictionary containing the key-value pairs of the Implements the IAuthenticationConnection using System.Net.Http.HttpClient which
+ Implements the IAuthenticationConnection using Initializes a new instance of the HttpClientAuthenticationConnection class. Optional System.Net.Http.HttpClient to use when sending requests. Optional If you supply a System.Net.Http.HttpClient it is your responsibility to manage its lifecycle and
+ If you supply a Initializes a new instance of the HttpClientAuthenticationConnection class
-with a specific System.Net.Http.HttpMessageHandler. System.Net.Http.HttpMessageHandler to use within the managed System.Net.Http.HttpClient. Disposes of any owned disposable resources such as the underlying System.Net.Http.HttpClient if owned. Disposes of any owned disposable resources such as the underlying Disposes of any owned disposable resources such as the underlying System.Net.Http.HttpClient if owned. Disposes of any owned disposable resources such as the underlying Send a HTTP GET request to the given Absolute System.Uri to send the request to. Absolute Optional dictionary containing additional headers to be sent. The cancellation token to cancel operation. The task object representing the asynchronous operation. Send an HTTP request to Create a new IdTokenValidationKeyMissingException that contains a further inner
-System.Exception describing how this token's key could not be found. Inner exception that caused this validation exception.Inheritance
- Inherited Members
- Namespace: Auth0.AuthenticationApi
Assembly: Auth0.AuthenticationApi.dll
Syntax
+ public class AuthenticationApiClient : IAuthenticationApiClient, IDisposable
public class AuthenticationApiClient : object, IAuthenticationApiClient
Remarks
Parameters
IAuthenticationConnection
connection
Remarks
-
or
var client = new AuthenticationApiClient(domain, new HttpClientAuthenticationConnection(myHttpClient));
or
var client = new AuthenticationApiClient(domain, new HttpClientAuthenticationConnection(myHttpMessageHandler));
AuthenticationApiClient(Uri, IAuthenticationConnection)
+ AuthenticationApiClient(Uri, IAuthenticationConnection)
Parameters
-
- System.Uri
+ Uri
baseUri
@@ -190,13 +166,13 @@ Parameters
IAuthenticationConnection
connection
Remarks
- Remarks
+
or
var client = new AuthenticationApiClient(baseUri, new HttpClientAuthenticationConnection(myHttpClient));
or
@@ -246,7 +222,7 @@ var client = new AuthenticationApiClient(baseUri, new HttpClientAuthenticationConnection(myHttpMessageHandler));
Property Value
-
@@ -254,13 +230,13 @@ System.Uri
+ Uri
Property Value
Methods
- ChangePasswordAsync(ChangePasswordRequest, CancellationToken)
+ ChangePasswordAsync(ChangePasswordRequest, CancellationToken)
Declaration
+ public Task<string> ChangePasswordAsync(ChangePasswordRequest request, CancellationToken cancellationToken = default(CancellationToken))
public Task<string> ChangePasswordAsync(ChangePasswordRequest request, CancellationToken cancellationToken = null)
Parameters
@@ -279,7 +255,7 @@
- Parameters
-
System.Threading.CancellationToken
+ CancellationToken
cancellationToken
@@ -296,8 +272,8 @@ Returns
-
@@ -339,13 +315,13 @@ System.Threading.Tasks.Task<System.String>
- Task<System.String>
+ Parameters
GetImpersonationUrlAsync(ImpersonationRequest, CancellationToken)
+ GetImpersonationUrlAsync(ImpersonationRequest, CancellationToken)
Declaration
+ public async Task<Uri> GetImpersonationUrlAsync(ImpersonationRequest request, CancellationToken cancellationToken = default(CancellationToken))
public async Task<Uri> GetImpersonationUrlAsync(ImpersonationRequest request, CancellationToken cancellationToken = null)
Parameters
@@ -364,7 +340,7 @@
- Parameters
-
System.Threading.CancellationToken
+ CancellationToken
cancellationToken
@@ -381,23 +357,23 @@ Returns
-
System.Threading.Tasks.Task<System.Uri>
- Task<Uri>
+ Remarks
+ Remarks
GetTokenAsync(AuthorizationCodePkceTokenRequest, CancellationToken)
+ GetTokenAsync(AuthorizationCodePkceTokenRequest, CancellationToken)
Declaration
+ public async Task<AccessTokenResponse> GetTokenAsync(AuthorizationCodePkceTokenRequest request, CancellationToken cancellationToken = default(CancellationToken))
public async Task<AccessTokenResponse> GetTokenAsync(AuthorizationCodePkceTokenRequest request, CancellationToken cancellationToken = null)
Parameters
@@ -416,7 +392,7 @@
- Parameters
-
System.Threading.CancellationToken
+ CancellationToken
cancellationToken
@@ -433,21 +409,21 @@ Returns
-
System.Threading.Tasks.Task<AccessTokenResponse>
- Task<AccessTokenResponse>
+ GetTokenAsync(AuthorizationCodeTokenRequest, CancellationToken)
+ GetTokenAsync(AuthorizationCodeTokenRequest, CancellationToken)
Declaration
+ public async Task<AccessTokenResponse> GetTokenAsync(AuthorizationCodeTokenRequest request, CancellationToken cancellationToken = default(CancellationToken))
public async Task<AccessTokenResponse> GetTokenAsync(AuthorizationCodeTokenRequest request, CancellationToken cancellationToken = null)
Parameters
@@ -466,7 +442,7 @@
- Parameters
-
System.Threading.CancellationToken
+ CancellationToken
cancellationToken
@@ -483,21 +459,21 @@ Returns
-
System.Threading.Tasks.Task<AccessTokenResponse>
- Task<AccessTokenResponse>
+ GetTokenAsync(ClientCredentialsTokenRequest, CancellationToken)
+ GetTokenAsync(ClientCredentialsTokenRequest, CancellationToken)
Declaration
+ public Task<AccessTokenResponse> GetTokenAsync(ClientCredentialsTokenRequest request, CancellationToken cancellationToken = default(CancellationToken))
public Task<AccessTokenResponse> GetTokenAsync(ClientCredentialsTokenRequest request, CancellationToken cancellationToken = null)
Parameters
@@ -517,7 +493,7 @@
- Parameters
-
System.Threading.CancellationToken
+ CancellationToken
cancellationToken
@@ -534,21 +510,21 @@ Returns
-
System.Threading.Tasks.Task<AccessTokenResponse>
- Task<AccessTokenResponse>
+ GetTokenAsync(DeviceCodeTokenRequest, CancellationToken)
+ GetTokenAsync(DeviceCodeTokenRequest, CancellationToken)
Declaration
+ public async Task<AccessTokenResponse> GetTokenAsync(DeviceCodeTokenRequest request, CancellationToken cancellationToken = default(CancellationToken))
public async Task<AccessTokenResponse> GetTokenAsync(DeviceCodeTokenRequest request, CancellationToken cancellationToken = null)
Parameters
@@ -567,7 +543,7 @@
- Parameters
-
System.Threading.CancellationToken
+ CancellationToken
cancellationToken
@@ -584,24 +560,24 @@ Returns
-
System.Threading.Tasks.Task<AccessTokenResponse>
- Task<AccessTokenResponse>
+ Remarks
- Remarks
+ GetTokenAsync(PasswordlessEmailTokenRequest, CancellationToken)
+ GetTokenAsync(PasswordlessEmailTokenRequest, CancellationToken)
Declaration
+ public async Task<AccessTokenResponse> GetTokenAsync(PasswordlessEmailTokenRequest request, CancellationToken cancellationToken = default(CancellationToken))
public async Task<AccessTokenResponse> GetTokenAsync(PasswordlessEmailTokenRequest request, CancellationToken cancellationToken = null)
Parameters
@@ -620,7 +596,7 @@
- Parameters
-
System.Threading.CancellationToken
+ CancellationToken
cancellationToken
@@ -637,21 +613,21 @@ Returns
-
System.Threading.Tasks.Task<AccessTokenResponse>
- Task<AccessTokenResponse>
+ GetTokenAsync(PasswordlessSmsTokenRequest, CancellationToken)
+ GetTokenAsync(PasswordlessSmsTokenRequest, CancellationToken)
Declaration
+ public async Task<AccessTokenResponse> GetTokenAsync(PasswordlessSmsTokenRequest request, CancellationToken cancellationToken = default(CancellationToken))
public async Task<AccessTokenResponse> GetTokenAsync(PasswordlessSmsTokenRequest request, CancellationToken cancellationToken = null)
Parameters
@@ -670,7 +646,7 @@
- Parameters
-
System.Threading.CancellationToken
+ CancellationToken
cancellationToken
@@ -687,21 +663,21 @@ Returns
-
System.Threading.Tasks.Task<AccessTokenResponse>
- Task<AccessTokenResponse>
+ GetTokenAsync(RefreshTokenRequest, CancellationToken)
+ GetTokenAsync(RefreshTokenRequest, CancellationToken)
Declaration
+ public async Task<AccessTokenResponse> GetTokenAsync(RefreshTokenRequest request, CancellationToken cancellationToken = default(CancellationToken))
public async Task<AccessTokenResponse> GetTokenAsync(RefreshTokenRequest request, CancellationToken cancellationToken = null)
Parameters
@@ -720,7 +696,7 @@
- Parameters
-
System.Threading.CancellationToken
+ CancellationToken
cancellationToken
@@ -737,21 +713,21 @@ Returns
-
System.Threading.Tasks.Task<AccessTokenResponse>
- Task<AccessTokenResponse>
+ GetTokenAsync(ResourceOwnerTokenRequest, CancellationToken)
+ GetTokenAsync(ResourceOwnerTokenRequest, CancellationToken)
Declaration
+ public async Task<AccessTokenResponse> GetTokenAsync(ResourceOwnerTokenRequest request, CancellationToken cancellationToken = default(CancellationToken))
public async Task<AccessTokenResponse> GetTokenAsync(ResourceOwnerTokenRequest request, CancellationToken cancellationToken = null)
Parameters
@@ -770,7 +746,7 @@
- Parameters
-
System.Threading.CancellationToken
+ CancellationToken
cancellationToken
@@ -787,25 +763,25 @@ Returns
-
System.Threading.Tasks.Task<AccessTokenResponse>
- Task<AccessTokenResponse>
+ Remarks
+ Remarks
request
parameter. If no Realm was specified,
then the grant_type will be set to "password". If a Realm was specified, then the grant_type will be set to "http://auth0.com/oauth/grant-type/password-realm"GetUserInfoAsync(String, CancellationToken)
+ GetUserInfoAsync(String, CancellationToken)
Declaration
+ public Task<UserInfo> GetUserInfoAsync(string accessToken, CancellationToken cancellationToken = default(CancellationToken))
public Task<UserInfo> GetUserInfoAsync(string accessToken, CancellationToken cancellationToken = null)
Parameters
@@ -824,7 +800,7 @@
- Parameters
-
System.Threading.CancellationToken
+ CancellationToken
cancellationToken
@@ -841,24 +817,24 @@ Returns
-
System.Threading.Tasks.Task<UserInfo>
- Task<UserInfo>
+ Remarks
+ Remarks
RevokeRefreshTokenAsync(RevokeRefreshTokenRequest, CancellationToken)
+ RevokeRefreshTokenAsync(RevokeRefreshTokenRequest, CancellationToken)
Declaration
+ public Task RevokeRefreshTokenAsync(RevokeRefreshTokenRequest request, CancellationToken cancellationToken = default(CancellationToken))
public Task RevokeRefreshTokenAsync(RevokeRefreshTokenRequest request, CancellationToken cancellationToken = null)
Parameters
@@ -877,7 +853,7 @@
- Parameters
-
System.Threading.CancellationToken
+ CancellationToken
cancellationToken
@@ -894,20 +870,20 @@ Returns
-
System.Threading.Tasks.Task
- Task
+ SignupUserAsync(SignupUserRequest, CancellationToken)
+ SignupUserAsync(SignupUserRequest, CancellationToken)
Declaration
+ public Task<SignupUserResponse> SignupUserAsync(SignupUserRequest request, CancellationToken cancellationToken = default(CancellationToken))
public Task<SignupUserResponse> SignupUserAsync(SignupUserRequest request, CancellationToken cancellationToken = null)
Parameters
@@ -926,7 +902,7 @@
- Parameters
-
System.Threading.CancellationToken
+ CancellationToken
cancellationToken
@@ -943,21 +919,21 @@ Returns
-
System.Threading.Tasks.Task<SignupUserResponse>
- Task<SignupUserResponse>
+ StartDeviceFlowAsync(DeviceCodeRequest, CancellationToken)
+ StartDeviceFlowAsync(DeviceCodeRequest, CancellationToken)
Declaration
+ public Task<DeviceCodeResponse> StartDeviceFlowAsync(DeviceCodeRequest request, CancellationToken cancellationToken = default(CancellationToken))
public Task<DeviceCodeResponse> StartDeviceFlowAsync(DeviceCodeRequest request, CancellationToken cancellationToken = null)
Parameters
@@ -976,7 +952,7 @@
- Parameters
-
System.Threading.CancellationToken
+ CancellationToken
cancellationToken
@@ -993,21 +969,21 @@ Returns
-
System.Threading.Tasks.Task<DeviceCodeResponse>
- Task<DeviceCodeResponse>
+ StartPasswordlessEmailFlowAsync(PasswordlessEmailRequest, CancellationToken)
+ StartPasswordlessEmailFlowAsync(PasswordlessEmailRequest, CancellationToken)
Declaration
+ public Task<PasswordlessEmailResponse> StartPasswordlessEmailFlowAsync(PasswordlessEmailRequest request, CancellationToken cancellationToken = default(CancellationToken))
public Task<PasswordlessEmailResponse> StartPasswordlessEmailFlowAsync(PasswordlessEmailRequest request, CancellationToken cancellationToken = null)
Parameters
@@ -1026,7 +1002,7 @@
- Parameters
-
System.Threading.CancellationToken
+ CancellationToken
cancellationToken
@@ -1043,21 +1019,21 @@ Returns
-
System.Threading.Tasks.Task<PasswordlessEmailResponse>
- Task<PasswordlessEmailResponse>
+ StartPasswordlessSmsFlowAsync(PasswordlessSmsRequest, CancellationToken)
+ StartPasswordlessSmsFlowAsync(PasswordlessSmsRequest, CancellationToken)
Declaration
+ public Task<PasswordlessSmsResponse> StartPasswordlessSmsFlowAsync(PasswordlessSmsRequest request, CancellationToken cancellationToken = default(CancellationToken))
public Task<PasswordlessSmsResponse> StartPasswordlessSmsFlowAsync(PasswordlessSmsRequest request, CancellationToken cancellationToken = null)
Parameters
@@ -1076,7 +1052,7 @@
- Parameters
-
System.Threading.CancellationToken
+ CancellationToken
cancellationToken
@@ -1093,8 +1069,8 @@ Returns
-
@@ -1105,20 +1081,7 @@ System.Threading.Tasks.Task<PasswordlessSmsResponse>
- Task<PasswordlessSmsResponse>
+ Implements
IAuthenticationApiClient
Extension Methods
-
-
-
-
diff --git a/docs/api/Auth0.AuthenticationApi.AuthenticationApiClientExtensions.html b/docs/api/Auth0.AuthenticationApi.AuthenticationApiClientExtensions.html
index 3aa0ffd6c..5a90e5eee 100644
--- a/docs/api/Auth0.AuthenticationApi.AuthenticationApiClientExtensions.html
+++ b/docs/api/Auth0.AuthenticationApi.AuthenticationApiClientExtensions.html
@@ -81,35 +81,11 @@ Inheritance
Inherited Members
- Namespace: Auth0.AuthenticationApi
Assembly: Auth0.AuthenticationApi.dll
Syntax
+ public static class AuthenticationApiClientExtensions
public static class AuthenticationApiClientExtensions : object
Methods
diff --git a/docs/api/Auth0.AuthenticationApi.Builders.AuthorizationUrlBuilder.html b/docs/api/Auth0.AuthenticationApi.Builders.AuthorizationUrlBuilder.html
index c217d34d1..976b08c0b 100644
--- a/docs/api/Auth0.AuthenticationApi.Builders.AuthorizationUrlBuilder.html
+++ b/docs/api/Auth0.AuthenticationApi.Builders.AuthorizationUrlBuilder.html
@@ -96,27 +96,6 @@ Inherited Members
- Namespace: Auth0.AuthenticationApi.Builders
Assembly: Auth0.AuthenticationApi.dll
@@ -151,13 +130,13 @@ Parameters
System.String
baseUrl
- AuthorizationUrlBuilder(Uri)
+ AuthorizationUrlBuilder(Uri)
Parameters
-
@@ -576,7 +555,7 @@ System.Uri
+ Uri
baseUrl
- Returns
- WithRedirectUrl(Uri)
+ WithRedirectUrl(Uri)
redirect_uri
query string parameter specifying the redirect URI.Parameters
-
diff --git a/docs/api/Auth0.AuthenticationApi.Builders.LogoutUrlBuilder.html b/docs/api/Auth0.AuthenticationApi.Builders.LogoutUrlBuilder.html
index 12edaf5e2..88a00bf04 100644
--- a/docs/api/Auth0.AuthenticationApi.Builders.LogoutUrlBuilder.html
+++ b/docs/api/Auth0.AuthenticationApi.Builders.LogoutUrlBuilder.html
@@ -96,27 +96,6 @@ System.Uri
+ Uri
uri
- Inherited Members
- Namespace: Auth0.AuthenticationApi.Builders
Assembly: Auth0.AuthenticationApi.dll
@@ -151,13 +130,13 @@ Parameters
- System.String
baseUrl
- LogoutUrlBuilder(Uri)
+ LogoutUrlBuilder(Uri)
Parameters
-
@@ -297,7 +276,7 @@ System.Uri
+ Uri
baseUrl
- Returns
- WithReturnUrl(Uri)
+ WithReturnUrl(Uri)
redirect_uri
query string parameter specifying the redirect URI.Parameters
-
diff --git a/docs/api/Auth0.AuthenticationApi.Builders.SamlUrlBuilder.html b/docs/api/Auth0.AuthenticationApi.Builders.SamlUrlBuilder.html
index fe0e7ecb0..22b7d5f9d 100644
--- a/docs/api/Auth0.AuthenticationApi.Builders.SamlUrlBuilder.html
+++ b/docs/api/Auth0.AuthenticationApi.Builders.SamlUrlBuilder.html
@@ -96,27 +96,6 @@ System.Uri
+ Uri
uri
- Inherited Members
- Namespace: Auth0.AuthenticationApi.Builders
Assembly: Auth0.AuthenticationApi.dll
@@ -151,7 +130,7 @@ Parameters
System.String
baseUrl
-
@@ -163,7 +142,7 @@
Parameters
- SamlUrlBuilder(Uri, String)
+ SamlUrlBuilder(Uri, String)
Parameters
-
System.Uri
+ Uri
baseUrl
-
@@ -241,7 +220,7 @@
- Returns
WithRelayState(IDictionary<String, String>)
+ WithRelayState(IDictionary<String, String>)
RelayState
query string parameter.Parameters
-
- System.Collections.Generic.IDictionary<System.String, System.String>
+ IDictionary<System.String, System.String>
values
@@ -283,7 +262,7 @@ RelayState
parameter.Returns
Remarks
+ Remarks
Inheritance
Inherited Members
- Namespace: Auth0.AuthenticationApi.Builders
Assembly: Auth0.AuthenticationApi.dll
Syntax
+ public class UrlBuilderBase<T>
- where T : UrlBuilderBase<T>
public class UrlBuilderBase<T> : object where T : UrlBuilderBase<T>
Type Parameters
@@ -156,7 +131,7 @@
- Parameters
System.String
baseUrl
-
@@ -167,23 +142,8 @@
Parameters
Exceptions
-
-
-
-
-
-
-
- Type
- Condition
-
-
-
- System.ArgumentNullException
-
- UrlBuilderBase(Uri, String)
+ UrlBuilderBase(Uri, String)
Parameters
-
System.Uri
+ Uri
baseUrl
-
@@ -215,21 +175,6 @@
- Parameters
Exceptions
-
-
-
-
-
-
- Type
- Condition
-
-
-
- System.ArgumentNullException
-
- Methods
@@ -322,8 +267,8 @@ Returns
-
diff --git a/docs/api/Auth0.AuthenticationApi.Builders.WsFedUrlBuilder.html b/docs/api/Auth0.AuthenticationApi.Builders.WsFedUrlBuilder.html
index e83caa0f6..a74f58f0c 100644
--- a/docs/api/Auth0.AuthenticationApi.Builders.WsFedUrlBuilder.html
+++ b/docs/api/Auth0.AuthenticationApi.Builders.WsFedUrlBuilder.html
@@ -96,27 +96,6 @@ System.Uri
- Uri
+ Inherited Members
- Namespace: Auth0.AuthenticationApi.Builders
Assembly: Auth0.AuthenticationApi.dll
@@ -148,7 +127,7 @@ Parameters
System.String
baseUrl
-
@@ -160,7 +139,7 @@
Parameters
- WsFedUrlBuilder(Uri, String)
+ WsFedUrlBuilder(Uri, String)
Parameters
-
System.Uri
+ Uri
baseUrl
-
@@ -238,7 +217,7 @@
- Returns
WithWctx(IDictionary<String, String>)
+ WithWctx(IDictionary<String, String>)
wctx
query string parameter.Parameters
-
- System.Collections.Generic.IDictionary<System.String, System.String>
+ IDictionary<System.String, System.String>
values
diff --git a/docs/api/Auth0.AuthenticationApi.HttpClientAuthenticationConnection.html b/docs/api/Auth0.AuthenticationApi.HttpClientAuthenticationConnection.html
index 9c59a8998..824c85013 100644
--- a/docs/api/Auth0.AuthenticationApi.HttpClientAuthenticationConnection.html
+++ b/docs/api/Auth0.AuthenticationApi.HttpClientAuthenticationConnection.html
@@ -73,7 +73,7 @@
wctx
parameter.Class HttpClientAuthenticationConnection
- Inheritance
- Inherited Members
- Namespace: Auth0.AuthenticationApi
Assembly: Auth0.AuthenticationApi.dll
Syntax
+ public class HttpClientAuthenticationConnection : IAuthenticationConnection, IDisposable
public class HttpClientAuthenticationConnection : object, IAuthenticationConnection
Constructors
- HttpClientAuthenticationConnection(HttpClient)
+ HttpClientAuthenticationConnection(HttpClient)
Parameters
-
- System.Net.Http.HttpClient
+ HttpClient
httpClient
- Remarks
- Remarks
+ HttpClientAuthenticationConnection(HttpMessageHandler)
+ HttpClientAuthenticationConnection(HttpMessageHandler)
Declaration
@@ -173,9 +149,9 @@ Parameters
-
@@ -184,7 +160,7 @@ System.Net.Http.HttpMessageHandler
+ HttpMessageHandler
handler
- Methods
Dispose()
- Declaration
@@ -193,7 +169,7 @@ Declaration
Dispose(Boolean)
- Declaration
@@ -219,14 +195,14 @@ Parameters
GetAsync<T>(Uri, IDictionary<String, String>, CancellationToken)
+ GetAsync<T>(Uri, IDictionary<String, String>, CancellationToken)
uri
with optional headers
as
an asynchronous operation.Declaration
+ public async Task<T> GetAsync<T>(Uri uri, IDictionary<string, string> headers = null, CancellationToken cancellationToken = default(CancellationToken))
public async Task<T> GetAsync<T>(Uri uri, IDictionary<string, string> headers = null, CancellationToken cancellationToken = null)
Parameters
@@ -239,19 +215,19 @@
- Parameters
-
System.Uri
+ Uri
uri
-
-
System.Collections.Generic.IDictionary<System.String, System.String>
+ IDictionary<System.String, System.String>
headers
-
System.Threading.CancellationToken
+ CancellationToken
cancellationToken
@@ -268,7 +244,7 @@ Returns
-
@@ -291,13 +267,13 @@ System.Threading.Tasks.Task<T>
+ Task<T>
Type Parameters
SendAsync<T>(HttpMethod, Uri, Object, IDictionary<String, String>, CancellationToken)
+ SendAsync<T>(HttpMethod, Uri, Object, IDictionary<String, String>, CancellationToken)
uri
using the HTTP method
as an asynchronous operation.Declaration
+ public async Task<T> SendAsync<T>(HttpMethod method, Uri uri, object body, IDictionary<string, string> headers = null, CancellationToken cancellationToken = default(CancellationToken))
public async Task<T> SendAsync<T>(HttpMethod method, Uri uri, object body, IDictionary<string, string> headers = null, CancellationToken cancellationToken = null)
Parameters
- IdTokenValidationKeyMissingException(String, Exception)
+ IdTokenValidationKeyMissingException(String, Exception)
Declaration
@@ -245,17 +182,13 @@ Parameters
-
- System.Exception
+ Exception
innerException
Implements
- IAuthenticationApiClient.
Implements the IAuthenticationConnection using System.Net.Http.HttpClient which
+ Implements the IAuthenticationConnection using
public class ApiError
+ public class ApiError : object
Parse a System.Net.Http.HttpResponseMessage into an ApiError asynchronously.
+Parse a
System.Net.Http.HttpResponseMessage to parse.
+System.Threading.Tasks.Task representing the operation and associated ApiError on +
[Serializable]
-public abstract class ApiException : Exception, ISerializable
+ public abstract class ApiException : Exception
protected ApiException()
- Initializes a new instance of the ApiException class with a specified error message and a reference to the inner exception that is the cause of this exception.
The exception that is the cause of the current exception, or a null reference if no inner exception is specified.
@@ -258,8 +195,8 @@Create an instance of the specific exception required for this unsuccessful System.Net.Http.HttpResponseMessage.
+Create an instance of the specific exception required for this unsuccessful
System.Net.Http.HttpResponseMessage to parse for the correct exception.
+An instance of a ApiException subclass containing the appropriate exception for this response.
[Serializable]
-public class ErrorApiException : ApiException, ISerializable
+ public class ErrorApiException : ApiException
public ErrorApiException()
- Initializes a new instance of the ApiException class with a specified
statusCode
and optional apiError
.
System.Net.HttpStatusCodecode of the failing API call.
+Initializes a new instance of the ErrorApiException class with a specified error message and a reference to the inner exception that is the cause of this exception.
The exception that is the cause of the current exception, or a null reference if no inner exception is specified.
@@ -319,7 +259,7 @@System.Net.HttpStatusCode code from the failing API call.
+public class RateLimit
+ public class RateLimit : object
Parse the rate limit headers into a RateLimit object.
System.Net.Http.Headers.HttpHeaders to parse.
+[Serializable]
-public class RateLimitApiException : ApiException, ISerializable
+ public class RateLimitApiException : ApiException
Initializes a new instance of the RateLimitApiException class with a specified error message and a reference to the inner exception that is the cause of this exception.
The exception that is the cause of the current exception, or a null reference if no inner exception is specified.
@@ -340,10 +280,6 @@Create an action.
public Task<Action> CreateAsync(CreateActionRequest request, CancellationToken cancellationToken = default(CancellationToken))
+ public Task<Action> CreateAsync(CreateActionRequest request, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -213,23 +192,23 @@
System.Threading.Tasks.Task<Action> | +Task<Action> | The new Action that has been created. |
Once an action is created, it must be deployed, and then bound to a trigger before it will be executed as part of a flow.
Deletes an action and all of its associated versions.
public Task DeleteAsync(string id, DeleteActionRequest request = null, CancellationToken cancellationToken = default(CancellationToken))
+ public Task DeleteAsync(string id, DeleteActionRequest request = null, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -271,23 +250,23 @@
System.Threading.Tasks.Task | -A System.Threading.Tasks.Task that represents the asynchronous delete operation. + | Task | +A |
An action must be unbound from all triggers before it can be deleted.
Deploy an action.
public Task<ActionVersion> DeployAsync(string id, CancellationToken cancellationToken = default(CancellationToken))
+ public Task<ActionVersion> DeployAsync(string id, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -323,24 +302,24 @@
System.Threading.Tasks.Task<ActionVersion> | +Task<ActionVersion> | The action version that was created. |
Deploying an action will create a new immutable version of the action. If the action is currently bound to a trigger, then the system will begin executing the newly deployed version of the action immediately.Otherwise, the action will only be executed as a part of a flow once it is bound to that flow.
Retrieve all actions.
public Task<IPagedList<Action>> GetAllAsync(GetActionsRequest request, PaginationInfo pagination, CancellationToken cancellationToken = default(CancellationToken))
+ public Task<IPagedList<Action>> GetAllAsync(GetActionsRequest request, PaginationInfo pagination, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -382,20 +361,20 @@
System.Threading.Tasks.Task<IPagedList<Action>> | +Task<IPagedList<Action>> | An IPagedList<T> containing the actions. |
Retrieve the actions that are bound to a trigger.
public Task<IPagedList<TriggerBinding>> GetAllTriggerBindingsAsync(string triggerId, PaginationInfo pagination, CancellationToken cancellationToken = default(CancellationToken))
+ public Task<IPagedList<TriggerBinding>> GetAllTriggerBindingsAsync(string triggerId, PaginationInfo pagination, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -437,24 +416,24 @@
System.Threading.Tasks.Task<IPagedList<TriggerBinding>> | +Task<IPagedList<TriggerBinding>> | The retrieved trigger bindings. |
Once an action is created and deployed, it must be attached (i.e. bound) to a trigger so that it will be executed as part of a flow. The list of actions returned reflects the order in which they will be executed during the appropriate flow.
Retrieve the set of triggers currently available within actions. A trigger is an extensibility point to which actions can be bound
public Task<IList<Trigger>> GetAllTriggersAsync(CancellationToken cancellationToken = default(CancellationToken))
+ public Task<IList<Trigger>> GetAllTriggersAsync(CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -484,20 +463,20 @@
System.Threading.Tasks.Task<System.Collections.Generic.IList<Trigger>> | +Task<IList<Trigger>> | A list containing the triggers. |
Retrieve all versions of an action.
public Task<IPagedList<ActionVersion>> GetAllVersionsAsync(string actionId, PaginationInfo pagination, CancellationToken cancellationToken = default(CancellationToken))
+ public Task<IPagedList<ActionVersion>> GetAllVersionsAsync(string actionId, PaginationInfo pagination, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -539,23 +518,23 @@
System.Threading.Tasks.Task<IPagedList<ActionVersion>> | +Task<IPagedList<ActionVersion>> | The retrieved versions of the specified action. |
An action version is created whenever an action is deployed. An action version is immutable, once created.
Retrieve an action by its ID.
public Task<Action> GetAsync(string id, CancellationToken cancellationToken = default(CancellationToken))
+ public Task<Action> GetAsync(string id, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -591,20 +570,20 @@
System.Threading.Tasks.Task<Action> | +Task<Action> | The retrieved action. |
Retrieve information about a specific execution of a trigger.
public Task<ActionExecution> GetExecutionAsync(string id, CancellationToken cancellationToken = default(CancellationToken))
+ public Task<ActionExecution> GetExecutionAsync(string id, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -640,24 +619,24 @@
System.Threading.Tasks.Task<ActionExecution> | +Task<ActionExecution> | The retrieved execution. |
Relevant execution IDs will be included in tenant logs generated as part of that authentication flow. Executions will only be stored for 10 days after their creation.
Retrieve a specific version of an action.
public Task<ActionVersion> GetVersionAsync(string actionId, string versionId, CancellationToken cancellationToken = default(CancellationToken))
+ public Task<ActionVersion> GetVersionAsync(string actionId, string versionId, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -699,23 +678,23 @@
System.Threading.Tasks.Task<ActionVersion> | +Task<ActionVersion> | The retrieved version of the specified action. |
An action version is created whenever an action is deployed. An action version is immutable, once created.
Performs the equivalent of a roll-back of an action to an earlier, specified version.
public Task<ActionVersion> RollbackToVersionAsync(string actionId, string versionId, CancellationToken cancellationToken = default(CancellationToken))
+ public Task<ActionVersion> RollbackToVersionAsync(string actionId, string versionId, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -757,24 +736,24 @@
System.Threading.Tasks.Task<ActionVersion> | -A System.Threading.Tasks.Task that represents the asynchronous delete operation. + | Task<ActionVersion> | +A |
Creates a new, deployed action version that is identical to the specified version. If this action is currently bound to a trigger, the system will begin executing the newly-created version immediately.
Update an existing action.
public Task<Action> UpdateAsync(string id, UpdateActionRequest request, CancellationToken cancellationToken = default(CancellationToken))
+ public Task<Action> UpdateAsync(string id, UpdateActionRequest request, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -816,17 +795,17 @@
System.Threading.Tasks.Task<Action> | +Task<Action> | The Action that was updated. |
If this action is currently bound to a trigger, updating it will not affect any user flows until the action is deployed.
Update the actions that are bound (i.e. attached) to a trigger. Once an action is created and deployed, it must be attached(i.e.bound) to a trigger so that it will be executed as part of a flow. The order in which the actions are provided will determine the order in which they are executed.
@@ -834,7 +813,7 @@public Task<IList<TriggerBinding>> UpdateTriggerBindingsAsync(string triggerId, UpdateTriggerBindingsRequest request, CancellationToken cancellationToken = default(CancellationToken))
+ public Task<IList<TriggerBinding>> UpdateTriggerBindingsAsync(string triggerId, UpdateTriggerBindingsRequest request, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -876,7 +855,7 @@ ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
System.Threading.Tasks.Task<System.Collections.Generic.IList<TriggerBinding>> | +Task<IList<TriggerBinding>> | The trigger bindings. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
System.Uri | +Uri | baseUri | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
System.Collections.Generic.IDictionary<System.String, System.String> | +IDictionary<System.String, System.String> | defaultHeaders |
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -206,20 +185,20 @@
System.Threading.Tasks.Task<BreachedPasswordDetection> | +Task<BreachedPasswordDetection> | A Auth0.ManagementApi.Clients.AttackProtectionClient.BreachedPasswordDetection containing the configuration. |
Get the brute force configuration.
public Task<BruteForceProtection> GetBruteForceProtectionAsync(CancellationToken cancellationToken = default(CancellationToken))
+ public Task<BruteForceProtection> GetBruteForceProtectionAsync(CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -249,20 +228,20 @@
System.Threading.Tasks.Task<BruteForceProtection> | +Task<BruteForceProtection> | A Auth0.ManagementApi.Clients.AttackProtectionClient.BruteForceProtection containing the configuration. |
Get the suspicious IP throttling configuration.
public Task<SuspiciousIpThrottling> GetSuspiciousIpThrottlingAsync(CancellationToken cancellationToken = default(CancellationToken))
+ public Task<SuspiciousIpThrottling> GetSuspiciousIpThrottlingAsync(CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -292,20 +271,20 @@
System.Threading.Tasks.Task<SuspiciousIpThrottling> | +Task<SuspiciousIpThrottling> | A SuspiciousIpThrottling containing the configuration. |
Update breached password detection settings.
public Task<BreachedPasswordDetection> UpdateBreachedPasswordDetectionAsync(BreachedPasswordDetection request, CancellationToken cancellationToken = default(CancellationToken))
+ public Task<BreachedPasswordDetection> UpdateBreachedPasswordDetectionAsync(BreachedPasswordDetection request, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -341,20 +320,20 @@
System.Threading.Tasks.Task<BreachedPasswordDetection> | +Task<BreachedPasswordDetection> | The Auth0.ManagementApi.Clients.AttackProtectionClient.BreachedPasswordDetection that was updated. |
Update the brute force configuration.
public Task<BruteForceProtection> UpdateBruteForceProtectionAsync(BruteForceProtection request, CancellationToken cancellationToken = default(CancellationToken))
+ public Task<BruteForceProtection> UpdateBruteForceProtectionAsync(BruteForceProtection request, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -390,20 +369,20 @@
System.Threading.Tasks.Task<BruteForceProtection> | +Task<BruteForceProtection> | The Auth0.ManagementApi.Clients.AttackProtectionClient.BruteForceProtection that was updated. |
Update the suspicious IP throttling configuration.
public Task<SuspiciousIpThrottling> UpdateSuspiciousIpThrottlingAsync(SuspiciousIpThrottling request, CancellationToken cancellationToken = default(CancellationToken))
+ public Task<SuspiciousIpThrottling> UpdateSuspiciousIpThrottlingAsync(SuspiciousIpThrottling request, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -439,7 +418,7 @@ ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
System.Threading.Tasks.Task<SuspiciousIpThrottling> | +Task<SuspiciousIpThrottling> | The SuspiciousIpThrottling that was updated. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
System.Uri | +Uri | baseUri | -System.Uri of the endpoint to use in making API calls. + | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
System.Collections.Generic.IDictionary<System.String, System.String> | +IDictionary<System.String, System.String> | defaultHeaders | Dictionary containing default headers included with every request this client makes. |
@@ -185,7 +161,7 @@ ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
System.Uri | +Uri | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
System.Collections.Generic.IDictionary<System.String, System.String> | +IDictionary<System.String, System.String> | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
System.Collections.Generic.IDictionary<System.String, System.String> | +IDictionary<System.String, System.String> | queryStrings | Query strings that should be combined with the URL. |
@@ -301,7 +277,7 @@ ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
System.Uri | +Uri | Completed absolute URI for the request. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
System.Uri | +Uri | baseUri | -System.Uri of the endpoint to use in making API calls. + | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
System.Collections.Generic.IDictionary<System.String, System.String> | +IDictionary<System.String, System.String> | defaultHeaders | Dictionary containing default headers included with every request this client makes. |
@@ -175,13 +154,13 @@
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -217,20 +196,20 @@
System.Threading.Tasks.Task | -A System.Threading.Tasks.Task that represents the asynchronous create operation. + | Task | +A |
Gets all the blacklisted claims.
public Task<IList<BlacklistedToken>> GetAllAsync(string aud, CancellationToken cancellationToken = default(CancellationToken))
+ public Task<IList<BlacklistedToken>> GetAllAsync(string aud, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -266,7 +245,7 @@ ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
System.Threading.Tasks.Task<System.Collections.Generic.IList<BlacklistedToken>> | +Task<IList<BlacklistedToken>> | A list of BlacklistedToken objects. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
System.Uri | +Uri | baseUri | -System.Uri of the endpoint to use in making API calls. + | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
System.Collections.Generic.IDictionary<System.String, System.String> | +IDictionary<System.String, System.String> | defaultHeaders | Dictionary containing default headers included with every request this client makes. |
@@ -175,13 +154,13 @@
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -211,20 +190,20 @@
System.Threading.Tasks.Task | -A System.Threading.Tasks.Task that represents the asynchronous delete operation. + | Task | +A |
Retrieves branding settings for a tenant.
public Task<Branding> GetAsync(CancellationToken cancellationToken = default(CancellationToken))
+ public Task<Branding> GetAsync(CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -254,20 +233,20 @@
System.Threading.Tasks.Task<Branding> | +Task<Branding> | A Branding containing the branding for the tenant. |
Retrieves the template for the New Universal Login Experience.
public Task<UniversalLoginTemplate> GetUniversalLoginTemplateAsync(CancellationToken cancellationToken = default(CancellationToken))
+ public Task<UniversalLoginTemplate> GetUniversalLoginTemplateAsync(CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -297,20 +276,20 @@
System.Threading.Tasks.Task<UniversalLoginTemplate> | +Task<UniversalLoginTemplate> | The UniversalLoginTemplate for the new universal login experience. |
Sets the template for the New Universal Login Experience.
public Task<UniversalLoginTemplate> SetUniversalLoginTemplateAsync(UniversalLoginTemplateUpdateRequest request, CancellationToken cancellationToken = default(CancellationToken))
+ public Task<UniversalLoginTemplate> SetUniversalLoginTemplateAsync(UniversalLoginTemplateUpdateRequest request, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -346,21 +325,21 @@
System.Threading.Tasks.Task<UniversalLoginTemplate> | +Task<UniversalLoginTemplate> | The newly updated UniversalLoginTemplate. |
s Updates the branding for a tenant.
public Task<Branding> UpdateAsync(BrandingUpdateRequest request, CancellationToken cancellationToken = default(CancellationToken))
+ public Task<Branding> UpdateAsync(BrandingUpdateRequest request, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -396,7 +375,7 @@ ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
System.Threading.Tasks.Task<Branding> | +Task<Branding> | The newly updated Branding. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
System.Uri | +Uri | baseUri | -System.Uri of the endpoint to use in making API calls. + | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
System.Collections.Generic.IDictionary<System.String, System.String> | +IDictionary<System.String, System.String> | defaultHeaders | Dictionary containing default headers included with every request this client makes. |
@@ -175,13 +154,13 @@
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -217,20 +196,20 @@
System.Threading.Tasks.Task<ClientGrant> | +Task<ClientGrant> | The new ClientGrant that has been created. |
Deletes a client grant.
public Task DeleteAsync(string id, CancellationToken cancellationToken = default(CancellationToken))
+ public Task DeleteAsync(string id, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -266,20 +245,20 @@
System.Threading.Tasks.Task | -A System.Threading.Tasks.Task that represents the asynchronous delete operation. + | Task | +A |
Gets a list of all the client grants.
public Task<IPagedList<ClientGrant>> GetAllAsync(GetClientGrantsRequest request, PaginationInfo pagination = null, CancellationToken cancellationToken = default(CancellationToken))
+ public Task<IPagedList<ClientGrant>> GetAllAsync(GetClientGrantsRequest request, PaginationInfo pagination = null, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -321,20 +300,20 @@
System.Threading.Tasks.Task<IPagedList<ClientGrant>> | +Task<IPagedList<ClientGrant>> | A IPagedList<T> containing the client grants requested. |
Updates a client grant.
public Task<ClientGrant> UpdateAsync(string id, ClientGrantUpdateRequest request, CancellationToken cancellationToken = default(CancellationToken))
+ public Task<ClientGrant> UpdateAsync(string id, ClientGrantUpdateRequest request, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -376,7 +355,7 @@ ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
System.Threading.Tasks.Task<ClientGrant> | +Task<ClientGrant> | The ClientGrant that has been updated. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
System.Uri | +Uri | baseUri | -System.Uri of the endpoint to use in making API calls. + | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
System.Collections.Generic.IDictionary<System.String, System.String> | +IDictionary<System.String, System.String> | defaultHeaders | Dictionary containing default headers included with every request this client makes. |
@@ -175,13 +154,13 @@
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -217,20 +196,20 @@
System.Threading.Tasks.Task<Client> | +Task<Client> | The new Client that has been created. |
Creates a new client credential.
public Task<Credential> CreateCredentialAsync(string clientId, ClientCredentialCreateRequest request, CancellationToken cancellationToken = default(CancellationToken))
+ public Task<Credential> CreateCredentialAsync(string clientId, ClientCredentialCreateRequest request, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -272,20 +251,20 @@
System.Threading.Tasks.Task<Credential> | +Task<Credential> | The new Credential that has been created. |
Deletes a client and all its related assets (like rules, connections, etc) given its id.
public Task DeleteAsync(string id, CancellationToken cancellationToken = default(CancellationToken))
+ public Task DeleteAsync(string id, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -321,20 +300,20 @@
System.Threading.Tasks.Task | -A System.Threading.Tasks.Task that represents the asynchronous delete operation. + | Task | +A |
Deletes a specific credential registered with the provided client.
public Task DeleteCredentialAsync(string clientId, string credentialId, CancellationToken cancellationToken = default(CancellationToken))
+ public Task DeleteCredentialAsync(string clientId, string credentialId, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -376,20 +355,20 @@
System.Threading.Tasks.Task | -A System.Threading.Tasks.Task that represents the asynchronous delete operation. + | Task | +A |
Retrieves a list of all client applications.
public Task<IPagedList<Client>> GetAllAsync(GetClientsRequest request, PaginationInfo pagination = null, CancellationToken cancellationToken = default(CancellationToken))
+ public Task<IPagedList<Client>> GetAllAsync(GetClientsRequest request, PaginationInfo pagination = null, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -431,20 +410,20 @@
System.Threading.Tasks.Task<IPagedList<Client>> | +Task<IPagedList<Client>> | An IPagedList<T> containing the clients. |
Retrieves a list of all credentials for a client.
public Task<IList<Credential>> GetAllCredentialsAsync(string clientId, CancellationToken cancellationToken = default(CancellationToken))
+ public Task<IList<Credential>> GetAllCredentialsAsync(string clientId, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -480,20 +459,20 @@
System.Threading.Tasks.Task<System.Collections.Generic.IList<Credential>> | -An System.Collections.Generic.IList<T> containing the client's credentials. + | Task<IList<Credential>> | +An |
Retrieves a client by its id.
public Task<Client> GetAsync(string id, string fields = null, bool includeFields = true, CancellationToken cancellationToken = default(CancellationToken))
+ public Task<Client> GetAsync(string id, string fields = null, bool includeFields = true, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -543,20 +522,20 @@
System.Threading.Tasks.Task<Client> | +Task<Client> | The Client retrieved. |
Retrieves a specific credential for a client.
public Task<Credential> GetCredentialAsync(string clientId, string credentialId, CancellationToken cancellationToken = default(CancellationToken))
+ public Task<Credential> GetCredentialAsync(string clientId, string credentialId, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -598,20 +577,20 @@
System.Threading.Tasks.Task<Credential> | +Task<Credential> | A Credential containing the client's credential. |
Rotate a client secret. The generated secret is NOT base64 encoded.
public Task<Client> RotateClientSecret(string id, CancellationToken cancellationToken = default(CancellationToken))
+ public Task<Client> RotateClientSecret(string id, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -647,20 +626,20 @@
System.Threading.Tasks.Task<Client> | +Task<Client> | The Client that has had its secret rotated. |
Updates a client application.
public Task<Client> UpdateAsync(string id, ClientUpdateRequest request, CancellationToken cancellationToken = default(CancellationToken))
+ public Task<Client> UpdateAsync(string id, ClientUpdateRequest request, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -702,20 +681,20 @@
System.Threading.Tasks.Task<Client> | +Task<Client> | The Client that was updated. |
Update a client credential.
public Task<Credential> UpdateCredentialAsync(string clientId, string credentialId, ClientCredentialUpdateRequest request, CancellationToken cancellationToken = default(CancellationToken))
+ public Task<Credential> UpdateCredentialAsync(string clientId, string credentialId, ClientCredentialUpdateRequest request, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -763,7 +742,7 @@ ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
System.Threading.Tasks.Task<Credential> | +Task<Credential> | The new Credential that has been created. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
System.Uri | +Uri | baseUri | -System.Uri of the endpoint to use in making API calls. + | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
System.Collections.Generic.IDictionary<System.String, System.String> | +IDictionary<System.String, System.String> | defaultHeaders | Dictionary containing default headers included with every request this client makes. |
@@ -175,13 +154,13 @@
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -217,20 +196,20 @@
System.Threading.Tasks.Task | -A System.Threading.Tasks.Task that represents the asynchronous check operation. Will throw if the check fails. + | Task | +A |
Creates a new connection according to the request.
public Task<Connection> CreateAsync(ConnectionCreateRequest request, CancellationToken cancellationToken = default(CancellationToken))
+ public Task<Connection> CreateAsync(ConnectionCreateRequest request, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -266,20 +245,20 @@
System.Threading.Tasks.Task<Connection> | +Task<Connection> | A Connection containing the newly created Connection. |
Deletes a connection and all its users.
public Task DeleteAsync(string id, CancellationToken cancellationToken = default(CancellationToken))
+ public Task DeleteAsync(string id, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -315,20 +294,20 @@
System.Threading.Tasks.Task | -A System.Threading.Tasks.Task that represents the asynchronous delete operation. + | Task | +A |
Deletes a specified connection user by its email
.
public Task DeleteUserAsync(string id, string email, CancellationToken cancellationToken = default(CancellationToken))
+ public Task DeleteUserAsync(string id, string email, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -370,23 +349,23 @@
System.Threading.Tasks.Task | -A System.Threading.Tasks.Task that represents the asynchronous delete operation. + | Task | +A |
Currently only database connections are supported and you cannot delete all users from specific connection.
Retrieves every connection matching the specified strategy. All connections are retrieved if no strategy is being specified. Accepts a list of fields to include or exclude in the resulting list of connection objects.
public Task<IPagedList<Connection>> GetAllAsync(GetConnectionsRequest request, PaginationInfo pagination = null, CancellationToken cancellationToken = default(CancellationToken))
+ public Task<IPagedList<Connection>> GetAllAsync(GetConnectionsRequest request, PaginationInfo pagination = null, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -428,20 +407,20 @@
System.Threading.Tasks.Task<IPagedList<Connection>> | +Task<IPagedList<Connection>> | An IPagedList<T> containing the list of connections. |
Retrieves a connection by its id
.
public Task<Connection> GetAsync(string id, string fields = null, bool includeFields = true, CancellationToken cancellationToken = default(CancellationToken))
+ public Task<Connection> GetAsync(string id, string fields = null, bool includeFields = true, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -489,20 +468,20 @@
System.Threading.Tasks.Task<Connection> | +Task<Connection> | The Connection. |
Updates a connection.
public Task<Connection> UpdateAsync(string id, ConnectionUpdateRequest request, CancellationToken cancellationToken = default(CancellationToken))
+ public Task<Connection> UpdateAsync(string id, ConnectionUpdateRequest request, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -544,7 +523,7 @@ ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
System.Threading.Tasks.Task<Connection> | +Task<Connection> | The Connection that has been updated. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
System.Uri | +Uri | baseUri | -System.Uri of the endpoint to use in making API calls. + | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
System.Collections.Generic.IDictionary<System.String, System.String> | +IDictionary<System.String, System.String> | defaultHeaders | Dictionary containing default headers included with every request this client makes. |
@@ -175,13 +154,13 @@
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -217,23 +196,23 @@
System.Threading.Tasks.Task<CustomDomain> | +Task<CustomDomain> | The CustomDomain containing the newly created custom domain. |
The custom domain will need to be verified before it starts accepting requests.
Deletes a custom domain by its ID.
public Task DeleteAsync(string id, CancellationToken cancellationToken = default(CancellationToken))
+ public Task DeleteAsync(string id, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -269,23 +248,23 @@
System.Threading.Tasks.Task | -A System.Threading.Tasks.Task that represents the asyncronous delete operation. + | Task | +A |
When deleted, Auth0 will stop serving requests for this domain.
Retrieves the status of every custom domain.
public Task<IList<CustomDomain>> GetAllAsync(CancellationToken cancellationToken = default(CancellationToken))
+ public Task<IList<CustomDomain>> GetAllAsync(CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | |
System.Threading.Tasks.Task<System.Collections.Generic.IList<CustomDomain>> | -A System.Collections.Generic.IList<T> containing the details of every custom domain. + | Task<IList<CustomDomain>> | +A |
Retrieves a custom domain status by its ID
public Task<CustomDomain> GetAsync(string id, CancellationToken cancellationToken = default(CancellationToken))
+ public Task<CustomDomain> GetAsync(string id, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -363,20 +342,20 @@
System.Threading.Tasks.Task<CustomDomain> | +Task<CustomDomain> | The CustomDomain that was requested. |
Run the verification process for the custom domain.
public Task<CustomDomainVerificationResponse> VerifyAsync(string id, CancellationToken cancellationToken = default(CancellationToken))
+ public Task<CustomDomainVerificationResponse> VerifyAsync(string id, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -412,7 +391,7 @@ ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
System.Threading.Tasks.Task<CustomDomainVerificationResponse> | +Task<CustomDomainVerificationResponse> | The CustomDomainVerification that was requested. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
System.Uri | +Uri | baseUri | -System.Uri of the endpoint to use in making API calls. + | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
System.Collections.Generic.IDictionary<System.String, System.String> | +IDictionary<System.String, System.String> | defaultHeaders | Dictionary containing default headers included with every request this client makes. |
@@ -175,13 +154,13 @@
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -217,20 +196,20 @@
System.Threading.Tasks.Task<DeviceCredential> | +Task<DeviceCredential> | The newly created DeviceCredential. |
Deletes a device credential.
public Task DeleteAsync(string id, CancellationToken cancellationToken = default(CancellationToken))
+ public Task DeleteAsync(string id, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -266,20 +245,20 @@
System.Threading.Tasks.Task | -A System.Threading.Tasks.Task that represents the asynchronous delete operation. + | Task | +A |
Gets a list of all the device credentials.
public Task<IPagedList<DeviceCredential>> GetAllAsync(GetDeviceCredentialsRequest request, PaginationInfo pagination = null, CancellationToken cancellationToken = default(CancellationToken))
+ public Task<IPagedList<DeviceCredential>> GetAllAsync(GetDeviceCredentialsRequest request, PaginationInfo pagination = null, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -321,21 +300,20 @@
System.Threading.Tasks.Task<IPagedList<DeviceCredential>> | +Task<IPagedList<DeviceCredential>> | A list of DeviceCredential which conforms to the criteria specified. |
Gets a list of all the device credentials.
[Obsolete("Getting a list of device credentials without pagination is not recommended. Please use the overload that accepts pagination information.")]
-public Task<IList<DeviceCredential>> GetAllAsync(string fields = null, bool includeFields = true, string userId = null, string clientId = null, string type = null, CancellationToken cancellationToken = default(CancellationToken))
+ public Task<IList<DeviceCredential>> GetAllAsync(string fields = null, bool includeFields = true, string userId = null, string clientId = null, string type = null, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -395,7 +373,7 @@ ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
System.Threading.Tasks.Task<System.Collections.Generic.IList<DeviceCredential>> | +Task<IList<DeviceCredential>> | A list of DeviceCredential which conforms to the criteria specified. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
System.Uri | +Uri | baseUri | -System.Uri of the endpoint to use in making API calls. + | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
System.Collections.Generic.IDictionary<System.String, System.String> | +IDictionary<System.String, System.String> | defaultHeaders | Dictionary containing default headers included with every request this client makes. |
@@ -175,13 +154,13 @@
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -218,20 +197,20 @@
System.Threading.Tasks.Task<EmailProvider> | +Task<EmailProvider> | A EmailProvider instance containing the email provider details. |
Deletes the email provider.
public Task DeleteAsync(CancellationToken cancellationToken = default(CancellationToken))
+ public Task DeleteAsync(CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | |
System.Threading.Tasks.Task | -A System.Threading.Tasks.Task that represents the asynchronous delete operation. + | Task | +A |
Gets the email provider.
public Task<EmailProvider> GetAsync(string fields = null, bool includeFields = true, CancellationToken cancellationToken = default(CancellationToken))
+ public Task<EmailProvider> GetAsync(string fields = null, bool includeFields = true, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -317,20 +296,20 @@
System.Threading.Tasks.Task<EmailProvider> | +Task<EmailProvider> | A EmailProvider instance containing the email provider details. |
Updates the email provider.
public Task<EmailProvider> UpdateAsync(EmailProviderUpdateRequest request, CancellationToken cancellationToken = default(CancellationToken))
+ public Task<EmailProvider> UpdateAsync(EmailProviderUpdateRequest request, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -367,7 +346,7 @@ ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
System.Threading.Tasks.Task<EmailProvider> | +Task<EmailProvider> | A EmailProvider instance containing the email provider details. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
System.Uri | +Uri | baseUri | -System.Uri of the endpoint to use in making API calls. + | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
System.Collections.Generic.IDictionary<System.String, System.String> | +IDictionary<System.String, System.String> | defaultHeaders | Dictionary containing default headers included with every request this client makes. |
@@ -175,13 +154,13 @@
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -217,20 +196,20 @@
System.Threading.Tasks.Task<EmailTemplate> | +Task<EmailTemplate> | The newly created EmailTemplate. |
Gets an email template.
public Task<EmailTemplate> GetAsync(EmailTemplateName templateName, CancellationToken cancellationToken = default(CancellationToken))
+ public Task<EmailTemplate> GetAsync(EmailTemplateName templateName, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -266,20 +245,20 @@
System.Threading.Tasks.Task<EmailTemplate> | +Task<EmailTemplate> | The EmailTemplate that was requested. |
Updates an email template.
public Task<EmailTemplate> PatchAsync(EmailTemplateName templateName, EmailTemplatePatchRequest request, CancellationToken cancellationToken = default(CancellationToken))
+ public Task<EmailTemplate> PatchAsync(EmailTemplateName templateName, EmailTemplatePatchRequest request, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -321,20 +300,20 @@
System.Threading.Tasks.Task<EmailTemplate> | +Task<EmailTemplate> | The newly updated EmailTemplate. |
Updates an email template.
public Task<EmailTemplate> UpdateAsync(EmailTemplateName templateName, EmailTemplateUpdateRequest request, CancellationToken cancellationToken = default(CancellationToken))
+ public Task<EmailTemplate> UpdateAsync(EmailTemplateName templateName, EmailTemplateUpdateRequest request, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -376,7 +355,7 @@ ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
System.Threading.Tasks.Task<EmailTemplate> | +Task<EmailTemplate> | The newly updated EmailTemplate. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
System.Uri | +Uri | baseUri | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
System.Collections.Generic.IDictionary<System.String, System.String> | +IDictionary<System.String, System.String> | defaultHeaders |
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -211,23 +190,23 @@
System.Threading.Tasks.Task | -A System.Threading.Tasks.Task that represents the asynchronous delete operation. + | Task | +A |
A token with scope delete:grants is needed.
Delete an existing Grant
public Task DeleteAsync(string id, CancellationToken cancellationToken = default(CancellationToken))
+ public Task DeleteAsync(string id, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -263,23 +242,23 @@
System.Threading.Tasks.Task | -A System.Threading.Tasks.Task that represents the asynchronous delete operation. + | Task | +A |
A token with scope delete:grants is needed.
Retrieve all Grants.
public Task<IPagedList<Grant>> GetAllAsync(GetGrantsRequest request, PaginationInfo pagination = null, CancellationToken cancellationToken = default(CancellationToken))
+ public Task<IPagedList<Grant>> GetAllAsync(GetGrantsRequest request, PaginationInfo pagination = null, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -321,13 +300,13 @@
System.Threading.Tasks.Task<IPagedList<Grant>> | +Task<IPagedList<Grant>> | An IPagedList<T> containing the grants. |
A token with scope read:grants is needed
Initializes a new instance of GuardianClient.
System.Uri of the endpoint to use in making API calls.
+Dictionary containing default headers included with every request this client makes.
Generate an email with a link to start the Guardian enrollment process.
public Task<CreateGuardianEnrollmentTicketResponse> CreateEnrollmentTicketAsync(CreateGuardianEnrollmentTicketRequest request, CancellationToken cancellationToken = default(CancellationToken))
+ public Task<CreateGuardianEnrollmentTicketResponse> CreateEnrollmentTicketAsync(CreateGuardianEnrollmentTicketRequest request, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -217,20 +196,20 @@
System.Threading.Tasks.Task<CreateGuardianEnrollmentTicketResponse> | +Task<CreateGuardianEnrollmentTicketResponse> | A CreateGuardianEnrollmentTicketResponse with the details of the ticket that was created. |
Deletes an enrollment.
public Task DeleteEnrollmentAsync(string id, CancellationToken cancellationToken = default(CancellationToken))
+ public Task DeleteEnrollmentAsync(string id, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -266,20 +245,20 @@
System.Threading.Tasks.Task | -A System.Threading.Tasks.Task that represents the asynchronous delete operation. + | Task | +A |
Retrieves an enrollment.
public Task<GuardianEnrollment> GetEnrollmentAsync(string id, CancellationToken cancellationToken = default(CancellationToken))
+ public Task<GuardianEnrollment> GetEnrollmentAsync(string id, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -315,20 +294,20 @@
System.Threading.Tasks.Task<GuardianEnrollment> | +Task<GuardianEnrollment> | A GuardianEnrollment containing details of the enrollment. |
Retrieves all factors. Useful to check factor enablement and trial status.
public Task<IList<GuardianFactor>> GetFactorsAsync(CancellationToken cancellationToken = default(CancellationToken))
+ public Task<IList<GuardianFactor>> GetFactorsAsync(CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | |
System.Threading.Tasks.Task<System.Collections.Generic.IList<GuardianFactor>> | +Task<IList<GuardianFactor>> | List of GuardianFactor instances with the available factors. |
Retrieve the enabled phone factors for multi-factor authentication
public Task<GuardianPhoneMessageTypes> GetPhoneMessageTypesAsync(CancellationToken cancellationToken = default(CancellationToken))
+ public Task<GuardianPhoneMessageTypes> GetPhoneMessageTypesAsync(CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -400,20 +379,20 @@
System.Threading.Tasks.Task<GuardianPhoneMessageTypes> | +Task<GuardianPhoneMessageTypes> | A GuardianPhoneMessageTypes containing the message types. |
Retrieves enrollment and verification templates. You can use it to check the current values for your templates.
public Task<GuardianSmsEnrollmentTemplates> GetSmsTemplatesAsync(CancellationToken cancellationToken = default(CancellationToken))
+ public Task<GuardianSmsEnrollmentTemplates> GetSmsTemplatesAsync(CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | |
System.Threading.Tasks.Task<GuardianSmsEnrollmentTemplates> | +Task<GuardianSmsEnrollmentTemplates> | A GuardianSmsEnrollmentTemplates containing the templates. |
Returns provider configuration for AWS SNS.
public Task<GuardianSnsConfiguration> GetSnsConfigurationAsync(CancellationToken cancellationToken = default(CancellationToken))
+ public Task<GuardianSnsConfiguration> GetSnsConfigurationAsync(CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | |
System.Threading.Tasks.Task<GuardianSnsConfiguration> | +Task<GuardianSnsConfiguration> | A GuardianSnsConfiguration containing Amazon SNS configuration. |
Returns configuration for the Guardian Twilio provider.
public Task<GuardianTwilioConfiguration> GetTwilioConfigurationAsync(CancellationToken cancellationToken = default(CancellationToken))
+ public Task<GuardianTwilioConfiguration> GetTwilioConfigurationAsync(CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | |
System.Threading.Tasks.Task<GuardianTwilioConfiguration> | +Task<GuardianTwilioConfiguration> | GuardianTwilioConfiguration with the Twilio configuration. |
Enable or Disable a Guardian factor.
public Task<UpdateGuardianFactorResponse> UpdateFactorAsync(UpdateGuardianFactorRequest request, CancellationToken cancellationToken = default(CancellationToken))
+ public Task<UpdateGuardianFactorResponse> UpdateFactorAsync(UpdateGuardianFactorRequest request, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -575,20 +554,20 @@
System.Threading.Tasks.Task<UpdateGuardianFactorResponse> | +Task<UpdateGuardianFactorResponse> | The UpdateGuardianFactorResponse indicating the status of the factor. |
Update enabled phone factors for multi-factor authentication
public Task<GuardianPhoneMessageTypes> UpdatePhoneMessageTypesAsync(GuardianPhoneMessageTypes messageTypes, CancellationToken cancellationToken = default(CancellationToken))
+ public Task<GuardianPhoneMessageTypes> UpdatePhoneMessageTypesAsync(GuardianPhoneMessageTypes messageTypes, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -624,20 +603,20 @@
System.Threading.Tasks.Task<GuardianPhoneMessageTypes> | +Task<GuardianPhoneMessageTypes> | A GuardianPhoneMessageTypes containing the message types. |
Updates enrollment and verification templates. Useful to send custom messages on SMS enrollment and verification.
public Task<GuardianSmsEnrollmentTemplates> UpdateSmsTemplatesAsync(GuardianSmsEnrollmentTemplates templates, CancellationToken cancellationToken = default(CancellationToken))
+ public Task<GuardianSmsEnrollmentTemplates> UpdateSmsTemplatesAsync(GuardianSmsEnrollmentTemplates templates, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -673,20 +652,20 @@
System.Threading.Tasks.Task<GuardianSmsEnrollmentTemplates> | +Task<GuardianSmsEnrollmentTemplates> | A GuardianSmsEnrollmentTemplates containing the templates. |
Configure the Guardian Twilio provider.
public Task<GuardianTwilioConfiguration> UpdateTwilioConfigurationAsync(UpdateGuardianTwilioConfigurationRequest request, CancellationToken cancellationToken = default(CancellationToken))
+ public Task<GuardianTwilioConfiguration> UpdateTwilioConfigurationAsync(UpdateGuardianTwilioConfigurationRequest request, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -722,7 +701,7 @@ ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
System.Threading.Tasks.Task<GuardianTwilioConfiguration> | +Task<GuardianTwilioConfiguration> | The GuardianTwilioConfiguration containing the updated configuration settings. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
System.Uri | +Uri | baseUri | -System.Uri of the endpoint to use in making API calls. + | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
System.Collections.Generic.IDictionary<System.String, System.String> | +IDictionary<System.String, System.String> | defaultHeaders | Dictionary containing default headers included with every request this client makes. |
@@ -175,13 +154,13 @@
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -217,20 +196,20 @@
System.Threading.Tasks.Task<Hook> | +Task<Hook> | The newly created Hook. |
Deletes a hook.
public Task DeleteAsync(string id, CancellationToken cancellationToken = default(CancellationToken))
+ public Task DeleteAsync(string id, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -266,20 +245,20 @@
System.Threading.Tasks.Task | -A System.Threading.Tasks.Task that represents the asynchronous delete operation. + | Task | +A |
Retrieves a list of all hooks.
public Task<IPagedList<Hook>> GetAllAsync(GetHooksRequest request, PaginationInfo pagination = null, CancellationToken cancellationToken = default(CancellationToken))
+ public Task<IPagedList<Hook>> GetAllAsync(GetHooksRequest request, PaginationInfo pagination = null, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -321,20 +300,20 @@
System.Threading.Tasks.Task<IPagedList<Hook>> | +Task<IPagedList<Hook>> | An IPagedList<T> containing the hooks requested. |
Retrieves a hook by its ID.
public Task<Hook> GetAsync(string id, string fields = null, CancellationToken cancellationToken = default(CancellationToken))
+ public Task<Hook> GetAsync(string id, string fields = null, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -376,20 +355,20 @@
System.Threading.Tasks.Task<Hook> | +Task<Hook> | The Hook that was requested. |
Updates a hook.
public Task<Hook> UpdateAsync(string id, HookUpdateRequest request, CancellationToken cancellationToken = default(CancellationToken))
+ public Task<Hook> UpdateAsync(string id, HookUpdateRequest request, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -431,7 +410,7 @@ ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
System.Threading.Tasks.Task<Hook> | +Task<Hook> | The newly updated Hook. |
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -126,23 +126,23 @@
System.Threading.Tasks.Task<Action> | +Task<Action> | The new Action that has been created. |
Once an action is created, it must be deployed, and then bound to a trigger before it will be executed as part of a flow.
Deletes an action and all of its associated versions.
Task DeleteAsync(string id, DeleteActionRequest request = null, CancellationToken cancellationToken = default(CancellationToken))
+ Task DeleteAsync(string id, DeleteActionRequest request = null, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -184,23 +184,23 @@
System.Threading.Tasks.Task | -A System.Threading.Tasks.Task that represents the asynchronous delete operation. + | Task | +A |
An action must be unbound from all triggers before it can be deleted.
Deploy an action.
Task<ActionVersion> DeployAsync(string id, CancellationToken cancellationToken = default(CancellationToken))
+ Task<ActionVersion> DeployAsync(string id, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -236,24 +236,24 @@
System.Threading.Tasks.Task<ActionVersion> | +Task<ActionVersion> | The action version that was created. |
Deploying an action will create a new immutable version of the action. If the action is currently bound to a trigger, then the system will begin executing the newly deployed version of the action immediately.Otherwise, the action will only be executed as a part of a flow once it is bound to that flow.
Retrieve all actions.
Task<IPagedList<Action>> GetAllAsync(GetActionsRequest request, PaginationInfo pagination, CancellationToken cancellationToken = default(CancellationToken))
+ Task<IPagedList<Action>> GetAllAsync(GetActionsRequest request, PaginationInfo pagination, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -295,20 +295,20 @@
System.Threading.Tasks.Task<IPagedList<Action>> | +Task<IPagedList<Action>> | An IPagedList<T> containing the actions. |
Retrieve the actions that are bound to a trigger.
Task<IPagedList<TriggerBinding>> GetAllTriggerBindingsAsync(string triggerId, PaginationInfo pagination, CancellationToken cancellationToken = default(CancellationToken))
+ Task<IPagedList<TriggerBinding>> GetAllTriggerBindingsAsync(string triggerId, PaginationInfo pagination, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -350,24 +350,24 @@
System.Threading.Tasks.Task<IPagedList<TriggerBinding>> | +Task<IPagedList<TriggerBinding>> | The retrieved trigger bindings. |
Once an action is created and deployed, it must be attached (i.e. bound) to a trigger so that it will be executed as part of a flow. The list of actions returned reflects the order in which they will be executed during the appropriate flow.
Retrieve the set of triggers currently available within actions. A trigger is an extensibility point to which actions can be bound
Task<IList<Trigger>> GetAllTriggersAsync(CancellationToken cancellationToken = default(CancellationToken))
+ Task<IList<Trigger>> GetAllTriggersAsync(CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -397,20 +397,20 @@
System.Threading.Tasks.Task<System.Collections.Generic.IList<Trigger>> | +Task<IList<Trigger>> | A list containing the triggers. |
Retrieve all versions of an action.
Task<IPagedList<ActionVersion>> GetAllVersionsAsync(string actionId, PaginationInfo pagination, CancellationToken cancellationToken = default(CancellationToken))
+ Task<IPagedList<ActionVersion>> GetAllVersionsAsync(string actionId, PaginationInfo pagination, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -452,23 +452,23 @@
System.Threading.Tasks.Task<IPagedList<ActionVersion>> | +Task<IPagedList<ActionVersion>> | The retrieved versions of the specified action. |
An action version is created whenever an action is deployed. An action version is immutable, once created.
Retrieve an action by its ID.
Task<Action> GetAsync(string id, CancellationToken cancellationToken = default(CancellationToken))
+ Task<Action> GetAsync(string id, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -504,20 +504,20 @@
System.Threading.Tasks.Task<Action> | +Task<Action> | The retrieved action. |
Retrieve information about a specific execution of a trigger.
Task<ActionExecution> GetExecutionAsync(string id, CancellationToken cancellationToken = default(CancellationToken))
+ Task<ActionExecution> GetExecutionAsync(string id, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -553,24 +553,24 @@
System.Threading.Tasks.Task<ActionExecution> | +Task<ActionExecution> | The retrieved execution. |
Relevant execution IDs will be included in tenant logs generated as part of that authentication flow. Executions will only be stored for 10 days after their creation.
Retrieve a specific version of an action.
Task<ActionVersion> GetVersionAsync(string actionId, string versionId, CancellationToken cancellationToken = default(CancellationToken))
+ Task<ActionVersion> GetVersionAsync(string actionId, string versionId, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -612,23 +612,23 @@
System.Threading.Tasks.Task<ActionVersion> | +Task<ActionVersion> | The retrieved version of the specified action. |
An action version is created whenever an action is deployed. An action version is immutable, once created.
Performs the equivalent of a roll-back of an action to an earlier, specified version.
Task<ActionVersion> RollbackToVersionAsync(string actionId, string versionId, CancellationToken cancellationToken = default(CancellationToken))
+ Task<ActionVersion> RollbackToVersionAsync(string actionId, string versionId, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -670,24 +670,24 @@
System.Threading.Tasks.Task<ActionVersion> | -A System.Threading.Tasks.Task that represents the asynchronous delete operation. + | Task<ActionVersion> | +A |
Creates a new, deployed action version that is identical to the specified version. If this action is currently bound to a trigger, the system will begin executing the newly-created version immediately.
Update an existing action.
Task<Action> UpdateAsync(string id, UpdateActionRequest request, CancellationToken cancellationToken = default(CancellationToken))
+ Task<Action> UpdateAsync(string id, UpdateActionRequest request, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -729,17 +729,17 @@
System.Threading.Tasks.Task<Action> | +Task<Action> | The Action that was updated. |
If this action is currently bound to a trigger, updating it will not affect any user flows until the action is deployed.
Update the actions that are bound (i.e. attached) to a trigger. Once an action is created and deployed, it must be attached(i.e.bound) to a trigger so that it will be executed as part of a flow. The order in which the actions are provided will determine the order in which they are executed.
@@ -747,7 +747,7 @@Task<IList<TriggerBinding>> UpdateTriggerBindingsAsync(string triggerId, UpdateTriggerBindingsRequest request, CancellationToken cancellationToken = default(CancellationToken))
+ Task<IList<TriggerBinding>> UpdateTriggerBindingsAsync(string triggerId, UpdateTriggerBindingsRequest request, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -789,7 +789,7 @@ ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
System.Threading.Tasks.Task<System.Collections.Generic.IList<TriggerBinding>> | +Task<IList<TriggerBinding>> | The trigger bindings. |
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -120,20 +120,20 @@
System.Threading.Tasks.Task<BreachedPasswordDetection> | +Task<BreachedPasswordDetection> | A BreachedPasswordDetection containing the configuration. |
Get the brute force configuration.
Task<BruteForceProtection> GetBruteForceProtectionAsync(CancellationToken cancellationToken = default(CancellationToken))
+ Task<BruteForceProtection> GetBruteForceProtectionAsync(CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -163,20 +163,20 @@
System.Threading.Tasks.Task<BruteForceProtection> | +Task<BruteForceProtection> | A BruteForceProtection containing the configuration. |
Get the suspicious IP throttling configuration.
Task<SuspiciousIpThrottling> GetSuspiciousIpThrottlingAsync(CancellationToken cancellationToken = default(CancellationToken))
+ Task<SuspiciousIpThrottling> GetSuspiciousIpThrottlingAsync(CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -206,20 +206,20 @@
System.Threading.Tasks.Task<SuspiciousIpThrottling> | +Task<SuspiciousIpThrottling> | A SuspiciousIpThrottling containing the configuration. |
Update breached password detection settings.
Task<BreachedPasswordDetection> UpdateBreachedPasswordDetectionAsync(BreachedPasswordDetection request, CancellationToken cancellationToken = default(CancellationToken))
+ Task<BreachedPasswordDetection> UpdateBreachedPasswordDetectionAsync(BreachedPasswordDetection request, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -255,20 +255,20 @@
System.Threading.Tasks.Task<BreachedPasswordDetection> | +Task<BreachedPasswordDetection> | The BreachedPasswordDetection that was updated. |
Update the brute force configuration.
Task<BruteForceProtection> UpdateBruteForceProtectionAsync(BruteForceProtection request, CancellationToken cancellationToken = default(CancellationToken))
+ Task<BruteForceProtection> UpdateBruteForceProtectionAsync(BruteForceProtection request, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -304,20 +304,20 @@
System.Threading.Tasks.Task<BruteForceProtection> | +Task<BruteForceProtection> | The BruteForceProtection that was updated. |
Update the suspicious IP throttling configuration.
Task<SuspiciousIpThrottling> UpdateSuspiciousIpThrottlingAsync(SuspiciousIpThrottling request, CancellationToken cancellationToken = default(CancellationToken))
+ Task<SuspiciousIpThrottling> UpdateSuspiciousIpThrottlingAsync(SuspiciousIpThrottling request, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -353,7 +353,7 @@ ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
System.Threading.Tasks.Task<SuspiciousIpThrottling> | +Task<SuspiciousIpThrottling> | The SuspiciousIpThrottling that was updated. |
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -126,20 +126,20 @@
System.Threading.Tasks.Task | -A System.Threading.Tasks.Task that represents the asynchronous create operation. + | Task | +A |
Gets all the blacklisted claims.
Task<IList<BlacklistedToken>> GetAllAsync(string aud, CancellationToken cancellationToken = default(CancellationToken))
+ Task<IList<BlacklistedToken>> GetAllAsync(string aud, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -175,7 +175,7 @@ ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
System.Threading.Tasks.Task<System.Collections.Generic.IList<BlacklistedToken>> | +Task<IList<BlacklistedToken>> | A list of BlacklistedToken objects. |
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -120,20 +120,20 @@
System.Threading.Tasks.Task | -A System.Threading.Tasks.Task that represents the asynchronous delete operation. + | Task | +A |
Retrieves branding settings for a tenant.
Task<Branding> GetAsync(CancellationToken cancellationToken = default(CancellationToken))
+ Task<Branding> GetAsync(CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -163,20 +163,20 @@
System.Threading.Tasks.Task<Branding> | +Task<Branding> | A Branding containing the branding for the tenant. |
Retrieves the template for the New Universal Login Experience.
Task<UniversalLoginTemplate> GetUniversalLoginTemplateAsync(CancellationToken cancellationToken = default(CancellationToken))
+ Task<UniversalLoginTemplate> GetUniversalLoginTemplateAsync(CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -206,20 +206,20 @@
System.Threading.Tasks.Task<UniversalLoginTemplate> | +Task<UniversalLoginTemplate> | The UniversalLoginTemplate for the new universal login experience. |
Sets the template for the New Universal Login Experience.
Task<UniversalLoginTemplate> SetUniversalLoginTemplateAsync(UniversalLoginTemplateUpdateRequest request, CancellationToken cancellationToken = default(CancellationToken))
+ Task<UniversalLoginTemplate> SetUniversalLoginTemplateAsync(UniversalLoginTemplateUpdateRequest request, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -255,21 +255,21 @@
System.Threading.Tasks.Task<UniversalLoginTemplate> | +Task<UniversalLoginTemplate> | The newly updated UniversalLoginTemplate. |
s Updates the branding for a tenant.
Task<Branding> UpdateAsync(BrandingUpdateRequest request, CancellationToken cancellationToken = default(CancellationToken))
+ Task<Branding> UpdateAsync(BrandingUpdateRequest request, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -305,7 +305,7 @@ ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
System.Threading.Tasks.Task<Branding> | +Task<Branding> | The newly updated Branding. |
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -126,20 +126,20 @@
System.Threading.Tasks.Task<ClientGrant> | +Task<ClientGrant> | The new ClientGrant that has been created. |
Deletes a client grant.
Task DeleteAsync(string id, CancellationToken cancellationToken = default(CancellationToken))
+ Task DeleteAsync(string id, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -175,20 +175,20 @@
System.Threading.Tasks.Task | -A System.Threading.Tasks.Task that represents the asynchronous delete operation. + | Task | +A |
Gets a list of all the client grants.
Task<IPagedList<ClientGrant>> GetAllAsync(GetClientGrantsRequest request, PaginationInfo pagination = null, CancellationToken cancellationToken = default(CancellationToken))
+ Task<IPagedList<ClientGrant>> GetAllAsync(GetClientGrantsRequest request, PaginationInfo pagination = null, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -230,20 +230,20 @@
System.Threading.Tasks.Task<IPagedList<ClientGrant>> | +Task<IPagedList<ClientGrant>> | A IPagedList<T> containing the client grants requested. |
Updates a client grant.
Task<ClientGrant> UpdateAsync(string id, ClientGrantUpdateRequest request, CancellationToken cancellationToken = default(CancellationToken))
+ Task<ClientGrant> UpdateAsync(string id, ClientGrantUpdateRequest request, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -285,7 +285,7 @@ ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
System.Threading.Tasks.Task<ClientGrant> | +Task<ClientGrant> | The ClientGrant that has been updated. |
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -126,20 +126,20 @@
System.Threading.Tasks.Task<Client> | +Task<Client> | The new Client that has been created. |
Creates a new client credential.
Task<Credential> CreateCredentialAsync(string clientId, ClientCredentialCreateRequest request, CancellationToken cancellationToken = default(CancellationToken))
+ Task<Credential> CreateCredentialAsync(string clientId, ClientCredentialCreateRequest request, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -181,20 +181,20 @@
System.Threading.Tasks.Task<Credential> | +Task<Credential> | The new Credential that has been created. |
Deletes a client and all its related assets (like rules, connections, etc) given its id.
Task DeleteAsync(string id, CancellationToken cancellationToken = default(CancellationToken))
+ Task DeleteAsync(string id, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -230,20 +230,20 @@
System.Threading.Tasks.Task | -A System.Threading.Tasks.Task that represents the asynchronous delete operation. + | Task | +A |
Deletes a specific credential registered with the provided client.
Task DeleteCredentialAsync(string clientId, string credentialId, CancellationToken cancellationToken = default(CancellationToken))
+ Task DeleteCredentialAsync(string clientId, string credentialId, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -285,20 +285,20 @@
System.Threading.Tasks.Task | -A System.Threading.Tasks.Task that represents the asynchronous delete operation. + | Task | +A |
Retrieves a list of all client applications.
Task<IPagedList<Client>> GetAllAsync(GetClientsRequest request, PaginationInfo pagination = null, CancellationToken cancellationToken = default(CancellationToken))
+ Task<IPagedList<Client>> GetAllAsync(GetClientsRequest request, PaginationInfo pagination = null, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -340,20 +340,20 @@
System.Threading.Tasks.Task<IPagedList<Client>> | +Task<IPagedList<Client>> | An IPagedList<T> containing the clients. |
Retrieves a list of all credentials for a client.
Task<IList<Credential>> GetAllCredentialsAsync(string clientId, CancellationToken cancellationToken = default(CancellationToken))
+ Task<IList<Credential>> GetAllCredentialsAsync(string clientId, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -389,20 +389,20 @@
System.Threading.Tasks.Task<System.Collections.Generic.IList<Credential>> | -An System.Collections.Generic.IList<T> containing the client's credentials. + | Task<IList<Credential>> | +An |
Retrieves a client by its id.
Task<Client> GetAsync(string id, string fields = null, bool includeFields = true, CancellationToken cancellationToken = default(CancellationToken))
+ Task<Client> GetAsync(string id, string fields = null, bool includeFields = true, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -452,20 +452,20 @@
System.Threading.Tasks.Task<Client> | +Task<Client> | The Client retrieved. |
Retrieves a specific credential for a client.
Task<Credential> GetCredentialAsync(string clientId, string credentialId, CancellationToken cancellationToken = default(CancellationToken))
+ Task<Credential> GetCredentialAsync(string clientId, string credentialId, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -507,20 +507,20 @@
System.Threading.Tasks.Task<Credential> | +Task<Credential> | A Credential containing the client's credential. |
Rotate a client secret. The generated secret is NOT base64 encoded.
Task<Client> RotateClientSecret(string id, CancellationToken cancellationToken = default(CancellationToken))
+ Task<Client> RotateClientSecret(string id, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -556,20 +556,20 @@
System.Threading.Tasks.Task<Client> | +Task<Client> | The Client that has had its secret rotated. |
Updates a client application.
Task<Client> UpdateAsync(string id, ClientUpdateRequest request, CancellationToken cancellationToken = default(CancellationToken))
+ Task<Client> UpdateAsync(string id, ClientUpdateRequest request, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -611,20 +611,20 @@
System.Threading.Tasks.Task<Client> | +Task<Client> | The Client that was updated. |
Update a client credential.
Task<Credential> UpdateCredentialAsync(string clientId, string credentialId, ClientCredentialUpdateRequest request, CancellationToken cancellationToken = default(CancellationToken))
+ Task<Credential> UpdateCredentialAsync(string clientId, string credentialId, ClientCredentialUpdateRequest request, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -672,7 +672,7 @@ ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
System.Threading.Tasks.Task<Credential> | +Task<Credential> | The new Credential that has been created. |
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -126,20 +126,20 @@
System.Threading.Tasks.Task | -A System.Threading.Tasks.Task that represents the asynchronous check operation. Will throw if the status check fails. + | Task | +A |
Creates a new connection according to the request.
Task<Connection> CreateAsync(ConnectionCreateRequest request, CancellationToken cancellationToken = default(CancellationToken))
+ Task<Connection> CreateAsync(ConnectionCreateRequest request, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -175,20 +175,20 @@
System.Threading.Tasks.Task<Connection> | +Task<Connection> | A Connection containing the newly created Connection. |
Deletes a connection and all its users.
Task DeleteAsync(string id, CancellationToken cancellationToken = default(CancellationToken))
+ Task DeleteAsync(string id, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -224,20 +224,20 @@
System.Threading.Tasks.Task | -A System.Threading.Tasks.Task that represents the asynchronous delete operation. + | Task | +A |
Deletes a specified connection user by its email
.
Task DeleteUserAsync(string id, string email, CancellationToken cancellationToken = default(CancellationToken))
+ Task DeleteUserAsync(string id, string email, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -279,23 +279,23 @@
System.Threading.Tasks.Task | -A System.Threading.Tasks.Task that represents the asynchronous delete operation. + | Task | +A |
Currently only database connections are supported and you cannot delete all users from specific connection.
Retrieves every connection matching the specified strategy. All connections are retrieved if no strategy is being specified. Accepts a list of fields to include or exclude in the resulting list of connection objects.
Task<IPagedList<Connection>> GetAllAsync(GetConnectionsRequest request, PaginationInfo pagination = null, CancellationToken cancellationToken = default(CancellationToken))
+ Task<IPagedList<Connection>> GetAllAsync(GetConnectionsRequest request, PaginationInfo pagination = null, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -337,20 +337,20 @@
System.Threading.Tasks.Task<IPagedList<Connection>> | +Task<IPagedList<Connection>> | An IPagedList<T> containing the list of connections. |
Retrieves a connection by its id
.
Task<Connection> GetAsync(string id, string fields = null, bool includeFields = true, CancellationToken cancellationToken = default(CancellationToken))
+ Task<Connection> GetAsync(string id, string fields = null, bool includeFields = true, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -398,20 +398,20 @@
System.Threading.Tasks.Task<Connection> | +Task<Connection> | The Connection. |
Updates a connection.
Task<Connection> UpdateAsync(string id, ConnectionUpdateRequest request, CancellationToken cancellationToken = default(CancellationToken))
+ Task<Connection> UpdateAsync(string id, ConnectionUpdateRequest request, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -453,7 +453,7 @@ ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
System.Threading.Tasks.Task<Connection> | +Task<Connection> | The Connection that has been updated. |
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -126,23 +126,23 @@
System.Threading.Tasks.Task<CustomDomain> | +Task<CustomDomain> | The CustomDomain containing the newly created custom domain. |
The custom domain will need to be verified before it starts accepting requests.
Deletes a custom domain by its ID.
Task DeleteAsync(string id, CancellationToken cancellationToken = default(CancellationToken))
+ Task DeleteAsync(string id, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -178,23 +178,23 @@
System.Threading.Tasks.Task | -A System.Threading.Tasks.Task that represents the asyncronous delete operation. + | Task | +A |
When deleted, Auth0 will stop serving requests for this domain.
Retrieves the status of every custom domain.
Task<IList<CustomDomain>> GetAllAsync(CancellationToken cancellationToken = default(CancellationToken))
+ Task<IList<CustomDomain>> GetAllAsync(CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | |
System.Threading.Tasks.Task<System.Collections.Generic.IList<CustomDomain>> | -A System.Collections.Generic.IList<T> containing the details of every custom domain. + | Task<IList<CustomDomain>> | +A |
Retrieves a custom domain status by its ID
Task<CustomDomain> GetAsync(string id, CancellationToken cancellationToken = default(CancellationToken))
+ Task<CustomDomain> GetAsync(string id, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -272,20 +272,20 @@
System.Threading.Tasks.Task<CustomDomain> | +Task<CustomDomain> | The CustomDomain that was requested. |
Run the verification process for the custom domain.
Task<CustomDomainVerificationResponse> VerifyAsync(string id, CancellationToken cancellationToken = default(CancellationToken))
+ Task<CustomDomainVerificationResponse> VerifyAsync(string id, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -321,7 +321,7 @@ ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
System.Threading.Tasks.Task<CustomDomainVerificationResponse> | +Task<CustomDomainVerificationResponse> | The CustomDomainVerification that was requested. |
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -126,20 +126,20 @@
System.Threading.Tasks.Task<DeviceCredential> | +Task<DeviceCredential> | The newly created DeviceCredential. |
Deletes a device credential.
Task DeleteAsync(string id, CancellationToken cancellationToken = default(CancellationToken))
+ Task DeleteAsync(string id, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -175,20 +175,20 @@
System.Threading.Tasks.Task | -A System.Threading.Tasks.Task that represents the asynchronous delete operation. + | Task | +A |
Gets a list of all the device credentials.
Task<IPagedList<DeviceCredential>> GetAllAsync(GetDeviceCredentialsRequest request, PaginationInfo pagination = null, CancellationToken cancellationToken = default(CancellationToken))
+ Task<IPagedList<DeviceCredential>> GetAllAsync(GetDeviceCredentialsRequest request, PaginationInfo pagination = null, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -230,20 +230,20 @@
System.Threading.Tasks.Task<IPagedList<DeviceCredential>> | +Task<IPagedList<DeviceCredential>> | A list of DeviceCredential which conforms to the criteria specified. |
Gets a list of all the device credentials.
Task<IList<DeviceCredential>> GetAllAsync(string fields = null, bool includeFields = true, string userId = null, string clientId = null, string type = null, CancellationToken cancellationToken = default(CancellationToken))
+ Task<IList<DeviceCredential>> GetAllAsync(string fields = null, bool includeFields = true, string userId = null, string clientId = null, string type = null, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -303,7 +303,7 @@ ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
System.Threading.Tasks.Task<System.Collections.Generic.IList<DeviceCredential>> | +Task<IList<DeviceCredential>> | A list of DeviceCredential which conforms to the criteria specified. |
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -127,20 +127,20 @@
System.Threading.Tasks.Task<EmailProvider> | +Task<EmailProvider> | A EmailProvider instance containing the email provider details. |
Deletes the email provider.
Task DeleteAsync(CancellationToken cancellationToken = default(CancellationToken))
+ Task DeleteAsync(CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | |
System.Threading.Tasks.Task | -A System.Threading.Tasks.Task that represents the asynchronous delete operation. + | Task | +A |
Gets the email provider.
Task<EmailProvider> GetAsync(string fields = null, bool includeFields = true, CancellationToken cancellationToken = default(CancellationToken))
+ Task<EmailProvider> GetAsync(string fields = null, bool includeFields = true, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -226,20 +226,20 @@
System.Threading.Tasks.Task<EmailProvider> | +Task<EmailProvider> | A EmailProvider instance containing the email provider details. |
Updates the email provider.
Task<EmailProvider> UpdateAsync(EmailProviderUpdateRequest request, CancellationToken cancellationToken = default(CancellationToken))
+ Task<EmailProvider> UpdateAsync(EmailProviderUpdateRequest request, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -276,7 +276,7 @@ ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
System.Threading.Tasks.Task<EmailProvider> | +Task<EmailProvider> | A EmailProvider instance containing the email provider details. |
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -126,20 +126,20 @@
System.Threading.Tasks.Task<EmailTemplate> | +Task<EmailTemplate> | The newly created EmailTemplate. |
Gets an email template.
Task<EmailTemplate> GetAsync(EmailTemplateName templateName, CancellationToken cancellationToken = default(CancellationToken))
+ Task<EmailTemplate> GetAsync(EmailTemplateName templateName, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -175,20 +175,20 @@
System.Threading.Tasks.Task<EmailTemplate> | +Task<EmailTemplate> | The EmailTemplate that was requested. |
Updates an email template.
Task<EmailTemplate> PatchAsync(EmailTemplateName templateName, EmailTemplatePatchRequest request, CancellationToken cancellationToken = default(CancellationToken))
+ Task<EmailTemplate> PatchAsync(EmailTemplateName templateName, EmailTemplatePatchRequest request, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -230,20 +230,20 @@
System.Threading.Tasks.Task<EmailTemplate> | +Task<EmailTemplate> | The newly updated EmailTemplate. |
Updates an email template.
Task<EmailTemplate> UpdateAsync(EmailTemplateName templateName, EmailTemplateUpdateRequest request, CancellationToken cancellationToken = default(CancellationToken))
+ Task<EmailTemplate> UpdateAsync(EmailTemplateName templateName, EmailTemplateUpdateRequest request, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -285,7 +285,7 @@ ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
System.Threading.Tasks.Task<EmailTemplate> | +Task<EmailTemplate> | The newly updated EmailTemplate. |
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -125,23 +125,23 @@
System.Threading.Tasks.Task | -A System.Threading.Tasks.Task that represents the asynchronous delete operation. + | Task | +A |
A token with scope delete:grants is needed.
Delete an existing Grant
Task DeleteAsync(string id, CancellationToken cancellationToken = default(CancellationToken))
+ Task DeleteAsync(string id, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -177,23 +177,23 @@
System.Threading.Tasks.Task | -A System.Threading.Tasks.Task that represents the asynchronous delete operation. + | Task | +A |
A token with scope delete:grants is needed.
Retrieve all Grants.
Task<IPagedList<Grant>> GetAllAsync(GetGrantsRequest request, PaginationInfo pagination = null, CancellationToken cancellationToken = default(CancellationToken))
+ Task<IPagedList<Grant>> GetAllAsync(GetGrantsRequest request, PaginationInfo pagination = null, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -235,13 +235,13 @@
System.Threading.Tasks.Task<IPagedList<Grant>> | +Task<IPagedList<Grant>> | An IPagedList<T> containing the grants. |
A token with scope read:grants is needed
Generate an email with a link to start the Guardian enrollment process.
Task<CreateGuardianEnrollmentTicketResponse> CreateEnrollmentTicketAsync(CreateGuardianEnrollmentTicketRequest request, CancellationToken cancellationToken = default(CancellationToken))
+ Task<CreateGuardianEnrollmentTicketResponse> CreateEnrollmentTicketAsync(CreateGuardianEnrollmentTicketRequest request, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -126,20 +126,20 @@
System.Threading.Tasks.Task<CreateGuardianEnrollmentTicketResponse> | +Task<CreateGuardianEnrollmentTicketResponse> | A CreateGuardianEnrollmentTicketResponse with the details of the ticket that was created. |
Deletes an enrollment.
Task DeleteEnrollmentAsync(string id, CancellationToken cancellationToken = default(CancellationToken))
+ Task DeleteEnrollmentAsync(string id, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -175,20 +175,20 @@
System.Threading.Tasks.Task | -A System.Threading.Tasks.Task that represents the asynchronous delete operation. + | Task | +A |
Retrieves an enrollment.
Task<GuardianEnrollment> GetEnrollmentAsync(string id, CancellationToken cancellationToken = default(CancellationToken))
+ Task<GuardianEnrollment> GetEnrollmentAsync(string id, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -224,20 +224,20 @@
System.Threading.Tasks.Task<GuardianEnrollment> | +Task<GuardianEnrollment> | A GuardianEnrollment containing details of the enrollment. |
Retrieves all factors. Useful to check factor enablement and trial status.
Task<IList<GuardianFactor>> GetFactorsAsync(CancellationToken cancellationToken = default(CancellationToken))
+ Task<IList<GuardianFactor>> GetFactorsAsync(CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | |
System.Threading.Tasks.Task<System.Collections.Generic.IList<GuardianFactor>> | +Task<IList<GuardianFactor>> | List of GuardianFactor instances with the available factors. |
Retrieve the enabled phone factors for multi-factor authentication
Task<GuardianPhoneMessageTypes> GetPhoneMessageTypesAsync(CancellationToken cancellationToken = default(CancellationToken))
+ Task<GuardianPhoneMessageTypes> GetPhoneMessageTypesAsync(CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -309,20 +309,20 @@
System.Threading.Tasks.Task<GuardianPhoneMessageTypes> | +Task<GuardianPhoneMessageTypes> | A GuardianPhoneMessageTypes containing the message types. |
Retrieves enrollment and verification templates. You can use it to check the current values for your templates.
Task<GuardianSmsEnrollmentTemplates> GetSmsTemplatesAsync(CancellationToken cancellationToken = default(CancellationToken))
+ Task<GuardianSmsEnrollmentTemplates> GetSmsTemplatesAsync(CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | |
System.Threading.Tasks.Task<GuardianSmsEnrollmentTemplates> | +Task<GuardianSmsEnrollmentTemplates> | A GuardianSmsEnrollmentTemplates containing the templates. |
Returns provider configuration for AWS SNS.
Task<GuardianSnsConfiguration> GetSnsConfigurationAsync(CancellationToken cancellationToken = default(CancellationToken))
+ Task<GuardianSnsConfiguration> GetSnsConfigurationAsync(CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | |
System.Threading.Tasks.Task<GuardianSnsConfiguration> | +Task<GuardianSnsConfiguration> | A GuardianSnsConfiguration containing Amazon SNS configuration. |
Returns configuration for the Guardian Twilio provider.
Task<GuardianTwilioConfiguration> GetTwilioConfigurationAsync(CancellationToken cancellationToken = default(CancellationToken))
+ Task<GuardianTwilioConfiguration> GetTwilioConfigurationAsync(CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | |
System.Threading.Tasks.Task<GuardianTwilioConfiguration> | +Task<GuardianTwilioConfiguration> | GuardianTwilioConfiguration with the Twilio configuration. |
Enable or Disable a Guardian factor.
Task<UpdateGuardianFactorResponse> UpdateFactorAsync(UpdateGuardianFactorRequest request, CancellationToken cancellationToken = default(CancellationToken))
+ Task<UpdateGuardianFactorResponse> UpdateFactorAsync(UpdateGuardianFactorRequest request, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -484,20 +484,20 @@
System.Threading.Tasks.Task<UpdateGuardianFactorResponse> | +Task<UpdateGuardianFactorResponse> | The UpdateGuardianFactorResponse indicating the status of the factor. |
Update enabled phone factors for multi-factor authentication
Task<GuardianPhoneMessageTypes> UpdatePhoneMessageTypesAsync(GuardianPhoneMessageTypes messageTypes, CancellationToken cancellationToken = default(CancellationToken))
+ Task<GuardianPhoneMessageTypes> UpdatePhoneMessageTypesAsync(GuardianPhoneMessageTypes messageTypes, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -533,20 +533,20 @@
System.Threading.Tasks.Task<GuardianPhoneMessageTypes> | +Task<GuardianPhoneMessageTypes> | A GuardianPhoneMessageTypes containing the message types. |
Updates enrollment and verification templates. Useful to send custom messages on SMS enrollment and verification.
Task<GuardianSmsEnrollmentTemplates> UpdateSmsTemplatesAsync(GuardianSmsEnrollmentTemplates templates, CancellationToken cancellationToken = default(CancellationToken))
+ Task<GuardianSmsEnrollmentTemplates> UpdateSmsTemplatesAsync(GuardianSmsEnrollmentTemplates templates, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -582,20 +582,20 @@
System.Threading.Tasks.Task<GuardianSmsEnrollmentTemplates> | +Task<GuardianSmsEnrollmentTemplates> | A GuardianSmsEnrollmentTemplates containing the templates. |
Configure the Guardian Twilio provider.
Task<GuardianTwilioConfiguration> UpdateTwilioConfigurationAsync(UpdateGuardianTwilioConfigurationRequest request, CancellationToken cancellationToken = default(CancellationToken))
+ Task<GuardianTwilioConfiguration> UpdateTwilioConfigurationAsync(UpdateGuardianTwilioConfigurationRequest request, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -631,7 +631,7 @@ ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
System.Threading.Tasks.Task<GuardianTwilioConfiguration> | +Task<GuardianTwilioConfiguration> | The GuardianTwilioConfiguration containing the updated configuration settings. |
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -126,20 +126,20 @@
System.Threading.Tasks.Task<Hook> | +Task<Hook> | The newly created Hook. |
Deletes a hook.
Task DeleteAsync(string id, CancellationToken cancellationToken = default(CancellationToken))
+ Task DeleteAsync(string id, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -175,20 +175,20 @@
System.Threading.Tasks.Task | -A System.Threading.Tasks.Task that represents the asynchronous delete operation. + | Task | +A |
Retrieves a list of all hooks.
Task<IPagedList<Hook>> GetAllAsync(GetHooksRequest request, PaginationInfo pagination = null, CancellationToken cancellationToken = default(CancellationToken))
+ Task<IPagedList<Hook>> GetAllAsync(GetHooksRequest request, PaginationInfo pagination = null, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -230,20 +230,20 @@
System.Threading.Tasks.Task<IPagedList<Hook>> | +Task<IPagedList<Hook>> | An IPagedList<T> containing the hooks requested. |
Retrieves a hook by its ID.
Task<Hook> GetAsync(string id, string fields = null, CancellationToken cancellationToken = default(CancellationToken))
+ Task<Hook> GetAsync(string id, string fields = null, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -285,20 +285,20 @@
System.Threading.Tasks.Task<Hook> | +Task<Hook> | The Hook that was requested. |
Updates a hook.
Task<Hook> UpdateAsync(string id, HookUpdateRequest request, CancellationToken cancellationToken = default(CancellationToken))
+ Task<Hook> UpdateAsync(string id, HookUpdateRequest request, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -340,7 +340,7 @@ ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
System.Threading.Tasks.Task<Hook> | +Task<Hook> | The newly updated Hook. |
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -126,23 +126,23 @@
System.Threading.Tasks.Task<Job> | +Task<Job> | A Job instance containing the information about the job. |
The documentation for user exports can be found here.
Gets a job.
Task<Job> GetAsync(string id, CancellationToken cancellationToken = default(CancellationToken))
+ Task<Job> GetAsync(string id, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -178,23 +178,23 @@
System.Threading.Tasks.Task<Job> | +Task<Job> | A Job instance containing the information about the job. |
This is useful to check the status of a job.
Imports users to a connection from a file using a long running job.
Task<Job> ImportUsersAsync(string connectionId, string fileName, Stream file, bool? upsert = null, string externalId = null, bool? sendCompletionEmail = null, CancellationToken cancellationToken = default(CancellationToken))
+ Task<Job> ImportUsersAsync(string connectionId, string fileName, Stream file, bool? upsert = null, string externalId = null, bool? sendCompletionEmail = null, CancellationToken cancellationToken = null)
System.IO.Stream | +Stream | file | The file. |
@@ -243,7 +243,7 @@
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -260,23 +260,23 @@
System.Threading.Tasks.Task<Job> | +Task<Job> | A Job instance containing the information about the job. |
The documentation for the file format is here.
Send an email to the specified user that asks them to click a link to verify their email address.
Task<Job> SendVerificationEmailAsync(VerifyEmailJobRequest request, CancellationToken cancellationToken = default(CancellationToken))
+ Task<Job> SendVerificationEmailAsync(VerifyEmailJobRequest request, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -312,7 +312,7 @@ ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
System.Threading.Tasks.Task<Job> | +Task<Job> | A Job instance containing the information about the job. |
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -120,20 +120,20 @@
System.Threading.Tasks.Task<System.Collections.Generic.IList<Key>> | +Task<IList<Key>> | All available signing keys Key. |
Get an Application Signing Key by its key ID.
Task<Key> GetAsync(string kid, CancellationToken cancellationToken = default(CancellationToken))
+ Task<Key> GetAsync(string kid, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -169,20 +169,20 @@
System.Threading.Tasks.Task<Key> | +Task<Key> | The Key that was requested. |
Revoke an Application Signing Key by its key ID.
Task<RevokeSigningKeyResponse> RevokeSigningKeyAsync(string kid, CancellationToken cancellationToken = default(CancellationToken))
+ Task<RevokeSigningKeyResponse> RevokeSigningKeyAsync(string kid, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -218,20 +218,20 @@
System.Threading.Tasks.Task<RevokeSigningKeyResponse> | +Task<RevokeSigningKeyResponse> | The revoked key's cert and kid. |
Rotate the Application Signing Key.
Task<RotateSigningKeyResponse> RotateSigningKeyAsync(CancellationToken cancellationToken = default(CancellationToken))
+ Task<RotateSigningKeyResponse> RotateSigningKeyAsync(CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -261,7 +261,7 @@ ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
System.Threading.Tasks.Task<RotateSigningKeyResponse> | +Task<RotateSigningKeyResponse> | The next rotated key's cert and kid. |
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -126,20 +126,20 @@
System.Threading.Tasks.Task<LogStream> | -A System.Threading.Tasks.Task that represents the asynchronous create operation. + | Task<LogStream> | +A |
Deletes a log stream
Task DeleteAsync(string id, CancellationToken cancellationToken = default(CancellationToken))
+ Task DeleteAsync(string id, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -175,20 +175,20 @@
System.Threading.Tasks.Task | -A System.Threading.Tasks.Task that represents the asynchronous delete operation. + | Task | +A |
Gets all of the log streams
Task<IList<LogStream>> GetAllAsync(CancellationToken cancellationToken = default(CancellationToken))
+ Task<IList<LogStream>> GetAllAsync(CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | |
System.Threading.Tasks.Task<System.Collections.Generic.IList<LogStream>> | +Task<IList<LogStream>> | A list of LogStream objects |
Gets a log stream
Task<LogStream> GetAsync(string id, CancellationToken cancellationToken = default(CancellationToken))
+ Task<LogStream> GetAsync(string id, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -266,20 +266,20 @@
System.Threading.Tasks.Task<LogStream> | +Task<LogStream> | A LogStream object |
Updates a log stream
Task<LogStream> UpdateAsync(string id, LogStreamUpdateRequest request, CancellationToken cancellationToken = default(CancellationToken))
+ Task<LogStream> UpdateAsync(string id, LogStreamUpdateRequest request, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -321,7 +321,7 @@ ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
System.Threading.Tasks.Task<LogStream> | +Task<LogStream> | The updated LogStream object |
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -132,20 +132,20 @@
System.Threading.Tasks.Task<IPagedList<LogEntry>> | +Task<IPagedList<LogEntry>> | An IPagedList<T> containing the list of log entries. |
Retrieves the data related to the log entry identified by id. This returns a single log entry representation as specified in the schema.
Task<LogEntry> GetAsync(string id, CancellationToken cancellationToken = default(CancellationToken))
+ Task<LogEntry> GetAsync(string id, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -181,7 +181,7 @@ ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
System.Threading.Tasks.Task<LogEntry> | +Task<LogEntry> | A LogEntry instance containing the information about the log entry. |
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -138,20 +138,20 @@
System.Threading.Tasks.Task | -A System.Threading.Tasks.Task that represents the asynchronous operation. + | Task | +A |
Add members to an organization.
Task AddMembersAsync(string organizationId, OrganizationAddMembersRequest request, CancellationToken cancellationToken = default(CancellationToken))
+ Task AddMembersAsync(string organizationId, OrganizationAddMembersRequest request, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -193,20 +193,20 @@
System.Threading.Tasks.Task | -A System.Threading.Tasks.Task that represents the asynchronous operation. + | Task | +A |
Creates a new organization.
Task<Organization> CreateAsync(OrganizationCreateRequest request, CancellationToken cancellationToken = default(CancellationToken))
+ Task<Organization> CreateAsync(OrganizationCreateRequest request, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -242,20 +242,20 @@
System.Threading.Tasks.Task<Organization> | +Task<Organization> | The new Organization that has been created. |
Creates a new organization connection.
Task<OrganizationConnection> CreateConnectionAsync(string organizationId, OrganizationConnectionCreateRequest request, CancellationToken cancellationToken = default(CancellationToken))
+ Task<OrganizationConnection> CreateConnectionAsync(string organizationId, OrganizationConnectionCreateRequest request, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -297,20 +297,20 @@
System.Threading.Tasks.Task<OrganizationConnection> | +Task<OrganizationConnection> | The new OrganizationConnection that has been created. |
Creates a new organization invitation.
Task<OrganizationInvitation> CreateInvitationAsync(string organizationId, OrganizationCreateInvitationRequest request, CancellationToken cancellationToken = default(CancellationToken))
+ Task<OrganizationInvitation> CreateInvitationAsync(string organizationId, OrganizationCreateInvitationRequest request, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -352,20 +352,20 @@
System.Threading.Tasks.Task<OrganizationInvitation> | +Task<OrganizationInvitation> | The new OrganizationInvitation that has been created. |
Deletes an organization.
Task DeleteAsync(string id, CancellationToken cancellationToken = default(CancellationToken))
+ Task DeleteAsync(string id, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -401,20 +401,20 @@
System.Threading.Tasks.Task | -A System.Threading.Tasks.Task that represents the asynchronous delete operation. + | Task | +A |
Deletes an organization connection.
Task DeleteConnectionAsync(string organizationId, string connectionId, CancellationToken cancellationToken = default(CancellationToken))
+ Task DeleteConnectionAsync(string organizationId, string connectionId, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -456,20 +456,20 @@
System.Threading.Tasks.Task | -A System.Threading.Tasks.Task that represents the asynchronous delete operation. + | Task | +A |
Deletes an organization invitation.
Task DeleteInvitationAsync(string organizationId, string invitationId, CancellationToken cancellationToken = default(CancellationToken))
+ Task DeleteInvitationAsync(string organizationId, string invitationId, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -511,20 +511,20 @@
System.Threading.Tasks.Task | -A System.Threading.Tasks.Task that represents the asynchronous delete operation. + | Task | +A |
Deletes members from an organization.
Task DeleteMemberAsync(string organizationId, OrganizationDeleteMembersRequest request, CancellationToken cancellationToken = default(CancellationToken))
+ Task DeleteMemberAsync(string organizationId, OrganizationDeleteMembersRequest request, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -566,20 +566,20 @@
System.Threading.Tasks.Task | -A System.Threading.Tasks.Task that represents the asynchronous delete operation. + | Task | +A |
Deletes roles from an organization member.
Task DeleteMemberRolesAsync(string organizationId, string userId, OrganizationDeleteMemberRolesRequest request, CancellationToken cancellationToken = default(CancellationToken))
+ Task DeleteMemberRolesAsync(string organizationId, string userId, OrganizationDeleteMemberRolesRequest request, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -627,20 +627,20 @@
System.Threading.Tasks.Task | -A System.Threading.Tasks.Task that represents the asynchronous delete operation. + | Task | +A |
Retrieves a list of all organizations using checkpoint pagination
.
Task<ICheckpointPagedList<Organization>> GetAllAsync(CheckpointPaginationInfo pagination, CancellationToken cancellationToken = default(CancellationToken))
+ Task<ICheckpointPagedList<Organization>> GetAllAsync(CheckpointPaginationInfo pagination, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -676,20 +676,20 @@
System.Threading.Tasks.Task<ICheckpointPagedList<Organization>> | +Task<ICheckpointPagedList<Organization>> | An ICheckpointPagedList<T> containing the organizations. |
Retrieves a list of all organizations.
Task<IPagedList<Organization>> GetAllAsync(PaginationInfo pagination, CancellationToken cancellationToken = default(CancellationToken))
+ Task<IPagedList<Organization>> GetAllAsync(PaginationInfo pagination, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -725,20 +725,20 @@
System.Threading.Tasks.Task<IPagedList<Organization>> | +Task<IPagedList<Organization>> | An IPagedList<T> containing the organizations. |
Retrieves a list of all organization connections.
Task<IPagedList<OrganizationConnection>> GetAllConnectionsAsync(string organizationId, PaginationInfo pagination, CancellationToken cancellationToken = default(CancellationToken))
+ Task<IPagedList<OrganizationConnection>> GetAllConnectionsAsync(string organizationId, PaginationInfo pagination, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -780,20 +780,20 @@
System.Threading.Tasks.Task<IPagedList<OrganizationConnection>> | +Task<IPagedList<OrganizationConnection>> | An IPagedList<T> containing the organization connections. |
Retrieves a list of all organization invitations.
Task<IPagedList<OrganizationInvitation>> GetAllInvitationsAsync(string organizationId, OrganizationGetAllInvitationsRequest request, PaginationInfo pagination, CancellationToken cancellationToken = default(CancellationToken))
+ Task<IPagedList<OrganizationInvitation>> GetAllInvitationsAsync(string organizationId, OrganizationGetAllInvitationsRequest request, PaginationInfo pagination, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -841,20 +841,20 @@
System.Threading.Tasks.Task<IPagedList<OrganizationInvitation>> | +Task<IPagedList<OrganizationInvitation>> | An IPagedList<T> containing the organization members. |
Retrieves a list of all roles for an organization members.
Task<IPagedList<Role>> GetAllMemberRolesAsync(string organizationId, string userId, PaginationInfo pagination, CancellationToken cancellationToken = default(CancellationToken))
+ Task<IPagedList<Role>> GetAllMemberRolesAsync(string organizationId, string userId, PaginationInfo pagination, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -902,20 +902,20 @@
System.Threading.Tasks.Task<IPagedList<Role>> | +Task<IPagedList<Role>> | An IPagedList<T> containing the organization members. |
Retrieves a list of all organization members using checkpoint pagination
.
Task<ICheckpointPagedList<OrganizationMember>> GetAllMembersAsync(string organizationId, CheckpointPaginationInfo pagination, CancellationToken cancellationToken = default(CancellationToken))
+ Task<ICheckpointPagedList<OrganizationMember>> GetAllMembersAsync(string organizationId, CheckpointPaginationInfo pagination, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -957,20 +957,20 @@
System.Threading.Tasks.Task<ICheckpointPagedList<OrganizationMember>> | +Task<ICheckpointPagedList<OrganizationMember>> | An ICheckpointPagedList<T> containing the organization members. |
Retrieves a list of all organization members.
Task<IPagedList<OrganizationMember>> GetAllMembersAsync(string organizationId, PaginationInfo pagination, CancellationToken cancellationToken = default(CancellationToken))
+ Task<IPagedList<OrganizationMember>> GetAllMembersAsync(string organizationId, PaginationInfo pagination, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -1012,20 +1012,20 @@
System.Threading.Tasks.Task<IPagedList<OrganizationMember>> | +Task<IPagedList<OrganizationMember>> | An IPagedList<T> containing the organization members. |
Retrieves an organization by its id.
Task<Organization> GetAsync(string id, CancellationToken cancellationToken = default(CancellationToken))
+ Task<Organization> GetAsync(string id, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -1061,20 +1061,20 @@
System.Threading.Tasks.Task<Organization> | +Task<Organization> | The Organization retrieved. |
Retrieves an organization by its name.
Task<Organization> GetByNameAsync(string name, CancellationToken cancellationToken = default(CancellationToken))
+ Task<Organization> GetByNameAsync(string name, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -1110,20 +1110,20 @@
System.Threading.Tasks.Task<Organization> | +Task<Organization> | The Organization retrieved. |
Retrieves an organization connection by its id.
Task<OrganizationConnection> GetConnectionAsync(string organizationId, string connectionId, CancellationToken cancellationToken = default(CancellationToken))
+ Task<OrganizationConnection> GetConnectionAsync(string organizationId, string connectionId, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -1165,20 +1165,20 @@
System.Threading.Tasks.Task<OrganizationConnection> | +Task<OrganizationConnection> | The OrganizationConnection retrieved. |
Retrieves an organization invitation by its id.
Task<OrganizationInvitation> GetInvitationAsync(string organizationId, string invitationId, OrganizationGetInvitationRequest request, CancellationToken cancellationToken = default(CancellationToken))
+ Task<OrganizationInvitation> GetInvitationAsync(string organizationId, string invitationId, OrganizationGetInvitationRequest request, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -1226,20 +1226,20 @@
System.Threading.Tasks.Task<OrganizationInvitation> | +Task<OrganizationInvitation> | The OrganizationInvitation retrieved. |
Updates an organization.
Task<Organization> UpdateAsync(string id, OrganizationUpdateRequest request, CancellationToken cancellationToken = default(CancellationToken))
+ Task<Organization> UpdateAsync(string id, OrganizationUpdateRequest request, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -1281,20 +1281,20 @@
System.Threading.Tasks.Task<Organization> | +Task<Organization> | The Organization that was updated. |
Updates an organization connection.
Task<OrganizationConnection> UpdateConnectionAsync(string organizationId, string connectionId, OrganizationConnectionUpdateRequest request, CancellationToken cancellationToken = default(CancellationToken))
+ Task<OrganizationConnection> UpdateConnectionAsync(string organizationId, string connectionId, OrganizationConnectionUpdateRequest request, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -1342,7 +1342,7 @@ ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
System.Threading.Tasks.Task<OrganizationConnection> | +Task<OrganizationConnection> | The OrganizationConnection that was updated. |
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -120,23 +120,23 @@
System.Threading.Tasks.Task<Prompt> | +Task<Prompt> | A Prompt instance containing the information about the prompt settings. |
Get prompts settings
Update prompts settings.
Task<Prompt> UpdateAsync(PromptUpdateRequest request, CancellationToken cancellationToken = default(CancellationToken))
+ Task<Prompt> UpdateAsync(PromptUpdateRequest request, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -172,13 +172,13 @@
System.Threading.Tasks.Task<Prompt> | +Task<Prompt> | The Prompt that was updated. |
Update prompts settings.
Creates a new resource server.
Task<ResourceServer> CreateAsync(ResourceServerCreateRequest request, CancellationToken cancellationToken = default(CancellationToken))
+ Task<ResourceServer> CreateAsync(ResourceServerCreateRequest request, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -126,20 +126,20 @@
System.Threading.Tasks.Task<ResourceServer> | +Task<ResourceServer> | The newly created ResourceServer. |
Deletes a resource server.
Task DeleteAsync(string id, CancellationToken cancellationToken = default(CancellationToken))
+ Task DeleteAsync(string id, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -175,20 +175,20 @@
System.Threading.Tasks.Task | -A System.Threading.Tasks.Task that represents the asynchronous delete operation. + | Task | +A |
Gets a list of all the resource servers.
Task<IPagedList<ResourceServer>> GetAllAsync(PaginationInfo pagination = null, CancellationToken cancellationToken = default(CancellationToken))
+ Task<IPagedList<ResourceServer>> GetAllAsync(PaginationInfo pagination = null, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -224,20 +224,20 @@
System.Threading.Tasks.Task<IPagedList<ResourceServer>> | +Task<IPagedList<ResourceServer>> | A IPagedList<T> containing the list of resource servers. |
Get a resource server by its id.
Task<ResourceServer> GetAsync(string id, CancellationToken cancellationToken = default(CancellationToken))
+ Task<ResourceServer> GetAsync(string id, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -273,20 +273,20 @@
System.Threading.Tasks.Task<ResourceServer> | +Task<ResourceServer> | The ResourceServer that was requested. |
Updates a resource server,
Task<ResourceServer> UpdateAsync(string id, ResourceServerUpdateRequest request, CancellationToken cancellationToken = default(CancellationToken))
+ Task<ResourceServer> UpdateAsync(string id, ResourceServerUpdateRequest request, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -328,7 +328,7 @@ ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
System.Threading.Tasks.Task<ResourceServer> | +Task<ResourceServer> | The newly updated ResourceServer. |
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -132,20 +132,20 @@
System.Threading.Tasks.Task | -A System.Threading.Tasks.Task that represents the asynchronous assignment operation. + | Task | +A |
Assigns Users to a role.
Task AssignUsersAsync(string id, AssignUsersRequest request, CancellationToken cancellationToken = default(CancellationToken))
+ Task AssignUsersAsync(string id, AssignUsersRequest request, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -187,20 +187,20 @@
System.Threading.Tasks.Task | -A System.Threading.Tasks.Task that represents the asynchronous assign operation. + | Task | +A |
Creates a new role according to the request.
Task<Role> CreateAsync(RoleCreateRequest request, CancellationToken cancellationToken = default(CancellationToken))
+ Task<Role> CreateAsync(RoleCreateRequest request, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -236,20 +236,20 @@
System.Threading.Tasks.Task<Role> | +Task<Role> | The newly created Role. |
Deletes a role.
Task DeleteAsync(string id, CancellationToken cancellationToken = default(CancellationToken))
+ Task DeleteAsync(string id, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -285,20 +285,20 @@
System.Threading.Tasks.Task | -A System.Threading.Tasks.Task that represents the asynchronous delete operation. + | Task | +A |
Retrieves a list of all roles.
Task<IPagedList<Role>> GetAllAsync(GetRolesRequest request, PaginationInfo pagination, CancellationToken cancellationToken = default(CancellationToken))
+ Task<IPagedList<Role>> GetAllAsync(GetRolesRequest request, PaginationInfo pagination, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -340,20 +340,20 @@
System.Threading.Tasks.Task<IPagedList<Role>> | +Task<IPagedList<Role>> | An IPagedList<T> containing the roles requested. |
Retrieves a list of all roles.
Task<IPagedList<Role>> GetAllAsync(GetRolesRequest request, CancellationToken cancellationToken = default(CancellationToken))
+ Task<IPagedList<Role>> GetAllAsync(GetRolesRequest request, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -389,20 +389,20 @@
System.Threading.Tasks.Task<IPagedList<Role>> | +Task<IPagedList<Role>> | An IPagedList<T> containing the roles |
Retrieves a role by its ID.
Task<Role> GetAsync(string id, CancellationToken cancellationToken = default(CancellationToken))
+ Task<Role> GetAsync(string id, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -438,20 +438,20 @@
System.Threading.Tasks.Task<Role> | +Task<Role> | The Role that was requested. |
Gets the permissions assigned to a role.
Task<IPagedList<Permission>> GetPermissionsAsync(string id, PaginationInfo pagination, CancellationToken cancellationToken = default(CancellationToken))
+ Task<IPagedList<Permission>> GetPermissionsAsync(string id, PaginationInfo pagination, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -493,20 +493,20 @@
System.Threading.Tasks.Task<IPagedList<Permission>> | +Task<IPagedList<Permission>> | An IPagedList<T> containing the assigned permissions for this role. |
Retrieves a list of users associated with a role.
Task<ICheckpointPagedList<AssignedUser>> GetUsersAsync(string id, CheckpointPaginationInfo pagination, CancellationToken cancellationToken = default(CancellationToken))
+ Task<ICheckpointPagedList<AssignedUser>> GetUsersAsync(string id, CheckpointPaginationInfo pagination, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -548,20 +548,20 @@
System.Threading.Tasks.Task<ICheckpointPagedList<AssignedUser>> | +Task<ICheckpointPagedList<AssignedUser>> | An IPagedList<T> containing the assigned users. |
Retrieves a list of users associated with a role.
Task<IPagedList<AssignedUser>> GetUsersAsync(string id, PaginationInfo pagination, CancellationToken cancellationToken = default(CancellationToken))
+ Task<IPagedList<AssignedUser>> GetUsersAsync(string id, PaginationInfo pagination, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -603,20 +603,20 @@
System.Threading.Tasks.Task<IPagedList<AssignedUser>> | +Task<IPagedList<AssignedUser>> | An IPagedList<T> containing the assigned users. |
Retrieves a list of users associated with a role.
Task<IPagedList<AssignedUser>> GetUsersAsync(string id, CancellationToken cancellationToken = default(CancellationToken))
+ Task<IPagedList<AssignedUser>> GetUsersAsync(string id, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -652,20 +652,20 @@
System.Threading.Tasks.Task<IPagedList<AssignedUser>> | +Task<IPagedList<AssignedUser>> | An IPagedList<T> containing the assigned users. |
Remove permissions assigned to a role.
Task RemovePermissionsAsync(string id, AssignPermissionsRequest request, CancellationToken cancellationToken = default(CancellationToken))
+ Task RemovePermissionsAsync(string id, AssignPermissionsRequest request, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -707,20 +707,20 @@
System.Threading.Tasks.Task | -A System.Threading.Tasks.Task that represents the asynchronous remove operation. + | Task | +A |
Updates a role.
Task<Role> UpdateAsync(string id, RoleUpdateRequest request, CancellationToken cancellationToken = default(CancellationToken))
+ Task<Role> UpdateAsync(string id, RoleUpdateRequest request, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -762,7 +762,7 @@ ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
System.Threading.Tasks.Task<Role> | +Task<Role> | The newly updated Role. |
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -126,20 +126,20 @@
System.Threading.Tasks.Task<Rule> | +Task<Rule> | The newly created Rule. |
Deletes a rule.
Task DeleteAsync(string id, CancellationToken cancellationToken = default(CancellationToken))
+ Task DeleteAsync(string id, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -175,20 +175,20 @@
System.Threading.Tasks.Task | -A System.Threading.Tasks.Task that represents the asynchronous delete operation. + | Task | +A |
Retrieves a list of all rules.
Task<IPagedList<Rule>> GetAllAsync(GetRulesRequest request, PaginationInfo pagination = null, CancellationToken cancellationToken = default(CancellationToken))
+ Task<IPagedList<Rule>> GetAllAsync(GetRulesRequest request, PaginationInfo pagination = null, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -230,20 +230,20 @@
System.Threading.Tasks.Task<IPagedList<Rule>> | +Task<IPagedList<Rule>> | An IPagedList<T> containing the rules requested. |
Retrieves a rule by its ID.
Task<Rule> GetAsync(string id, string fields = null, bool includeFields = true, CancellationToken cancellationToken = default(CancellationToken))
+ Task<Rule> GetAsync(string id, string fields = null, bool includeFields = true, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -293,20 +293,20 @@
System.Threading.Tasks.Task<Rule> | +Task<Rule> | The Rule that was requested. |
Updates a rule.
Task<Rule> UpdateAsync(string id, RuleUpdateRequest request, CancellationToken cancellationToken = default(CancellationToken))
+ Task<Rule> UpdateAsync(string id, RuleUpdateRequest request, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -348,7 +348,7 @@ ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
System.Threading.Tasks.Task<Rule> | +Task<Rule> | The newly updated Rule. |
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -126,20 +126,20 @@
System.Threading.Tasks.Task<RulesConfig> | +Task<RulesConfig> | The newly created Rule. |
Deletes a rules config variable.
Task DeleteAsync(string key, CancellationToken cancellationToken = default(CancellationToken))
+ Task DeleteAsync(string key, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -175,8 +175,8 @@ ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
System.Threading.Tasks.Task | -A System.Threading.Tasks.Task that represents the asynchronous delete operation. + | Task | +A |
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -120,20 +120,20 @@
System.Threading.Tasks.Task<System.Int64> | +Task<System.Int64> | The number of users that have logged in during the last 30 days. |
Gets the daily stats for a particular period.
Task<IList<DailyStatistics>> GetDailyStatsAsync(DateTime from, DateTime to, CancellationToken cancellationToken = default(CancellationToken))
+ Task<IList<DailyStatistics>> GetDailyStatsAsync(DateTime from, DateTime to, CancellationToken cancellationToken = null)
System.DateTime | +DateTime | from | The first day of the period (inclusive). |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
System.DateTime | +DateTime | to | The last day of the period (inclusive). |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -175,7 +175,7 @@ ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
System.Threading.Tasks.Task<System.Collections.Generic.IList<DailyStatistics>> | +Task<IList<DailyStatistics>> | A list of DailyStatistics containing the statistics for each day in the period. |
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -134,20 +134,20 @@
System.Threading.Tasks.Task<TenantSettings> | +Task<TenantSettings> | A TenantSettings containing the settings for the tenant. |
Updates the settings for the tenant.
Task<TenantSettings> UpdateAsync(TenantSettingsUpdateRequest request, CancellationToken cancellationToken = default(CancellationToken))
+ Task<TenantSettings> UpdateAsync(TenantSettingsUpdateRequest request, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -183,7 +183,7 @@ ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
System.Threading.Tasks.Task<TenantSettings> | +Task<TenantSettings> | A TenantSettings containing the updated settings for the tenant. |
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -126,20 +126,20 @@
System.Threading.Tasks.Task<Ticket> | +Task<Ticket> | The newly created Ticket. |
Creates a password change ticket.
Task<Ticket> CreatePasswordChangeTicketAsync(PasswordChangeTicketRequest request, CancellationToken cancellationToken = default(CancellationToken))
+ Task<Ticket> CreatePasswordChangeTicketAsync(PasswordChangeTicketRequest request, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -175,7 +175,7 @@ ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
System.Threading.Tasks.Task<Ticket> | +Task<Ticket> | The newly created Ticket. |
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -126,20 +126,20 @@
System.Threading.Tasks.Task<UserBlocks> | +Task<UserBlocks> | The UserBlocks relating to the user requested. |
Get a user's blocks by user id.
Task<UserBlocks> GetByUserIdAsync(string id, CancellationToken cancellationToken = default(CancellationToken))
+ Task<UserBlocks> GetByUserIdAsync(string id, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -175,20 +175,20 @@
System.Threading.Tasks.Task<UserBlocks> | +Task<UserBlocks> | The UserBlocks relating to the user requested. |
Unblock a user by their identifier.
Task UnblockByIdentifierAsync(string identifier, CancellationToken cancellationToken = default(CancellationToken))
+ Task UnblockByIdentifierAsync(string identifier, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -224,20 +224,20 @@
System.Threading.Tasks.Task | -A System.Threading.Tasks.Task that represents the asynchronous unblock operation. + | Task | +A |
Unblock a user by their id.
Task UnblockByUserIdAsync(string id, CancellationToken cancellationToken = default(CancellationToken))
+ Task UnblockByUserIdAsync(string id, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -273,8 +273,8 @@
System.Threading.Tasks.Task | -A System.Threading.Tasks.Task that represents the asynchronous unblock operation. + | Task | +A |
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -132,20 +132,20 @@
System.Threading.Tasks.Task | -A System.Threading.Tasks.Task that represents the asynchronous assignment operation. + | Task | +A |
Assigns Roles to a user.
Task AssignRolesAsync(string id, AssignRolesRequest request, CancellationToken cancellationToken = default(CancellationToken))
+ Task AssignRolesAsync(string id, AssignRolesRequest request, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -187,20 +187,20 @@
System.Threading.Tasks.Task | -A System.Threading.Tasks.Task that represents the asynchronous assign operation. + | Task | +A |
Creates a new user.
Task<User> CreateAsync(UserCreateRequest request, CancellationToken cancellationToken = default(CancellationToken))
+ Task<User> CreateAsync(UserCreateRequest request, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -236,20 +236,20 @@
System.Threading.Tasks.Task<User> | +Task<User> | The newly created User. |
Creates an authentication method for a given user.
Task<AuthenticationMethod> CreateAuthenticationMethodAsync(string userId, AuthenticationMethodCreateRequest request, CancellationToken cancellationToken = default(CancellationToken))
+ Task<AuthenticationMethod> CreateAuthenticationMethodAsync(string userId, AuthenticationMethodCreateRequest request, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -291,13 +291,13 @@
System.Threading.Tasks.Task<AuthenticationMethod> | +Task<AuthenticationMethod> | The newly created AuthenticationMethod. |
Authentication methods created via this endpoint will be auto confirmed and should already have verification completed.
A System.Threading.Tasks.Task that represents the asynchronous delete operation.
+A
Deletes an authentication method by id,.
Task DeleteAuthenticationMethodAsync(string userId, string authenticationMethodId, CancellationToken cancellationToken = default(CancellationToken))
+ Task DeleteAuthenticationMethodAsync(string userId, string authenticationMethodId, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -392,20 +392,20 @@
System.Threading.Tasks.Task | -A System.Threading.Tasks.Task that represents the asynchronous delete operation. + | Task | +A |
Deletes all authentication methods for the given user.
Task DeleteAuthenticationMethodsAsync(string userId, CancellationToken cancellationToken = default(CancellationToken))
+ Task DeleteAuthenticationMethodsAsync(string userId, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -441,20 +441,20 @@
System.Threading.Tasks.Task | -A System.Threading.Tasks.Task that represents the asynchronous delete operation. + | Task | +A |
Deletes a user's multifactor provider.
Task DeleteMultifactorProviderAsync(string id, string provider, CancellationToken cancellationToken = default(CancellationToken))
+ Task DeleteMultifactorProviderAsync(string id, string provider, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -496,20 +496,20 @@
System.Threading.Tasks.Task | -A System.Threading.Tasks.Task that represents the asynchronous delete operation. + | Task | +A |
Generate new Guardian recovery code.
Task<GenerateRecoveryCodeResponse> GenerateRecoveryCodeAsync(string id, CancellationToken cancellationToken = default(CancellationToken))
+ Task<GenerateRecoveryCodeResponse> GenerateRecoveryCodeAsync(string id, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -545,20 +545,20 @@
System.Threading.Tasks.Task<GenerateRecoveryCodeResponse> | +Task<GenerateRecoveryCodeResponse> | A Task representing the operation and potential return value. |
Lists or search for users based on criteria.
Task<IPagedList<User>> GetAllAsync(GetUsersRequest request, PaginationInfo pagination = null, CancellationToken cancellationToken = default(CancellationToken))
+ Task<IPagedList<User>> GetAllAsync(GetUsersRequest request, PaginationInfo pagination = null, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -600,20 +600,20 @@
System.Threading.Tasks.Task<IPagedList<User>> | +Task<IPagedList<User>> | An IPagedList<T> containing the list of users. |
Lists organizations for a user.
Task<IPagedList<Organization>> GetAllOrganizationsAsync(string userId, PaginationInfo pagination, CancellationToken cancellationToken = default(CancellationToken))
+ Task<IPagedList<Organization>> GetAllOrganizationsAsync(string userId, PaginationInfo pagination, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -655,20 +655,20 @@
System.Threading.Tasks.Task<IPagedList<Organization>> | +Task<IPagedList<Organization>> | An IPagedList<T> containing the list of organizations. |
Gets a user.
Task<User> GetAsync(string id, string fields = null, bool includeFields = true, CancellationToken cancellationToken = default(CancellationToken))
+ Task<User> GetAsync(string id, string fields = null, bool includeFields = true, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -718,20 +718,20 @@
System.Threading.Tasks.Task<User> | +Task<User> | The User that was requested. |
Gets an authentication method for a given user.
Task<AuthenticationMethod> GetAuthenticationMethodAsync(string userId, string authenticationMethodId, CancellationToken cancellationToken = default(CancellationToken))
+ Task<AuthenticationMethod> GetAuthenticationMethodAsync(string userId, string authenticationMethodId, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -773,20 +773,20 @@
System.Threading.Tasks.Task<AuthenticationMethod> | +Task<AuthenticationMethod> | The AuthenticationMethod that was requested. |
Gets a list of authentication methods.
Task<IPagedList<AuthenticationMethod>> GetAuthenticationMethodsAsync(string userId, PaginationInfo pagination = null, CancellationToken cancellationToken = default(CancellationToken))
+ Task<IPagedList<AuthenticationMethod>> GetAuthenticationMethodsAsync(string userId, PaginationInfo pagination = null, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -828,20 +828,20 @@
System.Threading.Tasks.Task<IPagedList<AuthenticationMethod>> | +Task<IPagedList<AuthenticationMethod>> | An IPagedList<T> containing the list of authentication methods. |
Get a list of Guardian enrollments.
Task<IList<EnrollmentsResponse>> GetEnrollmentsAsync(string id, CancellationToken cancellationToken = default(CancellationToken))
+ Task<IList<EnrollmentsResponse>> GetEnrollmentsAsync(string id, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -877,20 +877,20 @@
System.Threading.Tasks.Task<System.Collections.Generic.IList<EnrollmentsResponse>> | +Task<IList<EnrollmentsResponse>> | A Task representing the operation and potential return value. |
Retrieve every log event for a specific user.
Task<IPagedList<LogEntry>> GetLogsAsync(GetUserLogsRequest request, PaginationInfo pagination = null, CancellationToken cancellationToken = default(CancellationToken))
+ Task<IPagedList<LogEntry>> GetLogsAsync(GetUserLogsRequest request, PaginationInfo pagination = null, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -932,20 +932,20 @@
System.Threading.Tasks.Task<IPagedList<LogEntry>> | +Task<IPagedList<LogEntry>> | An IPagedList<T> containing the log entries for the user. |
Get the permissions assigned to the user.
Task<IPagedList<UserPermission>> GetPermissionsAsync(string id, PaginationInfo pagination = null, CancellationToken cancellationToken = default(CancellationToken))
+ Task<IPagedList<UserPermission>> GetPermissionsAsync(string id, PaginationInfo pagination = null, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -987,20 +987,20 @@
System.Threading.Tasks.Task<IPagedList<UserPermission>> | +Task<IPagedList<UserPermission>> | An IPagedList<T> containing the assigned permissions for this user. |
Retrieve assigned roles for a specific user.
Task<IPagedList<Role>> GetRolesAsync(string userId, PaginationInfo pagination = null, CancellationToken cancellationToken = default(CancellationToken))
+ Task<IPagedList<Role>> GetRolesAsync(string userId, PaginationInfo pagination = null, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -1042,20 +1042,20 @@
System.Threading.Tasks.Task<IPagedList<Role>> | +Task<IPagedList<Role>> | An IPagedList<T> containing the roles for the user. |
Gets all users by email address.
Task<IList<User>> GetUsersByEmailAsync(string email, string fields = null, bool? includeFields = null, CancellationToken cancellationToken = default(CancellationToken))
+ Task<IList<User>> GetUsersByEmailAsync(string email, string fields = null, bool? includeFields = null, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -1103,20 +1103,20 @@
System.Threading.Tasks.Task<System.Collections.Generic.IList<User>> | -A System.Collections.Generic.IList<T> containing all users for this email address. + | Task<IList<User>> | +A |
Invalidate all remembered browsers for MFA.
Task InvalidateRememberBrowserAsync(string id, CancellationToken cancellationToken = default(CancellationToken))
+ Task InvalidateRememberBrowserAsync(string id, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -1152,20 +1152,20 @@
System.Threading.Tasks.Task | +Task | A Task representing the operation and potential return value. |
Links a secondary account to a primary account.
Task<IList<AccountLinkResponse>> LinkAccountAsync(string id, UserAccountLinkRequest request, CancellationToken cancellationToken = default(CancellationToken))
+ Task<IList<AccountLinkResponse>> LinkAccountAsync(string id, UserAccountLinkRequest request, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -1207,20 +1207,20 @@
System.Threading.Tasks.Task<System.Collections.Generic.IList<AccountLinkResponse>> | -A System.Collections.Generic.IList<T> containing details about this account link. + | Task<IList<AccountLinkResponse>> | +A |
Links a secondary account to a primary account.
Task<IList<AccountLinkResponse>> LinkAccountAsync(string id, string primaryJwtToken, string secondaryJwtToken, CancellationToken cancellationToken = default(CancellationToken))
+ Task<IList<AccountLinkResponse>> LinkAccountAsync(string id, string primaryJwtToken, string secondaryJwtToken, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -1268,20 +1268,20 @@
System.Threading.Tasks.Task<System.Collections.Generic.IList<AccountLinkResponse>> | -A System.Collections.Generic.IList<T> containing details about this account link. + | Task<IList<AccountLinkResponse>> | +A |
Removes permissions assigned to a user.
Task RemovePermissionsAsync(string id, AssignPermissionsRequest request, CancellationToken cancellationToken = default(CancellationToken))
+ Task RemovePermissionsAsync(string id, AssignPermissionsRequest request, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -1323,20 +1323,20 @@
System.Threading.Tasks.Task | -A System.Threading.Tasks.Task that represents the asynchronous remove operation. + | Task | +A |
Removes Roles from a user.
Task RemoveRolesAsync(string id, AssignRolesRequest request, CancellationToken cancellationToken = default(CancellationToken))
+ Task RemoveRolesAsync(string id, AssignRolesRequest request, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -1378,20 +1378,20 @@
System.Threading.Tasks.Task | -A System.Threading.Tasks.Task that represents the asynchronous remove operation. + | Task | +A |
Unlinks user accounts
Task<IList<AccountLinkResponse>> UnlinkAccountAsync(string primaryUserId, string provider, string secondaryUserId, CancellationToken cancellationToken = default(CancellationToken))
+ Task<IList<AccountLinkResponse>> UnlinkAccountAsync(string primaryUserId, string provider, string secondaryUserId, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -1439,20 +1439,20 @@
System.Threading.Tasks.Task<System.Collections.Generic.IList<AccountLinkResponse>> | -A System.Collections.Generic.IList<T> containing details about this account link. + | Task<IList<AccountLinkResponse>> | +A |
Updates a user.
Task<User> UpdateAsync(string id, UserUpdateRequest request, CancellationToken cancellationToken = default(CancellationToken))
+ Task<User> UpdateAsync(string id, UserUpdateRequest request, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -1494,20 +1494,20 @@
System.Threading.Tasks.Task<User> | +Task<User> | The newly updated User. |
Update an authentication methods.
Task<AuthenticationMethod> UpdateAuthenticationMethodAsync(string userId, string authenticationMethodId, AuthenticationMethodUpdateRequest request, CancellationToken cancellationToken = default(CancellationToken))
+ Task<AuthenticationMethod> UpdateAuthenticationMethodAsync(string userId, string authenticationMethodId, AuthenticationMethodUpdateRequest request, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -1555,20 +1555,20 @@
System.Threading.Tasks.Task<AuthenticationMethod> | +Task<AuthenticationMethod> | The updated AuthenticationMethod. |
Updates all authentication methods by replacing them with the given ones.
Task<IList<AuthenticationMethod>> UpdateAuthenticationMethodsAsync(string userId, IList<AuthenticationMethodsUpdateRequest> request, CancellationToken cancellationToken = default(CancellationToken))
+ Task<IList<AuthenticationMethod>> UpdateAuthenticationMethodsAsync(string userId, IList<AuthenticationMethodsUpdateRequest> request, CancellationToken cancellationToken = null)
System.Collections.Generic.IList<AuthenticationMethodsUpdateRequest> | +IList<AuthenticationMethodsUpdateRequest> | request | The AuthenticationMethodsUpdateRequest containing the properties of the authentication methods to update. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -1610,7 +1610,7 @@ ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
System.Threading.Tasks.Task<System.Collections.Generic.IList<AuthenticationMethod>> | +Task<IList<AuthenticationMethod>> | The updated list of AuthenticationMethod. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
System.Uri | +Uri | baseUri | -System.Uri of the endpoint to use in making API calls. + | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
System.Collections.Generic.IDictionary<System.String, System.String> | +IDictionary<System.String, System.String> | defaultHeaders | Dictionary containing default headers included with every request this client makes. |
@@ -175,13 +154,13 @@
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -217,23 +196,23 @@
System.Threading.Tasks.Task<Job> | +Task<Job> | A Job instance containing the information about the job. |
The documentation for user exports can be found here.
Gets a job.
public Task<Job> GetAsync(string id, CancellationToken cancellationToken = default(CancellationToken))
+ public Task<Job> GetAsync(string id, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -269,23 +248,23 @@
System.Threading.Tasks.Task<Job> | +Task<Job> | A Job instance containing the information about the job. |
This is useful to check the status of a job.
Imports users to a connection from a file using a long running job.
public Task<Job> ImportUsersAsync(string connectionId, string fileName, Stream file, bool? upsert = null, string externalId = null, bool? sendCompletionEmail = null, CancellationToken cancellationToken = default(CancellationToken))
+ public Task<Job> ImportUsersAsync(string connectionId, string fileName, Stream file, bool? upsert = null, string externalId = null, bool? sendCompletionEmail = null, CancellationToken cancellationToken = null)
System.IO.Stream | +Stream | file | The file. |
@@ -334,7 +313,7 @@
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -351,23 +330,23 @@
System.Threading.Tasks.Task<Job> | +Task<Job> | A Job instance containing the information about the job. |
The documentation for the file format is here.
Send an email to the specified user that asks them to click a link to verify their email address.
public Task<Job> SendVerificationEmailAsync(VerifyEmailJobRequest request, CancellationToken cancellationToken = default(CancellationToken))
+ public Task<Job> SendVerificationEmailAsync(VerifyEmailJobRequest request, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -403,7 +382,7 @@ ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
System.Threading.Tasks.Task<Job> | +Task<Job> | A Job instance containing the information about the job. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
System.Uri | +Uri | baseUri | -System.Uri of the endpoint to use in making API calls. + | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
System.Collections.Generic.IDictionary<System.String, System.String> | +IDictionary<System.String, System.String> | defaultHeaders | Dictionary containing default headers included with every request this client makes. |
@@ -175,13 +154,13 @@
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -211,20 +190,20 @@
System.Threading.Tasks.Task<System.Collections.Generic.IList<Key>> | +Task<IList<Key>> | All available signing keys Key. |
Get an Application Signing Key by its key ID.
public Task<Key> GetAsync(string kid, CancellationToken cancellationToken = default(CancellationToken))
+ public Task<Key> GetAsync(string kid, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -260,20 +239,20 @@
System.Threading.Tasks.Task<Key> | +Task<Key> | The Key that was requested. |
Revoke an Application Signing Key by its key ID.
public Task<RevokeSigningKeyResponse> RevokeSigningKeyAsync(string kid, CancellationToken cancellationToken = default(CancellationToken))
+ public Task<RevokeSigningKeyResponse> RevokeSigningKeyAsync(string kid, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -309,20 +288,20 @@
System.Threading.Tasks.Task<RevokeSigningKeyResponse> | +Task<RevokeSigningKeyResponse> | The revoked key's cert and kid. |
Rotate the Application Signing Key.
public Task<RotateSigningKeyResponse> RotateSigningKeyAsync(CancellationToken cancellationToken = default(CancellationToken))
+ public Task<RotateSigningKeyResponse> RotateSigningKeyAsync(CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -352,7 +331,7 @@ ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
System.Threading.Tasks.Task<RotateSigningKeyResponse> | +Task<RotateSigningKeyResponse> | The next rotated key's cert and kid. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
System.Uri | +Uri | baseUri | -System.Uri of the endpoint to use in making API calls. + | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
System.Collections.Generic.IDictionary<System.String, System.String> | +IDictionary<System.String, System.String> | defaultHeaders | Dictionary containing default headers included with every request this client makes. |
@@ -175,13 +154,13 @@
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -217,20 +196,20 @@
System.Threading.Tasks.Task<LogStream> | -A System.Threading.Tasks.Task that represents the asynchronous create operation. + | Task<LogStream> | +A |
Deletes a log stream
public Task DeleteAsync(string id, CancellationToken cancellationToken = default(CancellationToken))
+ public Task DeleteAsync(string id, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -266,20 +245,20 @@
System.Threading.Tasks.Task | -A System.Threading.Tasks.Task that represents the asynchronous delete operation. + | Task | +A |
Gets all of the log streams
public Task<IList<LogStream>> GetAllAsync(CancellationToken cancellationToken = default(CancellationToken))
+ public Task<IList<LogStream>> GetAllAsync(CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | |
System.Threading.Tasks.Task<System.Collections.Generic.IList<LogStream>> | +Task<IList<LogStream>> | A list of LogStream objects |
Gets a log stream
public Task<LogStream> GetAsync(string id, CancellationToken cancellationToken = default(CancellationToken))
+ public Task<LogStream> GetAsync(string id, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -357,20 +336,20 @@
System.Threading.Tasks.Task<LogStream> | +Task<LogStream> | A LogStream object |
Updates a log stream
public Task<LogStream> UpdateAsync(string id, LogStreamUpdateRequest request, CancellationToken cancellationToken = default(CancellationToken))
+ public Task<LogStream> UpdateAsync(string id, LogStreamUpdateRequest request, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -412,7 +391,7 @@ ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
System.Threading.Tasks.Task<LogStream> | +Task<LogStream> | The updated LogStream object |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
System.Uri | +Uri | baseUri | -System.Uri of the endpoint to use in making API calls. + | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
System.Collections.Generic.IDictionary<System.String, System.String> | +IDictionary<System.String, System.String> | defaultHeaders | Dictionary containing default headers included with every request this client makes. |
@@ -175,13 +154,13 @@
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -223,20 +202,20 @@
System.Threading.Tasks.Task<IPagedList<LogEntry>> | +Task<IPagedList<LogEntry>> | An IPagedList<T> containing the list of log entries. |
Retrieves the data related to the log entry identified by id. This returns a single log entry representation as specified in the schema.
public Task<LogEntry> GetAsync(string id, CancellationToken cancellationToken = default(CancellationToken))
+ public Task<LogEntry> GetAsync(string id, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -272,7 +251,7 @@ ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
System.Threading.Tasks.Task<LogEntry> | +Task<LogEntry> | A LogEntry instance containing the information about the log entry. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
System.Uri | +Uri | baseUri | -System.Uri of the endpoint to use in making API calls. + | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
System.Collections.Generic.IDictionary<System.String, System.String> | +IDictionary<System.String, System.String> | defaultHeaders | Dictionary containing default headers included with every request this client makes. |
@@ -174,13 +153,13 @@
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -228,20 +207,20 @@
System.Threading.Tasks.Task | -A System.Threading.Tasks.Task that represents the asynchronous operation. + | Task | +A |
Add members to an organization.
public Task AddMembersAsync(string organizationId, OrganizationAddMembersRequest request, CancellationToken cancellationToken = default(CancellationToken))
+ public Task AddMembersAsync(string organizationId, OrganizationAddMembersRequest request, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -283,20 +262,20 @@
System.Threading.Tasks.Task | -A System.Threading.Tasks.Task that represents the asynchronous operation. + | Task | +A |
Creates a new organization.
public Task<Organization> CreateAsync(OrganizationCreateRequest request, CancellationToken cancellationToken = default(CancellationToken))
+ public Task<Organization> CreateAsync(OrganizationCreateRequest request, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -332,20 +311,20 @@
System.Threading.Tasks.Task<Organization> | +Task<Organization> | The new Organization that has been created. |
Creates a new organization connection.
public Task<OrganizationConnection> CreateConnectionAsync(string organizationId, OrganizationConnectionCreateRequest request, CancellationToken cancellationToken = default(CancellationToken))
+ public Task<OrganizationConnection> CreateConnectionAsync(string organizationId, OrganizationConnectionCreateRequest request, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -387,20 +366,20 @@
System.Threading.Tasks.Task<OrganizationConnection> | +Task<OrganizationConnection> | The new OrganizationConnection that has been created. |
Creates a new organization invitation.
public Task<OrganizationInvitation> CreateInvitationAsync(string organizationId, OrganizationCreateInvitationRequest request, CancellationToken cancellationToken = default(CancellationToken))
+ public Task<OrganizationInvitation> CreateInvitationAsync(string organizationId, OrganizationCreateInvitationRequest request, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -442,20 +421,20 @@
System.Threading.Tasks.Task<OrganizationInvitation> | +Task<OrganizationInvitation> | The new OrganizationInvitation that has been created. |
Deletes an organization.
public Task DeleteAsync(string id, CancellationToken cancellationToken = default(CancellationToken))
+ public Task DeleteAsync(string id, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -491,20 +470,20 @@
System.Threading.Tasks.Task | -A System.Threading.Tasks.Task that represents the asynchronous delete operation. + | Task | +A |
Deletes an organization connection.
public Task DeleteConnectionAsync(string organizationId, string connectionId, CancellationToken cancellationToken = default(CancellationToken))
+ public Task DeleteConnectionAsync(string organizationId, string connectionId, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -546,20 +525,20 @@
System.Threading.Tasks.Task | -A System.Threading.Tasks.Task that represents the asynchronous delete operation. + | Task | +A |
Deletes an organization invitation.
public Task DeleteInvitationAsync(string organizationId, string invitationId, CancellationToken cancellationToken = default(CancellationToken))
+ public Task DeleteInvitationAsync(string organizationId, string invitationId, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -601,20 +580,20 @@
System.Threading.Tasks.Task | -A System.Threading.Tasks.Task that represents the asynchronous delete operation. + | Task | +A |
Deletes members from an organization.
public Task DeleteMemberAsync(string organizationId, OrganizationDeleteMembersRequest request, CancellationToken cancellationToken = default(CancellationToken))
+ public Task DeleteMemberAsync(string organizationId, OrganizationDeleteMembersRequest request, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -656,20 +635,20 @@
System.Threading.Tasks.Task | -A System.Threading.Tasks.Task that represents the asynchronous delete operation. + | Task | +A |
Deletes roles from an organization member.
public Task DeleteMemberRolesAsync(string organizationId, string userId, OrganizationDeleteMemberRolesRequest request, CancellationToken cancellationToken = default(CancellationToken))
+ public Task DeleteMemberRolesAsync(string organizationId, string userId, OrganizationDeleteMemberRolesRequest request, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -717,20 +696,20 @@
System.Threading.Tasks.Task | -A System.Threading.Tasks.Task that represents the asynchronous delete operation. + | Task | +A |
Retrieves a list of all organizations using checkpoint pagination
.
public Task<ICheckpointPagedList<Organization>> GetAllAsync(CheckpointPaginationInfo pagination, CancellationToken cancellationToken = default(CancellationToken))
+ public Task<ICheckpointPagedList<Organization>> GetAllAsync(CheckpointPaginationInfo pagination, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -766,20 +745,20 @@
System.Threading.Tasks.Task<ICheckpointPagedList<Organization>> | +Task<ICheckpointPagedList<Organization>> | An ICheckpointPagedList<T> containing the organizations. |
Retrieves a list of all organizations.
public Task<IPagedList<Organization>> GetAllAsync(PaginationInfo pagination, CancellationToken cancellationToken = default(CancellationToken))
+ public Task<IPagedList<Organization>> GetAllAsync(PaginationInfo pagination, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -815,20 +794,20 @@
System.Threading.Tasks.Task<IPagedList<Organization>> | +Task<IPagedList<Organization>> | An IPagedList<T> containing the organizations. |
Retrieves a list of all organization connections.
public Task<IPagedList<OrganizationConnection>> GetAllConnectionsAsync(string organizationId, PaginationInfo pagination, CancellationToken cancellationToken = default(CancellationToken))
+ public Task<IPagedList<OrganizationConnection>> GetAllConnectionsAsync(string organizationId, PaginationInfo pagination, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -870,20 +849,20 @@
System.Threading.Tasks.Task<IPagedList<OrganizationConnection>> | +Task<IPagedList<OrganizationConnection>> | An IPagedList<T> containing the organization connections. |
Retrieves a list of all organization invitations.
public Task<IPagedList<OrganizationInvitation>> GetAllInvitationsAsync(string organizationId, OrganizationGetAllInvitationsRequest request, PaginationInfo pagination, CancellationToken cancellationToken = default(CancellationToken))
+ public Task<IPagedList<OrganizationInvitation>> GetAllInvitationsAsync(string organizationId, OrganizationGetAllInvitationsRequest request, PaginationInfo pagination, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -931,20 +910,20 @@
System.Threading.Tasks.Task<IPagedList<OrganizationInvitation>> | +Task<IPagedList<OrganizationInvitation>> | An IPagedList<T> containing the organization members. |
Retrieves a list of all roles for an organization members.
public Task<IPagedList<Role>> GetAllMemberRolesAsync(string organizationId, string userId, PaginationInfo pagination, CancellationToken cancellationToken = default(CancellationToken))
+ public Task<IPagedList<Role>> GetAllMemberRolesAsync(string organizationId, string userId, PaginationInfo pagination, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -992,20 +971,20 @@
System.Threading.Tasks.Task<IPagedList<Role>> | +Task<IPagedList<Role>> | An IPagedList<T> containing the organization members. |
Retrieves a list of all organization members using checkpoint pagination
.
public Task<ICheckpointPagedList<OrganizationMember>> GetAllMembersAsync(string organizationId, CheckpointPaginationInfo pagination, CancellationToken cancellationToken = default(CancellationToken))
+ public Task<ICheckpointPagedList<OrganizationMember>> GetAllMembersAsync(string organizationId, CheckpointPaginationInfo pagination, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -1047,20 +1026,20 @@
System.Threading.Tasks.Task<ICheckpointPagedList<OrganizationMember>> | +Task<ICheckpointPagedList<OrganizationMember>> | An ICheckpointPagedList<T> containing the organization members. |
Retrieves a list of all organization members.
public Task<IPagedList<OrganizationMember>> GetAllMembersAsync(string organizationId, PaginationInfo pagination, CancellationToken cancellationToken = default(CancellationToken))
+ public Task<IPagedList<OrganizationMember>> GetAllMembersAsync(string organizationId, PaginationInfo pagination, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -1102,20 +1081,20 @@
System.Threading.Tasks.Task<IPagedList<OrganizationMember>> | +Task<IPagedList<OrganizationMember>> | An IPagedList<T> containing the organization members. |
Retrieves an organization by its id.
public Task<Organization> GetAsync(string id, CancellationToken cancellationToken = default(CancellationToken))
+ public Task<Organization> GetAsync(string id, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -1151,20 +1130,20 @@
System.Threading.Tasks.Task<Organization> | +Task<Organization> | The Organization retrieved. |
Retrieves an organization by its name.
public Task<Organization> GetByNameAsync(string name, CancellationToken cancellationToken = default(CancellationToken))
+ public Task<Organization> GetByNameAsync(string name, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -1200,20 +1179,20 @@
System.Threading.Tasks.Task<Organization> | +Task<Organization> | The Organization retrieved. |
Retrieves an organization connection by its id.
public Task<OrganizationConnection> GetConnectionAsync(string organizationId, string connectionId, CancellationToken cancellationToken = default(CancellationToken))
+ public Task<OrganizationConnection> GetConnectionAsync(string organizationId, string connectionId, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -1255,20 +1234,20 @@
System.Threading.Tasks.Task<OrganizationConnection> | +Task<OrganizationConnection> | The OrganizationConnection retrieved. |
Retrieves an organization invitation by its id.
public Task<OrganizationInvitation> GetInvitationAsync(string organizationId, string invitationId, OrganizationGetInvitationRequest request, CancellationToken cancellationToken = default(CancellationToken))
+ public Task<OrganizationInvitation> GetInvitationAsync(string organizationId, string invitationId, OrganizationGetInvitationRequest request, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -1316,20 +1295,20 @@
System.Threading.Tasks.Task<OrganizationInvitation> | +Task<OrganizationInvitation> | The OrganizationInvitation retrieved. |
Updates an organization.
public Task<Organization> UpdateAsync(string id, OrganizationUpdateRequest request, CancellationToken cancellationToken = default(CancellationToken))
+ public Task<Organization> UpdateAsync(string id, OrganizationUpdateRequest request, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -1371,20 +1350,20 @@
System.Threading.Tasks.Task<Organization> | +Task<Organization> | The Organization that was updated. |
Updates an organization connection.
public Task<OrganizationConnection> UpdateConnectionAsync(string organizationId, string connectionId, OrganizationConnectionUpdateRequest request, CancellationToken cancellationToken = default(CancellationToken))
+ public Task<OrganizationConnection> UpdateConnectionAsync(string organizationId, string connectionId, OrganizationConnectionUpdateRequest request, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -1432,7 +1411,7 @@ |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
System.Threading.Tasks.Task<OrganizationConnection> | +Task<OrganizationConnection> | The OrganizationConnection that was updated. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
System.Uri | +Uri | baseUri | -System.Uri of the endpoint to use in making API calls. + | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
System.Collections.Generic.IDictionary<System.String, System.String> | +IDictionary<System.String, System.String> | defaultHeaders | Dictionary containing default headers included with every request this client makes. |
@@ -175,13 +154,13 @@
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -211,23 +190,23 @@
System.Threading.Tasks.Task<Prompt> | +Task<Prompt> | A Prompt instance containing the information about the prompt settings. |
Get prompts settings
Update prompts settings.
public Task<Prompt> UpdateAsync(PromptUpdateRequest request, CancellationToken cancellationToken = default(CancellationToken))
+ public Task<Prompt> UpdateAsync(PromptUpdateRequest request, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -263,13 +242,13 @@
System.Threading.Tasks.Task<Prompt> | +Task<Prompt> | The Prompt that was updated. |
Update prompts settings.
Creates a new instance of ResourceServersClient.
System.Uri of the endpoint to use in making API calls.
+Dictionary containing default headers included with every request this client makes.
Creates a new resource server.
public Task<ResourceServer> CreateAsync(ResourceServerCreateRequest request, CancellationToken cancellationToken = default(CancellationToken))
+ public Task<ResourceServer> CreateAsync(ResourceServerCreateRequest request, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -217,20 +196,20 @@
System.Threading.Tasks.Task<ResourceServer> | +Task<ResourceServer> | The newly created ResourceServer. |
Deletes a resource server.
public Task DeleteAsync(string id, CancellationToken cancellationToken = default(CancellationToken))
+ public Task DeleteAsync(string id, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -266,20 +245,20 @@
System.Threading.Tasks.Task | -A System.Threading.Tasks.Task that represents the asynchronous delete operation. + | Task | +A |
Gets a list of all the resource servers.
public Task<IPagedList<ResourceServer>> GetAllAsync(PaginationInfo pagination = null, CancellationToken cancellationToken = default(CancellationToken))
+ public Task<IPagedList<ResourceServer>> GetAllAsync(PaginationInfo pagination = null, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -315,20 +294,20 @@
System.Threading.Tasks.Task<IPagedList<ResourceServer>> | +Task<IPagedList<ResourceServer>> | A IPagedList<T> containing the list of resource servers. |
Get a resource server by its id.
public Task<ResourceServer> GetAsync(string id, CancellationToken cancellationToken = default(CancellationToken))
+ public Task<ResourceServer> GetAsync(string id, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -364,20 +343,20 @@
System.Threading.Tasks.Task<ResourceServer> | +Task<ResourceServer> | The ResourceServer that was requested. |
Updates a resource server,
public Task<ResourceServer> UpdateAsync(string id, ResourceServerUpdateRequest request, CancellationToken cancellationToken = default(CancellationToken))
+ public Task<ResourceServer> UpdateAsync(string id, ResourceServerUpdateRequest request, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -419,7 +398,7 @@ ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
System.Threading.Tasks.Task<ResourceServer> | +Task<ResourceServer> | The newly updated ResourceServer. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
System.Uri | +Uri | baseUri | -System.Uri of the endpoint to use in making API calls. + | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
System.Collections.Generic.IDictionary<System.String, System.String> | +IDictionary<System.String, System.String> | defaultHeaders | Dictionary containing default headers included with every request this client makes. |
@@ -175,13 +154,13 @@
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -223,20 +202,20 @@
System.Threading.Tasks.Task | -A System.Threading.Tasks.Task that represents the asynchronous assignment operation. + | Task | +A |
Assigns Users to a role.
public Task AssignUsersAsync(string id, AssignUsersRequest request, CancellationToken cancellationToken = default(CancellationToken))
+ public Task AssignUsersAsync(string id, AssignUsersRequest request, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -278,20 +257,20 @@
System.Threading.Tasks.Task | -A System.Threading.Tasks.Task that represents the asynchronous assign operation. + | Task | +A |
Creates a new role according to the request.
public Task<Role> CreateAsync(RoleCreateRequest request, CancellationToken cancellationToken = default(CancellationToken))
+ public Task<Role> CreateAsync(RoleCreateRequest request, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -327,20 +306,20 @@
System.Threading.Tasks.Task<Role> | +Task<Role> | The newly created Role. |
Deletes a role.
public Task DeleteAsync(string id, CancellationToken cancellationToken = default(CancellationToken))
+ public Task DeleteAsync(string id, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -376,20 +355,20 @@
System.Threading.Tasks.Task | -A System.Threading.Tasks.Task that represents the asynchronous delete operation. + | Task | +A |
Retrieves a list of all roles.
public Task<IPagedList<Role>> GetAllAsync(GetRolesRequest request, PaginationInfo pagination, CancellationToken cancellationToken = default(CancellationToken))
+ public Task<IPagedList<Role>> GetAllAsync(GetRolesRequest request, PaginationInfo pagination, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -431,20 +410,20 @@
System.Threading.Tasks.Task<IPagedList<Role>> | +Task<IPagedList<Role>> | An IPagedList<T> containing the roles requested. |
Retrieves a list of all roles.
public Task<IPagedList<Role>> GetAllAsync(GetRolesRequest request, CancellationToken cancellationToken = default(CancellationToken))
+ public Task<IPagedList<Role>> GetAllAsync(GetRolesRequest request, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -480,20 +459,20 @@
System.Threading.Tasks.Task<IPagedList<Role>> | +Task<IPagedList<Role>> | An IPagedList<T> containing the roles |
Retrieves a role by its ID.
public Task<Role> GetAsync(string id, CancellationToken cancellationToken = default(CancellationToken))
+ public Task<Role> GetAsync(string id, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -529,20 +508,20 @@
System.Threading.Tasks.Task<Role> | +Task<Role> | The Role that was requested. |
Gets the permissions assigned to a role.
public Task<IPagedList<Permission>> GetPermissionsAsync(string id, PaginationInfo pagination, CancellationToken cancellationToken = default(CancellationToken))
+ public Task<IPagedList<Permission>> GetPermissionsAsync(string id, PaginationInfo pagination, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -584,20 +563,20 @@
System.Threading.Tasks.Task<IPagedList<Permission>> | +Task<IPagedList<Permission>> | An IPagedList<T> containing the assigned permissions for this role. |
Retrieves a list of users associated with a role.
public Task<ICheckpointPagedList<AssignedUser>> GetUsersAsync(string id, CheckpointPaginationInfo pagination, CancellationToken cancellationToken = default(CancellationToken))
+ public Task<ICheckpointPagedList<AssignedUser>> GetUsersAsync(string id, CheckpointPaginationInfo pagination, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -639,20 +618,20 @@
System.Threading.Tasks.Task<ICheckpointPagedList<AssignedUser>> | +Task<ICheckpointPagedList<AssignedUser>> | An IPagedList<T> containing the assigned users. |
Retrieves a list of users associated with a role.
public Task<IPagedList<AssignedUser>> GetUsersAsync(string id, PaginationInfo pagination, CancellationToken cancellationToken = default(CancellationToken))
+ public Task<IPagedList<AssignedUser>> GetUsersAsync(string id, PaginationInfo pagination, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -694,20 +673,20 @@
System.Threading.Tasks.Task<IPagedList<AssignedUser>> | +Task<IPagedList<AssignedUser>> | An IPagedList<T> containing the assigned users. |
Retrieves a list of users associated with a role.
public Task<IPagedList<AssignedUser>> GetUsersAsync(string id, CancellationToken cancellationToken = default(CancellationToken))
+ public Task<IPagedList<AssignedUser>> GetUsersAsync(string id, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -743,20 +722,20 @@
System.Threading.Tasks.Task<IPagedList<AssignedUser>> | +Task<IPagedList<AssignedUser>> | An IPagedList<T> containing the assigned users. |
Remove permissions assigned to a role.
public Task RemovePermissionsAsync(string id, AssignPermissionsRequest request, CancellationToken cancellationToken = default(CancellationToken))
+ public Task RemovePermissionsAsync(string id, AssignPermissionsRequest request, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -798,20 +777,20 @@
System.Threading.Tasks.Task | -A System.Threading.Tasks.Task that represents the asynchronous remove operation. + | Task | +A |
Updates a role.
public Task<Role> UpdateAsync(string id, RoleUpdateRequest request, CancellationToken cancellationToken = default(CancellationToken))
+ public Task<Role> UpdateAsync(string id, RoleUpdateRequest request, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -853,7 +832,7 @@ ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
System.Threading.Tasks.Task<Role> | +Task<Role> | The newly updated Role. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
System.Uri | +Uri | baseUri | -System.Uri of the endpoint to use in making API calls. + | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
System.Collections.Generic.IDictionary<System.String, System.String> | +IDictionary<System.String, System.String> | defaultHeaders | Dictionary containing default headers included with every request this client makes. |
@@ -175,13 +154,13 @@
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -217,20 +196,20 @@
System.Threading.Tasks.Task<Rule> | +Task<Rule> | The newly created Rule. |
Deletes a rule.
public Task DeleteAsync(string id, CancellationToken cancellationToken = default(CancellationToken))
+ public Task DeleteAsync(string id, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -266,20 +245,20 @@
System.Threading.Tasks.Task | -A System.Threading.Tasks.Task that represents the asynchronous delete operation. + | Task | +A |
Retrieves a list of all rules.
public Task<IPagedList<Rule>> GetAllAsync(GetRulesRequest request, PaginationInfo pagination = null, CancellationToken cancellationToken = default(CancellationToken))
+ public Task<IPagedList<Rule>> GetAllAsync(GetRulesRequest request, PaginationInfo pagination = null, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -321,20 +300,20 @@
System.Threading.Tasks.Task<IPagedList<Rule>> | +Task<IPagedList<Rule>> | An IPagedList<T> containing the rules requested. |
Retrieves a rule by its ID.
public Task<Rule> GetAsync(string id, string fields = null, bool includeFields = true, CancellationToken cancellationToken = default(CancellationToken))
+ public Task<Rule> GetAsync(string id, string fields = null, bool includeFields = true, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -384,20 +363,20 @@
System.Threading.Tasks.Task<Rule> | +Task<Rule> | The Rule that was requested. |
Updates a rule.
public Task<Rule> UpdateAsync(string id, RuleUpdateRequest request, CancellationToken cancellationToken = default(CancellationToken))
+ public Task<Rule> UpdateAsync(string id, RuleUpdateRequest request, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -439,7 +418,7 @@ |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
System.Threading.Tasks.Task<Rule> | +Task<Rule> | The newly updated Rule. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
System.Uri | +Uri | baseUri | -System.Uri of the endpoint to use in making API calls. + | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
System.Collections.Generic.IDictionary<System.String, System.String> | +IDictionary<System.String, System.String> | defaultHeaders | Dictionary containing default headers included with every request this client makes. |
@@ -175,13 +154,13 @@
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -217,20 +196,20 @@
System.Threading.Tasks.Task<RulesConfig> | +Task<RulesConfig> | The newly created Rule. |
Deletes a rules config variable.
public Task DeleteAsync(string key, CancellationToken cancellationToken = default(CancellationToken))
+ public Task DeleteAsync(string key, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -266,8 +245,8 @@ |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
System.Threading.Tasks.Task | -A System.Threading.Tasks.Task that represents the asynchronous delete operation. + | Task | +A |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
System.Uri | +Uri | baseUri | -System.Uri of the endpoint to use in making API calls. + | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
System.Collections.Generic.IDictionary<System.String, System.String> | +IDictionary<System.String, System.String> | defaultHeaders | Dictionary containing default headers included with every request this client makes. |
@@ -175,13 +154,13 @@
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -211,20 +190,20 @@
System.Threading.Tasks.Task<System.Int64> | +Task<System.Int64> | The number of users that have logged in during the last 30 days. |
Gets the daily stats for a particular period.
public Task<IList<DailyStatistics>> GetDailyStatsAsync(DateTime from, DateTime to, CancellationToken cancellationToken = default(CancellationToken))
+ public Task<IList<DailyStatistics>> GetDailyStatsAsync(DateTime from, DateTime to, CancellationToken cancellationToken = null)
System.DateTime | +DateTime | from | The first day of the period (inclusive). |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
System.DateTime | +DateTime | to | The last day of the period (inclusive). |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -266,7 +245,7 @@ |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
System.Threading.Tasks.Task<System.Collections.Generic.IList<DailyStatistics>> | +Task<IList<DailyStatistics>> | A list of DailyStatistics containing the statistics for each day in the period. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
System.Uri | +Uri | baseUri | -System.Uri of the endpoint to use in making API calls. + | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
System.Collections.Generic.IDictionary<System.String, System.String> | +IDictionary<System.String, System.String> | defaultHeaders | Dictionary containing default headers included with every request this client makes. |
@@ -175,13 +154,13 @@
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -225,20 +204,20 @@
System.Threading.Tasks.Task<TenantSettings> | +Task<TenantSettings> | A TenantSettings containing the settings for the tenant. |
Updates the settings for the tenant.
public Task<TenantSettings> UpdateAsync(TenantSettingsUpdateRequest request, CancellationToken cancellationToken = default(CancellationToken))
+ public Task<TenantSettings> UpdateAsync(TenantSettingsUpdateRequest request, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -274,7 +253,7 @@ ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
System.Threading.Tasks.Task<TenantSettings> | +Task<TenantSettings> | A TenantSettings containing the updated settings for the tenant. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
System.Uri | +Uri | baseUri | -System.Uri of the endpoint to use in making API calls. + | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
System.Collections.Generic.IDictionary<System.String, System.String> | +IDictionary<System.String, System.String> | defaultHeaders | Dictionary containing default headers included with every request this client makes. |
@@ -175,13 +154,13 @@
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -217,20 +196,20 @@
System.Threading.Tasks.Task<Ticket> | +Task<Ticket> | The newly created Ticket. |
Creates a password change ticket.
public Task<Ticket> CreatePasswordChangeTicketAsync(PasswordChangeTicketRequest request, CancellationToken cancellationToken = default(CancellationToken))
+ public Task<Ticket> CreatePasswordChangeTicketAsync(PasswordChangeTicketRequest request, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -266,7 +245,7 @@ ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
System.Threading.Tasks.Task<Ticket> | +Task<Ticket> | The newly created Ticket. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
System.Uri | +Uri | baseUri | -System.Uri of the endpoint to use in making API calls. + | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
System.Collections.Generic.IDictionary<System.String, System.String> | +IDictionary<System.String, System.String> | defaultHeaders | Dictionary containing default headers included with every request this client makes. |
@@ -175,13 +154,13 @@
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -217,20 +196,20 @@
System.Threading.Tasks.Task<UserBlocks> | +Task<UserBlocks> | The UserBlocks relating to the user requested. |
Get a user's blocks by user id.
public Task<UserBlocks> GetByUserIdAsync(string id, CancellationToken cancellationToken = default(CancellationToken))
+ public Task<UserBlocks> GetByUserIdAsync(string id, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -266,20 +245,20 @@
System.Threading.Tasks.Task<UserBlocks> | +Task<UserBlocks> | The UserBlocks relating to the user requested. |
Unblock a user by their identifier.
public Task UnblockByIdentifierAsync(string identifier, CancellationToken cancellationToken = default(CancellationToken))
+ public Task UnblockByIdentifierAsync(string identifier, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -315,20 +294,20 @@
System.Threading.Tasks.Task | -A System.Threading.Tasks.Task that represents the asynchronous unblock operation. + | Task | +A |
Unblock a user by their id.
public Task UnblockByUserIdAsync(string id, CancellationToken cancellationToken = default(CancellationToken))
+ public Task UnblockByUserIdAsync(string id, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -364,8 +343,8 @@ ||||||||||||||||||||||||||||||
System.Threading.Tasks.Task | -A System.Threading.Tasks.Task that represents the asynchronous unblock operation. + | Task | +A |
||||||||||||||||||||||||||||||
System.Uri | +Uri | baseUri | -System.Uri of the endpoint to use in making API calls. + | ||||||||||||||||||||||||||||||
System.Collections.Generic.IDictionary<System.String, System.String> | +IDictionary<System.String, System.String> | defaultHeaders | Dictionary containing default headers included with every request this client makes. |
@@ -175,13 +154,13 @@
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -223,20 +202,20 @@
System.Threading.Tasks.Task | -A System.Threading.Tasks.Task that represents the asynchronous assignment operation. + | Task | +A |
Assigns Roles to a user.
public Task AssignRolesAsync(string id, AssignRolesRequest request, CancellationToken cancellationToken = default(CancellationToken))
+ public Task AssignRolesAsync(string id, AssignRolesRequest request, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -278,20 +257,20 @@
System.Threading.Tasks.Task | -A System.Threading.Tasks.Task that represents the asynchronous assign operation. + | Task | +A |
Creates a new user.
public Task<User> CreateAsync(UserCreateRequest request, CancellationToken cancellationToken = default(CancellationToken))
+ public Task<User> CreateAsync(UserCreateRequest request, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -327,20 +306,20 @@
System.Threading.Tasks.Task<User> | +Task<User> | The newly created User. |
Creates an authentication method for a given user.
public Task<AuthenticationMethod> CreateAuthenticationMethodAsync(string userId, AuthenticationMethodCreateRequest request, CancellationToken cancellationToken = default(CancellationToken))
+ public Task<AuthenticationMethod> CreateAuthenticationMethodAsync(string userId, AuthenticationMethodCreateRequest request, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -382,13 +361,13 @@
System.Threading.Tasks.Task<AuthenticationMethod> | +Task<AuthenticationMethod> | The newly created AuthenticationMethod. |
Authentication methods created via this endpoint will be auto confirmed and should already have verification completed.
A System.Threading.Tasks.Task that represents the asynchronous delete operation.
+A
Deletes an authentication method by id,.
public Task DeleteAuthenticationMethodAsync(string userId, string authenticationMethodId, CancellationToken cancellationToken = default(CancellationToken))
+ public Task DeleteAuthenticationMethodAsync(string userId, string authenticationMethodId, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -483,20 +462,20 @@
System.Threading.Tasks.Task | -A System.Threading.Tasks.Task that represents the asynchronous delete operation. + | Task | +A |
Deletes all authentication methods for the given user.
public Task DeleteAuthenticationMethodsAsync(string userId, CancellationToken cancellationToken = default(CancellationToken))
+ public Task DeleteAuthenticationMethodsAsync(string userId, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -532,20 +511,20 @@
System.Threading.Tasks.Task | -A System.Threading.Tasks.Task that represents the asynchronous delete operation. + | Task | +A |
Deletes a user's multifactor provider.
public Task DeleteMultifactorProviderAsync(string id, string provider, CancellationToken cancellationToken = default(CancellationToken))
+ public Task DeleteMultifactorProviderAsync(string id, string provider, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -587,20 +566,20 @@
System.Threading.Tasks.Task | -A System.Threading.Tasks.Task that represents the asynchronous delete operation. + | Task | +A |
Generate new Guardian recovery code.
public Task<GenerateRecoveryCodeResponse> GenerateRecoveryCodeAsync(string id, CancellationToken cancellationToken = default(CancellationToken))
+ public Task<GenerateRecoveryCodeResponse> GenerateRecoveryCodeAsync(string id, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -636,20 +615,20 @@
System.Threading.Tasks.Task<GenerateRecoveryCodeResponse> | +Task<GenerateRecoveryCodeResponse> | A Task representing the operation and potential return value. |
Lists or search for users based on criteria.
public Task<IPagedList<User>> GetAllAsync(GetUsersRequest request, PaginationInfo pagination = null, CancellationToken cancellationToken = default(CancellationToken))
+ public Task<IPagedList<User>> GetAllAsync(GetUsersRequest request, PaginationInfo pagination = null, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -691,20 +670,20 @@
System.Threading.Tasks.Task<IPagedList<User>> | +Task<IPagedList<User>> | An IPagedList<T> containing the list of users. |
Lists organizations for a user.
public Task<IPagedList<Organization>> GetAllOrganizationsAsync(string userId, PaginationInfo pagination, CancellationToken cancellationToken = default(CancellationToken))
+ public Task<IPagedList<Organization>> GetAllOrganizationsAsync(string userId, PaginationInfo pagination, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -746,20 +725,20 @@
System.Threading.Tasks.Task<IPagedList<Organization>> | +Task<IPagedList<Organization>> | An IPagedList<T> containing the list of organizations. |
Gets a user.
public Task<User> GetAsync(string id, string fields = null, bool includeFields = true, CancellationToken cancellationToken = default(CancellationToken))
+ public Task<User> GetAsync(string id, string fields = null, bool includeFields = true, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -809,20 +788,20 @@
System.Threading.Tasks.Task<User> | +Task<User> | The User that was requested. |
Gets an authentication method for a given user.
public Task<AuthenticationMethod> GetAuthenticationMethodAsync(string userId, string authenticationMethodId, CancellationToken cancellationToken = default(CancellationToken))
+ public Task<AuthenticationMethod> GetAuthenticationMethodAsync(string userId, string authenticationMethodId, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -864,20 +843,20 @@
System.Threading.Tasks.Task<AuthenticationMethod> | +Task<AuthenticationMethod> | The AuthenticationMethod that was requested. |
Gets a list of authentication methods.
public Task<IPagedList<AuthenticationMethod>> GetAuthenticationMethodsAsync(string userId, PaginationInfo pagination = null, CancellationToken cancellationToken = default(CancellationToken))
+ public Task<IPagedList<AuthenticationMethod>> GetAuthenticationMethodsAsync(string userId, PaginationInfo pagination = null, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -919,20 +898,20 @@
System.Threading.Tasks.Task<IPagedList<AuthenticationMethod>> | +Task<IPagedList<AuthenticationMethod>> | An IPagedList<T> containing the list of authentication methods. |
Get a list of Guardian enrollments.
public Task<IList<EnrollmentsResponse>> GetEnrollmentsAsync(string id, CancellationToken cancellationToken = default(CancellationToken))
+ public Task<IList<EnrollmentsResponse>> GetEnrollmentsAsync(string id, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -968,20 +947,20 @@
System.Threading.Tasks.Task<System.Collections.Generic.IList<EnrollmentsResponse>> | +Task<IList<EnrollmentsResponse>> | A Task representing the operation and potential return value. |
Retrieve every log event for a specific user.
public Task<IPagedList<LogEntry>> GetLogsAsync(GetUserLogsRequest request, PaginationInfo pagination = null, CancellationToken cancellationToken = default(CancellationToken))
+ public Task<IPagedList<LogEntry>> GetLogsAsync(GetUserLogsRequest request, PaginationInfo pagination = null, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -1023,20 +1002,20 @@
System.Threading.Tasks.Task<IPagedList<LogEntry>> | +Task<IPagedList<LogEntry>> | An IPagedList<T> containing the log entries for the user. |
Get the permissions assigned to the user.
public Task<IPagedList<UserPermission>> GetPermissionsAsync(string id, PaginationInfo pagination = null, CancellationToken cancellationToken = default(CancellationToken))
+ public Task<IPagedList<UserPermission>> GetPermissionsAsync(string id, PaginationInfo pagination = null, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -1078,20 +1057,20 @@
System.Threading.Tasks.Task<IPagedList<UserPermission>> | +Task<IPagedList<UserPermission>> | An IPagedList<T> containing the assigned permissions for this user. |
Retrieve assigned roles for a specific user.
public Task<IPagedList<Role>> GetRolesAsync(string userId, PaginationInfo pagination = null, CancellationToken cancellationToken = default(CancellationToken))
+ public Task<IPagedList<Role>> GetRolesAsync(string userId, PaginationInfo pagination = null, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -1133,20 +1112,20 @@
System.Threading.Tasks.Task<IPagedList<Role>> | +Task<IPagedList<Role>> | An IPagedList<T> containing the roles for the user. |
Gets all users by email address.
public Task<IList<User>> GetUsersByEmailAsync(string email, string fields = null, bool? includeFields = null, CancellationToken cancellationToken = default(CancellationToken))
+ public Task<IList<User>> GetUsersByEmailAsync(string email, string fields = null, bool? includeFields = null, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -1194,20 +1173,20 @@
System.Threading.Tasks.Task<System.Collections.Generic.IList<User>> | -A System.Collections.Generic.IList<T> containing all users for this email address. + | Task<IList<User>> | +A |
Invalidate all remembered browsers for MFA.
public Task InvalidateRememberBrowserAsync(string id, CancellationToken cancellationToken = default(CancellationToken))
+ public Task InvalidateRememberBrowserAsync(string id, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -1243,20 +1222,20 @@
System.Threading.Tasks.Task | +Task | A Task representing the operation and potential return value. |
Links a secondary account to a primary account.
public Task<IList<AccountLinkResponse>> LinkAccountAsync(string id, UserAccountLinkRequest request, CancellationToken cancellationToken = default(CancellationToken))
+ public Task<IList<AccountLinkResponse>> LinkAccountAsync(string id, UserAccountLinkRequest request, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -1298,20 +1277,20 @@
System.Threading.Tasks.Task<System.Collections.Generic.IList<AccountLinkResponse>> | -A System.Collections.Generic.IList<T> containing details about this account link. + | Task<IList<AccountLinkResponse>> | +A |
Links a secondary account to a primary account.
public Task<IList<AccountLinkResponse>> LinkAccountAsync(string id, string primaryJwtToken, string secondaryJwtToken, CancellationToken cancellationToken = default(CancellationToken))
+ public Task<IList<AccountLinkResponse>> LinkAccountAsync(string id, string primaryJwtToken, string secondaryJwtToken, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -1359,20 +1338,20 @@
System.Threading.Tasks.Task<System.Collections.Generic.IList<AccountLinkResponse>> | -A System.Collections.Generic.IList<T> containing details about this account link. + | Task<IList<AccountLinkResponse>> | +A |
Removes permissions assigned to a user.
public Task RemovePermissionsAsync(string id, AssignPermissionsRequest request, CancellationToken cancellationToken = default(CancellationToken))
+ public Task RemovePermissionsAsync(string id, AssignPermissionsRequest request, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -1414,20 +1393,20 @@
System.Threading.Tasks.Task | -A System.Threading.Tasks.Task that represents the asynchronous remove operation. + | Task | +A |
Removes Roles from a user.
public Task RemoveRolesAsync(string id, AssignRolesRequest request, CancellationToken cancellationToken = default(CancellationToken))
+ public Task RemoveRolesAsync(string id, AssignRolesRequest request, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -1469,20 +1448,20 @@
System.Threading.Tasks.Task | -A System.Threading.Tasks.Task that represents the asynchronous remove operation. + | Task | +A |
Unlinks user accounts
public Task<IList<AccountLinkResponse>> UnlinkAccountAsync(string primaryUserId, string provider, string secondaryUserId, CancellationToken cancellationToken = default(CancellationToken))
+ public Task<IList<AccountLinkResponse>> UnlinkAccountAsync(string primaryUserId, string provider, string secondaryUserId, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -1530,20 +1509,20 @@
System.Threading.Tasks.Task<System.Collections.Generic.IList<AccountLinkResponse>> | -A System.Collections.Generic.IList<T> containing details about this account link. + | Task<IList<AccountLinkResponse>> | +A |
Updates a user.
public Task<User> UpdateAsync(string id, UserUpdateRequest request, CancellationToken cancellationToken = default(CancellationToken))
+ public Task<User> UpdateAsync(string id, UserUpdateRequest request, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -1585,20 +1564,20 @@
System.Threading.Tasks.Task<User> | +Task<User> | The newly updated User. |
Update an authentication methods.
public Task<AuthenticationMethod> UpdateAuthenticationMethodAsync(string userId, string authenticationMethodId, AuthenticationMethodUpdateRequest request, CancellationToken cancellationToken = default(CancellationToken))
+ public Task<AuthenticationMethod> UpdateAuthenticationMethodAsync(string userId, string authenticationMethodId, AuthenticationMethodUpdateRequest request, CancellationToken cancellationToken = null)
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -1646,20 +1625,20 @@
System.Threading.Tasks.Task<AuthenticationMethod> | +Task<AuthenticationMethod> | The updated AuthenticationMethod. |
Updates all authentication methods by replacing them with the given ones.
public Task<IList<AuthenticationMethod>> UpdateAuthenticationMethodsAsync(string userId, IList<AuthenticationMethodsUpdateRequest> request, CancellationToken cancellationToken = default(CancellationToken))
+ public Task<IList<AuthenticationMethod>> UpdateAuthenticationMethodsAsync(string userId, IList<AuthenticationMethodsUpdateRequest> request, CancellationToken cancellationToken = null)
System.Collections.Generic.IList<AuthenticationMethodsUpdateRequest> | +IList<AuthenticationMethodsUpdateRequest> | request | The AuthenticationMethodsUpdateRequest containing the properties of the authentication methods to update. |
|
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -1701,7 +1680,7 @@ |
System.Threading.Tasks.Task<System.Collections.Generic.IList<AuthenticationMethod>> | +Task<IList<AuthenticationMethod>> | The updated list of AuthenticationMethod. |
||
System.Net.Http.HttpClient | +HttpClient | httpClient | -Optional System.Net.Http.HttpClient to use. If not specified one will + | Optional |
Initializes a new instance of the HttpClientManagementConnection class.
System.Net.Http.HttpMessageHandler to use with the managed -System.Net.Http.HttpClient that will be created and used for all requests made +
Disposes of any owned disposable resources such as the underlying System.Net.Http.HttpClient if owned.
+Disposes of any owned disposable resources such as the underlying
Disposes of any owned disposable resources such as the underlying System.Net.Http.HttpClient if owned.
+Disposes of any owned disposable resources such as the underlying
Perform a HTTP GET operation against a given System.Uri and return the materialized response body as T
.
Perform a HTTP GET operation against a given T
.
public async Task<T> GetAsync<T>(Uri uri, IDictionary<string, string> headers, JsonConverter[] converters = null, CancellationToken cancellationToken = default(CancellationToken))
+ public async Task<T> GetAsync<T>(Uri uri, IDictionary<string, string> headers, JsonConverter[] converters = null, CancellationToken cancellationToken = null)
System.Uri | +Uri | uri | -System.Uri to perform the GET request against. + | |
System.Collections.Generic.IDictionary<System.String, System.String> | +IDictionary<System.String, System.String> | headers | Dictionary containing additional headers that may override the defaults. |
@@ -263,7 +239,7 @@ |
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -280,8 +256,8 @@ |
System.Threading.Tasks.Task<T> | -System.Threading.Tasks.Task representing the async operation containing response body as | Task<T> | +
|
Perform a HTTP operation against a given System.Uri and return any materialized response body as T
.
Perform a HTTP operation against a given T
.
public async Task<T> SendAsync<T>(HttpMethod method, Uri uri, object body, IDictionary<string, string> headers, IList<FileUploadParameter> files = null, JsonConverter[] converters = null, CancellationToken cancellationToken = default(CancellationToken))
+ public async Task<T> SendAsync<T>(HttpMethod method, Uri uri, object body, IDictionary<string, string> headers, IList<FileUploadParameter> files = null, JsonConverter[] converters = null, CancellationToken cancellationToken = null)
System.Net.Http.HttpMethod | +HttpMethod | method | -System.Net.Http.HttpMethod to use in performing the request. + | |
System.Uri | +Uri | uri | -System.Uri to perform the request against. + | |
System.Object | body | Payload to send to the server. -If specified as a Dictionary<string, string> then System.Net.Http.FormUrlEncodedContent is expected, -otherwise System.Net.Http.StringContent containing the JSON representation of the object is expected. +If specified as a Dictionary<string, string> then |
||
System.Collections.Generic.IDictionary<System.String, System.String> | +IDictionary<System.String, System.String> | headers | Dictionary containing additional headers that may override the defaults. |
|
System.Collections.Generic.IList<FileUploadParameter> | +IList<FileUploadParameter> | files | -Optional System.Collections.Generic.IList<T> containing file contents to upload as a System.Net.Http.MultipartFormDataContent post. + | Optional |
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -377,8 +353,8 @@ |
System.Threading.Tasks.Task<T> | -System.Threading.Tasks.Task representing the async operation containing response body as | Task<T> | +
|
files
can only be specified if body
is a Dictionary%lt;string, object%gt;"/>.
public class HttpClientManagementConnectionOptions
+ public class HttpClientManagementConnectionOptions : object
public interface IManagementApiClient : IDisposable
+ public interface IManagementApiClient
public interface IManagementConnection
A default implementation of this using System.Net.Http.HttpClient is included as +
A default implementation of this using
Perform a HTTP GET operation against a given System.Uri and return the materialized response body as T
.
Perform a HTTP GET operation against a given T
.
Task<T> GetAsync<T>(Uri uri, IDictionary<string, string> headers, JsonConverter[] converters = null, CancellationToken cancellationToken = default(CancellationToken))
+ Task<T> GetAsync<T>(Uri uri, IDictionary<string, string> headers, JsonConverter[] converters = null, CancellationToken cancellationToken = null)
System.Uri | +Uri | uri | -System.Uri to perform the GET request against. + | |
System.Collections.Generic.IDictionary<System.String, System.String> | +IDictionary<System.String, System.String> | headers | Dictionary containing additional headers that may override the defaults. |
@@ -129,7 +129,7 @@ |
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -146,8 +146,8 @@ |
System.Threading.Tasks.Task<T> | -System.Threading.Tasks.Task representing the async operation containing response body as | Task<T> | +
|
Perform a HTTP operation against a given System.Uri and return any materialized response body as T
.
Perform a HTTP operation against a given T
.
Task<T> SendAsync<T>(HttpMethod method, Uri uri, object body, IDictionary<string, string> headers, IList<FileUploadParameter> files = null, JsonConverter[] converters = null, CancellationToken cancellationToken = default(CancellationToken))
+ Task<T> SendAsync<T>(HttpMethod method, Uri uri, object body, IDictionary<string, string> headers, IList<FileUploadParameter> files = null, JsonConverter[] converters = null, CancellationToken cancellationToken = null)
System.Net.Http.HttpMethod | +HttpMethod | method | -System.Net.Http.HttpMethod to use in performing the request. + | |
System.Uri | +Uri | uri | -System.Uri to perform the request against. + | |
System.Object | body | Payload to send to the server. -If specified as a Dictionary<string, string> then System.Net.Http.FormUrlEncodedContent is expected, -otherwise System.Net.Http.StringContent containing the JSON representation of the object is expected. +If specified as a Dictionary<string, string> then |
||
System.Collections.Generic.IDictionary<System.String, System.String> | +IDictionary<System.String, System.String> | headers | Dictionary containing additional headers that may override the defaults. |
|
System.Collections.Generic.IList<FileUploadParameter> | +IList<FileUploadParameter> | files | -Optional System.Collections.Generic.IList<T> containing file contents to upload as a System.Net.Http.MultipartFormDataContent post. + | Optional |
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -243,8 +243,8 @@ |
System.Threading.Tasks.Task<T> | -System.Threading.Tasks.Task representing the async operation containing response body as | Task<T> | +
|
files
can only be specified if body
is a Dictionary%lt;string, object%gt;"/>.
public class ManagementApiClient : IManagementApiClient, IDisposable
+ public class ManagementApiClient : object, IManagementApiClient
Initializes a new instance of the ManagementApiClient class.
System.Uri of the tenant to manage.
+public class AccountLinkResponse
+ public class AccountLinkResponse : object
public class AccountLinkResponseProfileData
+ public class AccountLinkResponseProfileData : object
public abstract class ActionBase
+ public abstract class ActionBase : object
public class ActionDependency
+ public class ActionDependency : object
public class ActionError
+ public class ActionError : object
public class ActionExecution
+ public class ActionExecution : object
public class ActionExecutionResult
+ public class ActionExecutionResult : object
public class ActionSecret
+ public class ActionSecret : object
public class ActionSupportedTrigger
+ public class ActionSupportedTrigger : object
public class ActionVersion
+ public class ActionVersion : object
public class DeleteActionRequest
+ public class DeleteActionRequest : object
public class GetActionsRequest
+ public class GetActionsRequest : object
public class Trigger
+ public class Trigger : object
public class TriggerBinding
+ public class TriggerBinding : object
public class BindingRef
+ public class BindingRef : object
public class UpdateTriggerBindingEntry
+ public class UpdateTriggerBindingEntry : object
public class UpdateTriggerBindingsRequest
+ public class UpdateTriggerBindingsRequest : object
public class Addons
+ public class Addons : object
public class AssignPermissionsRequest
+ public class AssignPermissionsRequest : object
public class AssignRolesRequest
+ public class AssignRolesRequest : object
public class AssignUsersRequest
+ public class AssignUsersRequest : object
public class AssignedUser
+ public class AssignedUser : object
public class BreachedPasswordDetection
+ public class BreachedPasswordDetection : object
public class StageEntry
+ public class StageEntry : object
public class BreachedPasswordDetectionStage
+ public class BreachedPasswordDetectionStage : object
public class BruteForceProtection
+ public class BruteForceProtection : object
public class StageEntry
+ public class StageEntry : object
public class Stage
+ public class Stage : object
public class SuspiciousIpThrottling
+ public class SuspiciousIpThrottling : object
public class BlacklistedTokenBase
+ public class BlacklistedTokenBase : object
public class BrandingBase
+ public class BrandingBase : object
public class BrandingColors
+ public class BrandingColors : object
public class BrandingFont
+ public class BrandingFont : object
public enum ClientApplicationType
+ public enum ClientApplicationType : int
public class ClientAuthenticationMethods
+ public class ClientAuthenticationMethods : object
public abstract class ClientBase
+ public abstract class ClientBase : object
public class ClientCredentialCreateRequest
+ public class ClientCredentialCreateRequest : object
public class ClientCredentialUpdateRequest
+ public class ClientCredentialUpdateRequest : object
public class ClientGrantBase
+ public class ClientGrantBase : object
public class ClientGrantUpdateRequest
+ public class ClientGrantUpdateRequest : object
public class ClientResourceServerAssociation
+ public class ClientResourceServerAssociation : object
public abstract class ConnectionBase
+ public abstract class ConnectionBase : object
public class CreateClientAuthenticationMethods
+ public class CreateClientAuthenticationMethods : object
public class CreateGuardianEnrollmentTicketRequest
+ public class CreateGuardianEnrollmentTicketRequest : object
public class CreateGuardianEnrollmentTicketResponse
+ public class CreateGuardianEnrollmentTicketResponse : object
public class CreatePrivateKeyJwt
+ public class CreatePrivateKeyJwt : object
public class Credential
+ public class Credential : object
public class CredentialId
+ public class CredentialId : object
Only contains the credential's id.
diff --git a/docs/api/Auth0.ManagementApi.Models.CustomDomain.html b/docs/api/Auth0.ManagementApi.Models.CustomDomain.html index 3eab6deea..9d31dea4b 100644 --- a/docs/api/Auth0.ManagementApi.Models.CustomDomain.html +++ b/docs/api/Auth0.ManagementApi.Models.CustomDomain.html @@ -105,27 +105,6 @@public abstract class CustomDomainBase
+ public abstract class CustomDomainBase : object
public enum CustomDomainCertificateProvisioning
+ public enum CustomDomainCertificateProvisioning : int
public class CustomDomainCreateRequest
+ public class CustomDomainCreateRequest : object
public enum CustomDomainStatus
+ public enum CustomDomainStatus : int
public class CustomDomainVerification
+ public class CustomDomainVerification : object
public class CustomDomainVerificationMethod
+ public class CustomDomainVerificationMethod : object
public class DailyStatistics
+ public class DailyStatistics : object
public abstract class DeviceCredentialBase
+ public abstract class DeviceCredentialBase : object
public abstract class EmailProviderBase
+ public abstract class EmailProviderBase : object
public class EmailProviderCredentials
+ public class EmailProviderCredentials : object
public abstract class EmailTemplateBase
+ public abstract class EmailTemplateBase : object
public enum EmailTemplateName
+ public enum EmailTemplateName : int
public enum EmailTemplateSyntax
+ public enum EmailTemplateSyntax : int
public class EmailVerificationIdentity
+ public class EmailVerificationIdentity : object
public class EmailVerificationTicketRequest
+ public class EmailVerificationTicketRequest : object
public class EncryptionKey
+ public class EncryptionKey : object
public enum EnrollmentAuthMethod
+ public enum EnrollmentAuthMethod : int
public enum EnrollmentStatus
+ public enum EnrollmentStatus : int
public class EnrollmentsResponse
+ public class EnrollmentsResponse : object
public class GenerateRecoveryCodeResponse
+ public class GenerateRecoveryCodeResponse : object
public class GetClientGrantsRequest
+ public class GetClientGrantsRequest : object
public class GetClientsRequest
+ public class GetClientsRequest : object
public class GetConnectionsRequest
+ public class GetConnectionsRequest : object
public class GetDeviceCredentialsRequest
+ public class GetDeviceCredentialsRequest : object
public class GetHooksRequest
+ public class GetHooksRequest : object
public class GetLogsRequest
+ public class GetLogsRequest : object
public class GetRolesRequest
+ public class GetRolesRequest : object
public class GetRulesRequest
+ public class GetRulesRequest : object
public class GetUserLogsRequest
+ public class GetUserLogsRequest : object
public class GetUsersRequest
+ public class GetUsersRequest : object
public class GetGrantsRequest
+ public class GetGrantsRequest : object
public class Grant
+ public class Grant : object
public class GuardianEnrollment
+ public class GuardianEnrollment : object
public enum GuardianEnrollmentStatus
+ public enum GuardianEnrollmentStatus : int
public class GuardianFactor
+ public class GuardianFactor : object
public enum GuardianFactorName
+ public enum GuardianFactorName : int
public class GuardianPhoneMessageTypes
+ public class GuardianPhoneMessageTypes : object
public class GuardianSmsEnrollmentTemplates
+ public class GuardianSmsEnrollmentTemplates : object
public class GuardianSnsConfigurationBase
+ public class GuardianSnsConfigurationBase : object
public class GuardianTwilioConfigurationBase
+ public class GuardianTwilioConfigurationBase : object
public abstract class HookBase
+ public abstract class HookBase : object
public class Identity
+ public class Identity : object
A single User may be linked to multiple 3rd party accounts. This object defines the details of one @@ -262,7 +238,7 @@
public class Job
+ public class Job : object
public class JobSummary
+ public class JobSummary : object
public class JwtConfiguration
+ public class JwtConfiguration : object
public class Key
+ public class Key : object
public class RevokeSigningKeyResponse
+ public class RevokeSigningKeyResponse : object
public class RotateSigningKeyResponse
+ public class RotateSigningKeyResponse : object
public class LogEntry
+ public class LogEntry : object
public class LogStreamBase
+ public class LogStreamBase : object
public enum LogStreamStatus
+ public enum LogStreamStatus : int
public enum LogStreamType
+ public enum LogStreamType : int
public class LogStreamUpdateRequest
+ public class LogStreamUpdateRequest : object
public enum LogStreamUpdateStatus
+ public enum LogStreamUpdateStatus : int
public class MobileAndroid
+ public class MobileAndroid : object
public class MobileIos
+ public class MobileIos : object
public class Mobile
+ public class Mobile : object
public class OrganizationAddMemberRolesRequest
+ public class OrganizationAddMemberRolesRequest : object
public class OrganizationAddMembersRequest
+ public class OrganizationAddMembersRequest : object
public class OrganizationBase
+ public class OrganizationBase : object
public class OrganizationBranding
+ public class OrganizationBranding : object
public class OrganizationConnection
+ public class OrganizationConnection : object
public class OrganizationConnectionCreateRequest
+ public class OrganizationConnectionCreateRequest : object
public class OrganizationConnectionInfo
+ public class OrganizationConnectionInfo : object
public class OrganizationConnectionUpdateRequest
+ public class OrganizationConnectionUpdateRequest : object
public class OrganizationCreateInvitationRequest
+ public class OrganizationCreateInvitationRequest : object
public class OrganizationDeleteMemberRolesRequest
+ public class OrganizationDeleteMemberRolesRequest : object
public class OrganizationDeleteMembersRequest
+ public class OrganizationDeleteMembersRequest : object
public class OrganizationGetInvitationRequest
+ public class OrganizationGetInvitationRequest : object
public class OrganizationInvitation
+ public class OrganizationInvitation : object
public class OrganizationInvitationInvitee
+ public class OrganizationInvitationInvitee : object
public class OrganizationInvitationInviter
+ public class OrganizationInvitationInviter : object
public class OrganizationMember
+ public class OrganizationMember : object
public enum OrganizationRequireBehavior
+ public enum OrganizationRequireBehavior : int
Do not prompt for an organization
+Prompt for an organization after login
Prompt for an organization
+Prompt for an organization before login
public class OrganizationUpdateRequest
+ public class OrganizationUpdateRequest : object
The name of this organization
+public string Name { get; set; }
+ Type | +Description | +
---|---|
System.String | ++ |
public enum OrganizationUsage
+ public enum OrganizationUsage : int
public class PasswordChangeTicketRequest
+ public class PasswordChangeTicketRequest : object
public class PermissionIdentity
+ public class PermissionIdentity : object
public class PermissionSource
+ public class PermissionSource : object
public enum PermissionSourceType
+ public enum PermissionSourceType : int
public class PrivateKeyJwt
+ public class PrivateKeyJwt : object
public class Prompt
+ public class Prompt : object
public class RefreshToken
+ public class RefreshToken : object
public enum RefreshTokenExpirationType
+ public enum RefreshTokenExpirationType : int
public enum RefreshTokenRotationType
+ public enum RefreshTokenRotationType : int
public class ResourceServerBase
+ public class ResourceServerBase : object
public class ResourceServerScope
+ public class ResourceServerScope : object
public abstract class RoleBase
+ public abstract class RoleBase : object
public abstract class RuleBase
+ public abstract class RuleBase : object
public class LoginRequest
+ public class LoginRequest : object
public class LoginRequestGeography
+ public class LoginRequestGeography : object
public class LoginRequestQuery
+ public class LoginRequestQuery : object
public class RulesContext
+ public class RulesContext : object
public class RulesContextSsoConfiguration
+ public class RulesContextSsoConfiguration : object
public class RulesContextStats
+ public class RulesContextStats : object
public class RulesRequest
+ public class RulesRequest : object
//Add this to your Node.js Rule. Be sure to replace the secret token with a different value. diff --git a/docs/api/Auth0.ManagementApi.Models.RulesConfig.html b/docs/api/Auth0.ManagementApi.Models.RulesConfig.html index ab8525b84..e3007bf19 100644 --- a/docs/api/Auth0.ManagementApi.Models.RulesConfig.html +++ b/docs/api/Auth0.ManagementApi.Models.RulesConfig.html @@ -83,35 +83,11 @@
public class RulesConfig
+ public class RulesConfig : object
public class ScopeEntry
+ public class ScopeEntry : object
public class Scopes
+ public class Scopes : object
public class SessionCookie
+ public class SessionCookie : object
public enum SigningAlgorithm
+ public enum SigningAlgorithm : int
public class SigningKey
+ public class SigningKey : object
public class TenantChangePassword
+ public class TenantChangePassword : object
public class TenantDeviceFlow
+ public class TenantDeviceFlow : object
public enum TenantDeviceFlowCharset
+ public enum TenantDeviceFlowCharset : int
public class TenantErrorPage
+ public class TenantErrorPage : object
public class TenantFlags
+ public class TenantFlags : object
public class TenantGuardianMfaPage
+ public class TenantGuardianMfaPage : object
public class TenantSettingsBase
+ public class TenantSettingsBase : object
public class Ticket
+ public class Ticket : object
public enum TokenDialect
+ public enum TokenDialect : int
public enum TokenEndpointAuthMethod
+ public enum TokenEndpointAuthMethod : int
public class UniversalLoginTemplate
+ public class UniversalLoginTemplate : object
public class UniversalLoginTemplateUpdateRequest
+ public class UniversalLoginTemplateUpdateRequest : object
public class UpdateGuardianFactorBase
+ public class UpdateGuardianFactorBase : object
public class UserAccountJwtLinkRequest
+ public class UserAccountJwtLinkRequest : object
public class UserAccountLinkRequest
+ public class UserAccountLinkRequest : object
public abstract class UserBase
+ public abstract class UserBase : object
public class UserBlock
+ public class UserBlock : object
public class UserBlocks
+ public class UserBlocks : object
public class AuthenticationMethodBase
+ public class AuthenticationMethodBase : object
public class AuthenticationMethodCreateRequest
+ public class AuthenticationMethodCreateRequest : object
public class AuthenticationMethodUpdateRequest
+ public class AuthenticationMethodUpdateRequest : object
public class AuthenticationMethodsUpdateRequest
+ public class AuthenticationMethodsUpdateRequest : object
public class UsersExportsJobField
+ public class UsersExportsJobField : object
public enum UsersExportsJobFormat
+ public enum UsersExportsJobFormat : int
public class UsersExportsJobRequest
+ public class UsersExportsJobRequest : object
public class VerifyEmailJobRequest
+ public class VerifyEmailJobRequest : object
public class CheckpointPagedList<T> : List<T>, IReadOnlyList<T>, IReadOnlyCollection<T>, IList, ICollection, ICheckpointPagedList<T>, IList<T>, ICollection<T>, IEnumerable<T>, IEnumerable
+ public class CheckpointPagedList<T> : List<T>, ICheckpointPagedList<T>
System.Collections.Generic.IEnumerable<T> | +IEnumerable<T> | collection | The collection whose elements are copied to the new list. |
@@ -389,7 +162,7 @@
Initializes a new instance of the PagedList<T> class that contains elements copied from the specified collection.
The collection whose elements are copied to the new list.
public class CheckpointPaginationInfo
+ public class CheckpointPaginationInfo : object
public class CheckpointPagingInformation
+ public class CheckpointPagingInformation : object
public interface ICheckpointPagedList<T> : IList<T>, ICollection<T>, IEnumerable<T>, IEnumerable
+ public interface ICheckpointPagedList<T>
System.Collections.Generic.IEnumerable<T> | +IEnumerable<T> | collection | The collection whose elements are copied to the new list. |
@@ -389,7 +162,7 @@
Initializes a new instance of the PagedList<T> class that contains elements copied from the specified collection.
The collection whose elements are copied to the new list.
public class PaginationInfo
+ public class PaginationInfo : object
public class PagingInformation
+ public class PagingInformation : object
Implements IManagementConnection using System.Net.Http.HttpClient.
+Implements IManagementConnection using