CreateOAuthClientResponse

Properties

Name	Type	Description	Notes
Id	String	ID of the OAuth client	[required]
Secret	String	Secret of the OAuth client (This field is only returned on the intial create call.)	[required]
BusinessName	String	The name of the business the API Client should belong to	[required]
HomepageUrl	String	The homepage URL associated with the owner of the API Client	[required]
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	Int32	The number of seconds a refresh token generated for this API Client is valid for	[required]
RedirectUris	[]String	A list of the approved redirect URIs used with the authorization_code flow	[required]
GrantTypes	[]GrantType	A list of OAuth 2.0 grant types this API Client can be used with	[required]
AccessType	AccessType		[required]
Type	ClientType		[required]
Internal	Boolean	An indicator of whether the API Client can be used for requests internal to IDN	[required]
Enabled	Boolean	An indicator of whether the API Client is enabled for use	[required]
StrongAuthSupported	Boolean	An indicator of whether the API Client supports strong authentication	[required]
ClaimsSupported	Boolean	An indicator of whether the API Client supports the serialization of SAML claims when used with the authorization_code flow	[required]
Created	System.DateTime	The date and time, down to the millisecond, when the API Client was created	[required]
Modified	System.DateTime	The date and time, down to the millisecond, when the API Client was last updated	[required]
Scope	[]String	Scopes of the API Client.	[required]

Examples

Prepare the resource

$CreateOAuthClientResponse = Initialize-BetaCreateOAuthClientResponse  -Id 2c9180835d2e5168015d32f890ca1581 `
 -Secret 5c32dd9b21adb51c77794d46e71de117a1d0ddb36a7ff941fa28014ab7de2cf3 `
 -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 `
 -Created 2017-07-11T18:45:37.098Z `
 -Modified 2018-06-25T20:22:28.104Z `
 -Scope [demo:api-client-scope:first, demo:api-client-scope:second]

Convert the resource to JSON

$CreateOAuthClientResponse | ConvertTo-JSON

[Back to top]

Properties​

Examples​

Properties

Examples