Skip to main content

Createoauthclientrequest

Properties

NameTypeDescriptionNotes
businessName(optional) stringThe name of the business the API Client should belong to[default to undefined]
homepageUrl(optional) stringThe homepage URL associated with the owner of the API Client[default to undefined]
namestringA human-readable name for the API Client[default to undefined]
descriptionstringA description of the API Client[default to undefined]
accessTokenValiditySecondsnumberThe number of seconds an access token generated for this API Client is valid for[default to undefined]
refreshTokenValiditySeconds(optional) numberThe number of seconds a refresh token generated for this API Client is valid for[default to undefined]
redirectUris(optional) Array<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.[default to undefined]
grantTypesArray<Granttype>A list of OAuth 2.0 grant types this API Client can be used with[default to undefined]
accessTypeAccesstype[default to undefined]
type(optional) Clienttype[default to undefined]
internal(optional) booleanAn indicator of whether the API Client can be used for requests internal within the product.[default to undefined]
enabledbooleanAn indicator of whether the API Client is enabled for use[default to undefined]
strongAuthSupported(optional) booleanAn indicator of whether the API Client supports strong authentication[default to undefined]
claimsSupported(optional) booleanAn indicator of whether the API Client supports the serialization of SAML claims when used with the authorization_code flow[default to undefined]
scope(optional) Array<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.[default to undefined]