Sha256: 4c7e92615c198d26be97dc1dcf4b2b5fa7f2ff66ace51f8ab20f8a86de25bc29
Contents?: true
Size: 1.74 KB
Versions: 43
Compression:
Stored size: 1.74 KB
Contents
---
title: OAuthClient
---
## PureCloud::OAuthClient
## Properties
|Name | Type | Description | Notes|
|------------ | ------------- | ------------- | -------------|
| **id** | **String** | The globally unique identifier for the object. | [optional] |
| **name** | **String** | The name of the OAuth client. | |
| **access_token_validity_seconds** | **Integer** | The number of seconds, between 5mins and 48hrs, until tokens created with this client expire. If this field is omitted, a default of 24 hours will be applied. | [optional] |
| **description** | **String** | | [optional] |
| **registered_redirect_uri** | **Array<String>** | List of allowed callbacks for this client. For example: https://myap.example.com/auth/callback | [optional] |
| **secret** | **String** | System created secret assigned to this client. Secrets are required for code authorization and client credential grants. | [optional] |
| **role_ids** | **Array<String>** | Roles assigned to this client. Roles only apply to clients using the client_credential grant | [optional] |
| **authorized_grant_type** | **String** | The OAuth Grant/Client type supported by this client. Code Authorization Grant/Client type - Preferred client type where the Client ID and Secret are required to create tokens. Used where the secret can be secured. Implicit grant type - Client ID only is required to create tokens. Used in browser and mobile apps where the secret can not be secured. SAML2-Bearer extension grant type - SAML2 assertion provider for user authentication at the token endpoint. Client Credential grant type - Used to created access tokens that are tied only to the client. | |
| **self_uri** | **String** | The URI for this object | [optional] |
{: class="table table-striped"}
Version data entries
43 entries across 43 versions & 1 rubygems