LukeParke/developer.sailpoint.com
1
0
Fork 0
mirror of https://github.com/LukeHagar/developer.sailpoint.com.git synced 2025-12-07 12:27:47 +00:00
Code Issues Packages Projects Releases Wiki Activity

adding powershell sdk docs back

Browse Source
This commit is contained in:
darrell-thobe-sp
2025-01-28 13:29:29 -05:00
parent 248e4afe6b
commit c69a78b807
2822 changed files with 201703 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

63
docs/tools/sdk/powershell/Reference/V3/Models/CreateOAuthClientRequest.md Normal file
View File

@@ -0,0 +1,63 @@
---
id: create-o-auth-client-request
title: CreateOAuthClientRequest
pagination_label: CreateOAuthClientRequest
sidebar_label: CreateOAuthClientRequest
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'CreateOAuthClientRequest', 'CreateOAuthClientRequest']
slug: /tools/sdk/powershell/v3/models/create-o-auth-client-request
tags: ['SDK', 'Software Development Kit', 'CreateOAuthClientRequest', 'CreateOAuthClientRequest']
---
# CreateOAuthClientRequest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**BusinessName** | Pointer to **String** | The name of the business the API Client should belong to | [optional]
**HomepageUrl** | Pointer to **String** | The homepage URL associated with the owner of the API Client | [optional]
**Name** | **String** | A human-readable name for the API Client | [required]
**Description** | **String** | A description of the API Client | [required]
**AccessTokenValiditySeconds** | **Int32** | The number of seconds an access token generated for this API Client is valid for | [required]
**RefreshTokenValiditySeconds** | Pointer to **Int32** | The number of seconds a refresh token generated for this API Client is valid for | [optional]
**RedirectUris** | Pointer to **[]String** | A list of the approved redirect URIs. Provide one or more URIs when assigning the AUTHORIZATION_CODE grant type to a new OAuth Client. | [optional]
**GrantTypes** | [**[]GrantType**](grant-type) | A list of OAuth 2.0 grant types this API Client can be used with | [required]
**AccessType** | [**AccessType**](access-type) | | [required]
**Type** | Pointer to [**ClientType**](client-type) | | [optional]
**Internal** | Pointer to **Boolean** | An indicator of whether the API Client can be used for requests internal within the product. | [optional]
**Enabled** | **Boolean** | An indicator of whether the API Client is enabled for use | [required]
**StrongAuthSupported** | Pointer to **Boolean** | An indicator of whether the API Client supports strong authentication | [optional]
**ClaimsSupported** | Pointer to **Boolean** | An indicator of whether the API Client supports the serialization of SAML claims when used with the authorization_code flow | [optional]
**Scope** | Pointer to **[]String** | Scopes of the API Client. If no scope is specified, the client will be created with the default scope ""sp:scopes:all"". This means the API Client will have all the rights of the owner who created it. | [optional]
## Examples
- Prepare the resource
```powershell
$CreateOAuthClientRequest = Initialize-PSSailpoint.V3CreateOAuthClientRequest -BusinessName Acme-Solar `
-HomepageUrl http://localhost:12345 `
-Name Demo API Client `
-Description An API client used for the authorization_code, refresh_token, and client_credentials flows `
-AccessTokenValiditySeconds 750 `
-RefreshTokenValiditySeconds 86400 `
-RedirectUris [http://localhost:12345] `
-GrantTypes [AUTHORIZATION_CODE, CLIENT_CREDENTIALS, REFRESH_TOKEN] `
-AccessType null `
-Type null `
-Internal false `
-Enabled true `
-StrongAuthSupported false `
-ClaimsSupported false `
-Scope [demo:api-client-scope:first, demo:api-client-scope:second]
```
- Convert the resource to JSON
```powershell
$CreateOAuthClientRequest | ConvertTo-JSON
```
[[Back to top]](#)