Skip to content

Commit

Permalink
doc site - update content for doc pages
Browse files Browse the repository at this point in the history
  • Loading branch information
wsmelton committed Feb 28, 2021
1 parent 8427365 commit 6f47e67
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 4 deletions.
2 changes: 1 addition & 1 deletion docs/collections/_docs/01-authentication.md
Original file line number Diff line number Diff line change
Expand Up @@ -201,7 +201,7 @@ Note that these methods are defined as `boolean`, so they will only return true

## IsValidToken

This method utilizes a hidden properties on the `TssObject` called `TimeOfDeath` (`datetime` type). This property's value is calculated based on the `expires_in` value returned by the OAuth2 endpoint and based on the local time of the machine calling the function.
This method utilizes a hidden properties on the `TssObject` called `TimeOfDeath` (`datetime` type). This property's value is calculated based on the `expires_in` value returned by the OAuth2 endpoint and based on the machine's local time calling the function.

More details: [TssSession source code](https://github.com/thycotic-ps/thycotic.secretserver/blob/master/src/classes/TssSession.class.ps1)

Expand Down
5 changes: 4 additions & 1 deletion docs/collections/_docs/02-compatibility.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,10 @@ last_modified_at: 2021-02-10T00:00:00-00:00
toc: false
---

Back support use of the module with older versions of Secret Server is limited. Endpoints used in the module where the endpoint exists in a specific version are listed below for reference.
The module will attempt to support version 10.0 and higher of Secret Server. Endpoints added in specific releases of Secret Server in the module are listed below for reference.

Each function listed below will include a test for the Secret Server version to warn of any potential failure with an endpoint.
{: .notice--info}

## Function List

Expand Down
4 changes: 2 additions & 2 deletions docs/collections/_docs/03-invoketssrestapi.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@ excerpt: "Thycotic.SecretServer raw API calls"
last_modified_at: 2021-02-10T00:00:00-00:00
---

The module functions utilize this command for calling endpoints. The functions are meant to handle formatting the output where it can be more easily read and utilzied for processing in PowerShell scripts. If you want to see the raw endpoint's output you can utilize `Invoke-TssRestApi` for that purpose.
The module functions utilize this command for calling endpoints. The functions are meant to handle formatting the output where it can be more easily read and utilized for processing in PowerShell scripts. If you want to see the raw endpoint's output, you can utilize `Invoke-TssRestApi` for that purpose.

## What about Invoke-RestMethod

In PowerShell, the cmdlet used for REST API calls is `Invoke-RestMethod`, and Thycotic.SecretServer uses this same command. The `Invoke-TssRestApi` acts as a wrapper to `Invoke-RestMethod` with a few additions:
In PowerShell, the cmdlet used for REST API calls is `Invoke-RestMethod` and Thycotic.SecretServer uses this same command. The `Invoke-TssRestApi` acts as a wrapper to `Invoke-RestMethod` with a few additions:

- Deals with creating the required header object for Secret Server using `-PersonalAccessToken`
- Unwrap objects returned by an endpoint easily using `-ExpandProperty`
Expand Down

0 comments on commit 6f47e67

Please sign in to comment.