Grist4NET
Search Results for

    Show / Hide Table of Contents

    Class ApikeyRequestBuilder

    Builds and executes requests for operations under \service-accounts{saId}\apikey

    Inheritance
    object
    BaseRequestBuilder
    ApikeyRequestBuilder
    Inherited Members
    BaseRequestBuilder.PathParameters
    BaseRequestBuilder.RequestAdapter
    BaseRequestBuilder.UrlTemplate
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: Grist4NET.Kiota.ServiceAccounts.Item.Apikey
    Assembly: Grist4NET.Kiota.dll
    Syntax
    public class ApikeyRequestBuilder : BaseRequestBuilder

    Constructors

    ApikeyRequestBuilder(Dictionary<string, object>, IRequestAdapter)

    Instantiates a new ApikeyRequestBuilder and sets the default values.

    Declaration
    public ApikeyRequestBuilder(Dictionary<string, object> pathParameters, IRequestAdapter requestAdapter)
    Parameters
    Type Name Description
    Dictionary<string, object> pathParameters

    Path parameters for the request

    IRequestAdapter requestAdapter

    The request adapter to use to execute the requests.

    ApikeyRequestBuilder(string, IRequestAdapter)

    Instantiates a new ApikeyRequestBuilder and sets the default values.

    Declaration
    public ApikeyRequestBuilder(string rawUrl, IRequestAdapter requestAdapter)
    Parameters
    Type Name Description
    string rawUrl

    The raw URL to use for the request builder.

    IRequestAdapter requestAdapter

    The request adapter to use to execute the requests.

    Methods

    DeleteAsync(Action<RequestConfiguration<DefaultQueryParameters>>, CancellationToken)

    Deletes the API key for a service account. The service account willno longer be able to authenticate until a new key is generated.

    Declaration
    public Task<Stream> DeleteAsync(Action<RequestConfiguration<DefaultQueryParameters>> requestConfiguration = null, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    Action<RequestConfiguration<DefaultQueryParameters>> requestConfiguration

    Configuration for the request such as headers, query parameters, and middleware options.

    CancellationToken cancellationToken

    Cancellation token to use when cancelling requests

    Returns
    Type Description
    Task<Stream>

    A Stream

    PostAsync(Action<RequestConfiguration<DefaultQueryParameters>>, CancellationToken)

    This renews an api key of a given service account.Useful especially to change the API key when it has been leaked.

    Declaration
    public Task<ServiceAccountResultWithApiKey> PostAsync(Action<RequestConfiguration<DefaultQueryParameters>> requestConfiguration = null, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    Action<RequestConfiguration<DefaultQueryParameters>> requestConfiguration

    Configuration for the request such as headers, query parameters, and middleware options.

    CancellationToken cancellationToken

    Cancellation token to use when cancelling requests

    Returns
    Type Description
    Task<ServiceAccountResultWithApiKey>

    A ServiceAccountResultWithApiKey

    ToDeleteRequestInformation(Action<RequestConfiguration<DefaultQueryParameters>>)

    Deletes the API key for a service account. The service account willno longer be able to authenticate until a new key is generated.

    Declaration
    public RequestInformation ToDeleteRequestInformation(Action<RequestConfiguration<DefaultQueryParameters>> requestConfiguration = null)
    Parameters
    Type Name Description
    Action<RequestConfiguration<DefaultQueryParameters>> requestConfiguration

    Configuration for the request such as headers, query parameters, and middleware options.

    Returns
    Type Description
    RequestInformation

    A Microsoft.Kiota.Abstractions.RequestInformation

    ToPostRequestInformation(Action<RequestConfiguration<DefaultQueryParameters>>)

    This renews an api key of a given service account.Useful especially to change the API key when it has been leaked.

    Declaration
    public RequestInformation ToPostRequestInformation(Action<RequestConfiguration<DefaultQueryParameters>> requestConfiguration = null)
    Parameters
    Type Name Description
    Action<RequestConfiguration<DefaultQueryParameters>> requestConfiguration

    Configuration for the request such as headers, query parameters, and middleware options.

    Returns
    Type Description
    RequestInformation

    A Microsoft.Kiota.Abstractions.RequestInformation

    WithUrl(string)

    Returns a request builder with the provided arbitrary URL. Using this method means any other path or query parameters are ignored.

    Declaration
    public ApikeyRequestBuilder WithUrl(string rawUrl)
    Parameters
    Type Name Description
    string rawUrl

    The raw URL to use for the request builder.

    Returns
    Type Description
    ApikeyRequestBuilder

    A ApikeyRequestBuilder

    In this article
    Back to top Generated by DocFX