Package com.mypurecloud.sdk.v2.model

Class OAuthClient

java.lang.Object
com.mypurecloud.sdk.v2.model.OAuthClient
All Implemented Interfaces:
Serializable
public class OAuthClient extends Object implements Serializable
OAuthClient
See Also:

  • Constructor Details

    • OAuthClient

      public OAuthClient()

    • OAuthClient

      public OAuthClient(Boolean initWithEmptyList)

  • Method Details

    • getId

      public String getId()

    • name

      public OAuthClient name(String name)
      The name of the OAuth client.

    • getName

      public String getName()

    • setName

      public void setName(String name)

    • accessTokenValiditySeconds

      public OAuthClient accessTokenValiditySeconds(Long accessTokenValiditySeconds)
      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.

    • getAccessTokenValiditySeconds

      public Long getAccessTokenValiditySeconds()

    • setAccessTokenValiditySeconds

      public void setAccessTokenValiditySeconds(Long accessTokenValiditySeconds)

    • description

      public OAuthClient description(String description)

    • getDescription

      public String getDescription()

    • setDescription

      public void setDescription(String description)

    • registeredRedirectUri

      public OAuthClient registeredRedirectUri(List<String> registeredRedirectUri)
      List of allowed callbacks for this client. For example: https://myap.example.com/auth/callback

    • getRegisteredRedirectUri

      public List<String> getRegisteredRedirectUri()

    • setRegisteredRedirectUri

      public void setRegisteredRedirectUri(List<String> registeredRedirectUri)

    • secret

      public OAuthClient secret(String secret)
      System created secret assigned to this client. Secrets are required for code authorization and client credential grants.

    • getSecret

      public String getSecret()

    • setSecret

      public void setSecret(String secret)

    • roleIds

      public OAuthClient roleIds(List<String> roleIds)
      Deprecated. Use roleDivisions instead.

    • getRoleIds

      public List<String> getRoleIds()

    • setRoleIds

      public void setRoleIds(List<String> roleIds)

    • dateCreated

      public OAuthClient dateCreated(Date dateCreated)
      Date this client was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z

    • getDateCreated

      public Date getDateCreated()

    • setDateCreated

      public void setDateCreated(Date dateCreated)

    • dateModified

      public OAuthClient dateModified(Date dateModified)
      Date this client was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z

    • getDateModified

      public Date getDateModified()

    • setDateModified

      public void setDateModified(Date dateModified)

    • createdBy

      public OAuthClient createdBy(DomainEntityRef createdBy)
      User that created this client

    • getCreatedBy

      public DomainEntityRef getCreatedBy()

    • setCreatedBy

      public void setCreatedBy(DomainEntityRef createdBy)

    • modifiedBy

      public OAuthClient modifiedBy(DomainEntityRef modifiedBy)
      User that last modified this client

    • getModifiedBy

      public DomainEntityRef getModifiedBy()

    • setModifiedBy

      public void setModifiedBy(DomainEntityRef modifiedBy)

    • authorizedGrantType

      public OAuthClient authorizedGrantType(OAuthClient.AuthorizedGrantTypeEnum authorizedGrantType)
      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. PKCE-Enabled Code Authorization grant type - Code grant type which requires PKCE challenge and verifier to create tokens. Used in public clients for increased security. 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.

    • getAuthorizedGrantType

      public OAuthClient.AuthorizedGrantTypeEnum getAuthorizedGrantType()

    • setAuthorizedGrantType

      public void setAuthorizedGrantType(OAuthClient.AuthorizedGrantTypeEnum authorizedGrantType)

    • scope

      public OAuthClient scope(List<String> scope)
      The scope requested by this client. Scopes only apply to clients not using the client_credential grant

    • getScope

      public List<String> getScope()

    • setScope

      public void setScope(List<String> scope)

    • roleDivisions

      public OAuthClient roleDivisions(List<RoleDivision> roleDivisions)
      Set of roles and their corresponding divisions associated with this client. Roles and divisions only apply to clients using the client_credential grant

    • getRoleDivisions

      public List<RoleDivision> getRoleDivisions()

    • setRoleDivisions

      public void setRoleDivisions(List<RoleDivision> roleDivisions)

    • state

      public OAuthClient state(OAuthClient.StateEnum state)
      The state of the OAuth client. Active: The OAuth client can be used to create access tokens. This is the default state. Disabled: Access tokens created by the client are invalid and new ones cannot be created. Inactive: Access tokens cannot be created with this OAuth client and it will be deleted.

    • getState

      public OAuthClient.StateEnum getState()

    • setState

      public void setState(OAuthClient.StateEnum state)

    • dateToDelete

      public OAuthClient dateToDelete(Date dateToDelete)
      The time at which this client will be deleted. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z

    • getDateToDelete

      public Date getDateToDelete()

    • setDateToDelete

      public void setDateToDelete(Date dateToDelete)

    • getSelfUri

      public String getSelfUri()

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object