Skip to main content

GetOAuthClientResponse

Properties

NameTypeDescriptionNotes
idstrID of the OAuth client[required]
business_namestrThe name of the business the API Client should belong to[required]
homepage_urlstrThe homepage URL associated with the owner of the API Client[required]
namestrA human-readable name for the API Client[required]
descriptionstrA description of the API Client[required]
access_token_validity_secondsintThe number of seconds an access token generated for this API Client is valid for[required]
refresh_token_validity_secondsintThe number of seconds a refresh token generated for this API Client is valid for[required]
redirect_uris[]strA list of the approved redirect URIs used with the authorization_code flow[required]
grant_types[]GrantTypeA list of OAuth 2.0 grant types this API Client can be used with[required]
access_typeAccessType[required]
typeClientType[required]
internalboolAn indicator of whether the API Client can be used for requests internal to IDN[required]
enabledboolAn indicator of whether the API Client is enabled for use[required]
strong_auth_supportedboolAn indicator of whether the API Client supports strong authentication[required]
claims_supportedboolAn indicator of whether the API Client supports the serialization of SAML claims when used with the authorization_code flow[required]
createddatetimeThe date and time, down to the millisecond, when the API Client was created[required]
modifieddatetimeThe date and time, down to the millisecond, when the API Client was last updated[required]
secretstr[optional]
metadatastr[optional]
last_useddatetimeThe date and time, down to the millisecond, when this API Client was last used to generate an access token. This timestamp does not get updated on every API Client usage, but only once a day. This property can be useful for identifying which API Clients are no longer actively used and can be removed.[optional]
scope[]strScopes of the API Client.[required]
}

Example

from sailpoint.beta.models.get_o_auth_client_response import GetOAuthClientResponse

get_o_auth_client_response = GetOAuthClientResponse(
id='2c9180835d2e5168015d32f890ca1581',
business_name='Acme-Solar',
homepage_url='http://localhost:12345',
name='Demo API Client',
description='An API client used for the authorization_code, refresh_token, and client_credentials flows',
access_token_validity_seconds=750,
refresh_token_validity_seconds=86400,
redirect_uris=[http://localhost:12345],
grant_types=[AUTHORIZATION_CODE, CLIENT_CREDENTIALS, REFRESH_TOKEN],
access_type='OFFLINE',
type='CONFIDENTIAL',
internal=False,
enabled=True,
strong_auth_supported=False,
claims_supported=False,
created='2017-07-11T18:45:37.098Z',
modified='2018-06-25T20:22:28.104Z',
secret='',
metadata='',
last_used='2017-07-11T18:45:37.098Z',
scope=[demo:api-client-scope:first, demo:api-client-scope:second]
)

[Back to top]