AffixApi.Api.Api.ManagementApi

All URIs are relative to https://api.affixapi.com

Method	HTTP request	Description
CallClient	GET /2023-03-01/management/client	Client
Disconnect	POST /2023-03-01/management/disconnect	Disconnect token
Introspect	GET /2023-03-01/management/introspect	Inspect token
Token	POST /2023-03-01/management/token	Create token
Tokens	GET /2023-03-01/management/tokens	Tokens
UpdateClient	POST /2023-03-01/management/client	Update client

CallClient

ClientResponse CallClient ()

Client

View client attributes

Example

using System.Collections.Generic;
using System.Diagnostics;
using AffixApi.Api.Api;
using AffixApi.Api.Client;
using AffixApi.Api.Model;

namespace Example
{
    public class CallClientExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.affixapi.com";
            // Configure API key authorization: basic
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new ManagementApi(config);

            try
            {
                // Client
                ClientResponse result = apiInstance.CallClient();
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ManagementApi.CallClient: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

This endpoint does not need any parameter.

Return type

ClientResponse

Authorization

basic

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Success	-
400	Bad Request	-
401	Authentication Error	-
429	Rate Limited / Too Many Requests	* Retry-After - Retry your call after the specified amount of seconds
500	Server Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Disconnect

DisconnectResponse Disconnect ()

Disconnect token

Disconnect the token. A disconnected token will no longer return data. Data requests with a disconnected token will return a 403 Forbidden

Example

using System.Collections.Generic;
using System.Diagnostics;
using AffixApi.Api.Api;
using AffixApi.Api.Client;
using AffixApi.Api.Model;

namespace Example
{
    public class DisconnectExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.affixapi.com";
            // Configure API key authorization: access-token
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new ManagementApi(config);

            try
            {
                // Disconnect token
                DisconnectResponse result = apiInstance.Disconnect();
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ManagementApi.Disconnect: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

This endpoint does not need any parameter.

Return type

DisconnectResponse

Authorization

access-token

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Success	-
403	Forbidden	-
429	Rate Limited / Too Many Requests	* Retry-After - Retry your call after the specified amount of seconds
500	Server Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Introspect

IntrospectResponse Introspect ()

Inspect token

Retrieve data about the token, such as scopes, mode, provider, and if it is active

Example

using System.Collections.Generic;
using System.Diagnostics;
using AffixApi.Api.Api;
using AffixApi.Api.Client;
using AffixApi.Api.Model;

namespace Example
{
    public class IntrospectExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.affixapi.com";
            // Configure API key authorization: access-token
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new ManagementApi(config);

            try
            {
                // Inspect token
                IntrospectResponse result = apiInstance.Introspect();
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ManagementApi.Introspect: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

This endpoint does not need any parameter.

Return type

IntrospectResponse

Authorization

access-token

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Success	-
400	Bad Request	-
403	Forbidden	-
404	Not Found	-
429	Rate Limited / Too Many Requests	* Retry-After - Retry your call after the specified amount of seconds
500	Server Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Token

TokenResponse Token (TokenRequest tokenRequest)

Create token

Exchange an authorization_code for an access_token after receiving on from the redirect_uri you specifiy after a successful user connection

Example

using System.Collections.Generic;
using System.Diagnostics;
using AffixApi.Api.Api;
using AffixApi.Api.Client;
using AffixApi.Api.Model;

namespace Example
{
    public class TokenExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.affixapi.com";
            var apiInstance = new ManagementApi(config);
            var tokenRequest = new TokenRequest(); // TokenRequest | 

            try
            {
                // Create token
                TokenResponse result = apiInstance.Token(tokenRequest);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ManagementApi.Token: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
tokenRequest	TokenRequest

Return type

TokenResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
201	Success	-
400	Bad Request	-
404	Not Found	-
409	Not Found	-
429	Rate Limited / Too Many Requests	* Retry-After - Retry your call after the specified amount of seconds
500	Server Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Tokens

List<Object> Tokens ()

Tokens

View tokens and token status for respective client

Example

using System.Collections.Generic;
using System.Diagnostics;
using AffixApi.Api.Api;
using AffixApi.Api.Client;
using AffixApi.Api.Model;

namespace Example
{
    public class TokensExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.affixapi.com";
            // Configure API key authorization: basic
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new ManagementApi(config);

            try
            {
                // Tokens
                List<Object> result = apiInstance.Tokens();
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ManagementApi.Tokens: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

This endpoint does not need any parameter.

Return type

List

Authorization

basic

HTTP request headers

Content-Type: Not defined

Accept: application/json

HTTP response details

Status code Description Response headers

200 Success -

400 Bad Request -

404 Not Found -

409 Not Found -

429 Rate Limited / Too Many Requests * Retry-After - Retry your call after the specified amount of seconds

500 Server Error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateClient

ClientResponse UpdateClient (ClientRequest clientRequest)

Update client

Update attributes of the client. Update the name, client_secret, or webhook_uri of the client

Example

using System.Collections.Generic; using System.Diagnostics; using AffixApi.Api.Api; using AffixApi.Api.Client; using AffixApi.Api.Model; namespace Example { public class UpdateClientExample { public static void Main() { Configuration config = new Configuration(); config.BasePath = "https://api.affixapi.com"; // Configure API key authorization: basic config.AddApiKey("Authorization", "YOUR_API_KEY"); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // config.AddApiKeyPrefix("Authorization", "Bearer"); var apiInstance = new ManagementApi(config); var clientRequest = new ClientRequest(); // ClientRequest | try { // Update client ClientResponse result = apiInstance.UpdateClient(clientRequest); Debug.WriteLine(result); } catch (ApiException e) { Debug.Print("Exception when calling ManagementApi.UpdateClient: " + e.Message ); Debug.Print("Status Code: "+ e.ErrorCode); Debug.Print(e.StackTrace); } } } }

Parameters

Name Type Description Notes

clientRequest ClientRequest

Return type

ClientResponse

Authorization

basic

HTTP request headers

Content-Type: application/json

Accept: application/json

HTTP response details

Status code Description Response headers

200 Success -

400 Bad Request -

401 Authentication Error -

409 Not Found -

429 Rate Limited / Too Many Requests * Retry-After - Retry your call after the specified amount of seconds

500 Server Error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

ManagementApi.md

Latest commit

History

ManagementApi.md

File metadata and controls

AffixApi.Api.Api.ManagementApi

CallClient

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

Disconnect

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

Introspect

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

Token

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

Tokens

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

UpdateClient

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details