developer.sailpoint.com/docs/tools/sdk/powershell/Reference/V2024/Models/CreateOAuthClientRequest.md

id, title, pagination_label, sidebar_label, sidebar_class_name, keywords, slug, tags

id	title	pagination_label	sidebar_label	sidebar_class_name	keywords	slug	tags
v2024-create-o-auth-client-request	CreateOAuthClientRequest	CreateOAuthClientRequest	CreateOAuthClientRequest	powershellsdk	powershell PowerShell sdk CreateOAuthClientRequest V2024CreateOAuthClientRequest	/tools/sdk/powershell/v2024/models/create-o-auth-client-request	SDK Software Development Kit CreateOAuthClientRequest V2024CreateOAuthClientRequest

CreateOAuthClientRequest

Properties

Name	Type	Description	Notes
BusinessName	String	The name of the business the API Client should belong to	[optional]
HomepageUrl	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	Int32	The number of seconds a refresh token generated for this API Client is valid for	[optional]
RedirectUris	[]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	A list of OAuth 2.0 grant types this API Client can be used with	[required]
AccessType	AccessType		[required]
Type	ClientType		[optional]
Internal	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	Boolean	An indicator of whether the API Client supports strong authentication	[optional]
ClaimsSupported	Boolean	An indicator of whether the API Client supports the serialization of SAML claims when used with the authorization_code flow	[optional]
Scope	[]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

$CreateOAuthClientRequest = Initialize-V2024CreateOAuthClientRequest  -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

$CreateOAuthClientRequest | ConvertTo-JSON

[Back to top]