en-US/about_AnyChain.help.txt
|
about_AnyChain SHORT DESCRIPTION This module can be used to use the Forte AnyChain API from a PowerShell command line or script. LONG DESCRIPTION This module provides access to the Forte AnyChain API. * Reads and writes profile settings for specific Forte environments, relieving the user of the need to specify the configuration values with each endpoint request. * Manages the acquisition and use of tokens for accessing the API. NOTE: This module does not monitor for expired tokens; it leaves token management to the user. * Constructs HTTP REST requests by converting strings or hashtables into the HTML body, query, and path parameters. * Provides parameter auto-completion assistance by displaying available endpoints, verbs, and corresponding body structures, such as showing valid endpoints after the -Endpoint parameter by pressing the TAB key. (Specific key sequences vary based on environment.) * Use the OpenAPI Specification file (JSON or YAML format) to provide context-sensitive parameter prompts by displaying available endpoints, verbs, and corresponding body structures, such as showing valid endpoints after the -Endpoint parameter by pressing the TAB key. (Specific key sequences vary based on environment.) * Allow browsing the AnyChain endpoints and data structures of the AnyChain API specification. Before the AnyChain API can be accessed, a profile must be selected for use. If a profiles has not yet been created, create it with the New-AnyChainProfile cmdlet: PS> New-AnyChainProfile -Description '<description>' -ApplicationId <appid> -BaseUrl <baseuri> ` -AnyChainOpenAPISpecPath '<specpath>' -Use | Export-AnyChainProfile -Path '<profilepath>' If a profile has already been defined, load it using the Import-AnyChainProfile cmdlet: PS> Import-AnyChainProfile -Path <profile-path> -Use For detailed help on creating profiles, see: https://github.com/fortelabsinc/AnyChainPSModule/wiki/installing-the-AnyChain-Module#profiles. Once a profile has been loaded, AnyChain endpoints can be accessed. For example: PS> Invoke-AnyChain -Endpoint users -Method get -NewToken -ExpandProperty users The AnyChain module provides a number of cmdlets. * Export-AnyChainProfile * Get-AnyChainAccessTokenExpiration * Get-AnyChainAsyncNotification * Get-AnyChainEndpointDefinition * Get-AnyChainEndpoints * Get-AnyChainOpenApiSpecification * Get-AnyChainProfile * Import-AnyChainProfile * Invoke-AnyChain * New-AnyChainAccessToken * New-AnyChainProfile * Revoke-AnyChainAccessToken * Use-AnyChainProfile * Get-AnyChainDefinitionReference * Wait-AnyChainAsyncNotification For further details, see the help for specific cmdlets (e.g., Get-Help <cmdlet> [-ShowWindow]) and https://github.com/fortelabsinc/AnyChainPSModule/wiki/using-the-AnyChain-module#cmdlets. EXAMPLES For a detailed description and examples of how to use the AnyChain module, see: * https://github.com/fortelabsinc/AnyChainPSModule/wiki/using-the-AnyChain-module * https://github.com/fortelabsinc/AnyChainPSModule/wiki/examples NOTE This code is Copyright (c) 2023 Forte Labs, Inc. All rights reserved. SEE ALSO For details on the AnyChain module, see https://github.com/fortelabsinc/AnyChainPSModule#readme and https://github.com/fortelabsinc/AnyChainPSModule/wiki. For the full documentation of the Forte Platform, including details about the AnyChain API, see https://dev.forte.io/labs. |