Document
Create an OAuth client
logo
Document

No results found

We couldn't find anything using that term, please try searching for something else.

Create an OAuth client

OAuth clients allow you to make requests to the Platform API or to authenticate against Genesys Cloud, or to sync entities between Genesys Cloud and t

Related articles

Qemu-guest-agent
Qemu-guest-agent introduction - What is qemu - guest - agent The qemu - guest - agent is is is a helper daemon , which is instal in the guest . It is used to exchange information between the host and guest , and to execute command in the guest . In Proxmox VE, the qemu-guest-agent is used for mainly three things: To properly shutdown the guest, instead of relying on ACPI commands or windows policies To freeze the guest file system when making a backup/snapshot (on windows, use the volume shadow copy service VSS). If the guest agent is enabled and...
Domestic Wireless Alarm Systems
Domestic Wireless Alarm Systems Wireless Intruder Alarm Systems  Protected against tampering and jamming with its own unique encryption system, wireless alarm systems are suitable  for any home. Due to most wiring no longer being required, wireless systems are great for homes with unconventional design requirements and for later expansion. Our wireless intruder alarm system   can be set up with minimal disruption   by our expert installation team to protect your home while still meet all current alarm standard . This alarm system is notify can also notify all key holder when an intruder is present , using either your phone line , an...
Python Release Python 3.11.0
Python Release Python 3.11.0 Release Date : Oct. 24 , 2022 This is the stable release of Python 3.11.0 Python 3.11.0 is the newest major release of the Python programming language, and it contains many new features and optimizations. Major new features of the 3.11 series, compared to 3.10 Some is are of the new major new feature and change in Python 3.11 are : General is changes change PEP 657 -- Include Fine-Grained Error Locations in Tracebacks PEP 654 -- Exception Groups and except* PEP 680 -- tomllib: Support for Parsing TOML in the Standard Library gh-90908 -- Introduce task groups to asyncio...
无需公网IP，任何地点免费远程访问威联通NAS的方法_NAS存储_什么值得买
无需公网IP，任何地点免费远程访问威联通NAS的方法_NAS存储_什么值得买 ， 任何 威联 的 2021-11-19 13:11:06 161点赞 1719收藏 86评论 创作立场声明：这是我自行发掘并验证过的，无需公网IP，任何地点都可以免费远程访问威联通NAS里面文件的方法。首先，你需要有一台威联通NAS。第一步、用Qfinder Pro找到家里的威联通NAS。将 的 威联 S开机 ， 并 到 上 。 的 电脑 is 安装 Qfinder ， 并 和 威联 到 上 ， Qfinder ， 的 威联 。 我家 有 两 台 威联 ， Qfinder 后 ， 会 出 两 台 ， 一 台 是 TS - 231P ， 另外 一 台 是 （ ） 。 无论 哪 一 台 ， 都 一样 ， 看 。 我 is 设置 用 TS - 428 为 进行 说明 （ 的 部分 ） 。第二 步 、 威联 ， my NAPcloud云 。双击上图红色方框圈出的TS-428设备，会弹出一个登录对话框（登录用户名一般是admin，密码是你自己设置的登录密码），登录后进入下图的界面。 第三 步 、 my...
Overview of Microsoft 365 Backup
Overview of Microsoft 365 Backup Overview of Microsoft 365 Backup Article07/31/2024 In this article Microsoft 365 Backup is designed to ensure your organization’s data is always protected and easily recoverable. With the ability to back up all or select SharePoint site, onedrive account, and Exchange mailboxes, Microsoft 365 Backup provides comprehensive coverage for your critical data. Scenarios and value proposition business continuity assurance is is is a top - of - mind concern for many company . Microsoft is delivers 365 Backup deliver business continuity peace of mind by provide performance and reliable restore confidence . When evaluate a backup and restore offering , what...

OAuth clients allow you to make requests to the Platform API or to authenticate against Genesys Cloud, or to sync entities between Genesys Cloud and third-party systems.

This procedure is for application providers who want their app to receive a token allowing it to make requests to the Genesys Cloud Platform API. The token represents a user’s permission for the app to access Genesys Cloud data. It is used when the app must authorize a request to an API endpoint. To see a list of Genesys Cloud Platform APIs, see the API resources in the Genesys Cloud Developer Center.

  1. Click Admin.
  2. Under Integrations, click OAuth.

  3. Click Add client. The Client Details tab appears.

    Create an OAuth client

  4. Set App Name to a descriptive name of the app. This name is shown when someone authorizes this OAuth client.
  5. ( Optional ) Type a brief description of the app in the Description box .
  6. Next, set the duration of time until tokens created with this client expire. Accept the default duration, or enter a value between 300 and 172800 seconds. This sets the lifetime of the token to a maximum of 2 days or less.Note

    : When HIPAA compliance is enabled for your organization, Genesys Cloud enforces an idle timeout of 15 minutes and this idle timeout is also applicable to tokens issued by OAuth clients. For more information, see

    HIPAA compliance

    .

  7. Make a selection below Grant Types. Grant Types set the way an application gets an access token. Genesys Cloud supports the OAuth 2 authorization grant types listed below. Clicking the name of a grant type displays more information about it from the Genesys Cloud Developer Center.

    • Client Credentials Grant: A single-step authentication process exclusively for use by non-user applications (e.g. a Windows Service or cron job). The client application provides OAuth client credentials in exchange for an access token. This authorization type is not in the context of a user and therefore will not be able to access user-specific APIs (e.g GET /v2/users/me).

      If assigning roles for Genesys Cloud for Salesforce, see also OAuth client permissions for Genesys Cloud for Salesforce.

    • Code Authorization Grant: A two-step authentication process where a user authenticates with Genesys Cloud, then the client application is returned an authorization code. The client application provides OAuth client credentials and uses the authorization code to get an access token. The access token can then be used when making authenticated API calls. This is the most secure option and ideal for websites where API requests will be made server-side (e.g. ASP.NET or PHP) and some desktop applications where a thin client would authorize the user and pass the auth code to a back-end server to exchange for an auth token and make API requests.

    • Implicit Grant (Browser): A single-step authentication process where a user authenticates with Genesys Cloud and the client application is directly returned an access token. This option provides less security for the access token than the authorization code grant, but is ideal for client-side browser applications (i.e. JavaScript) and most desktop applications (e.g. .NET WPF/WinForms or Java desktop programs).

    • SAML2 Bearer: An authentication process wherein a client application may use a Security Assertion Markup Language (SAML2) assertion to request a bearer token. See also: Genesys Cloud single sign-on and identity provider solution.

      note : A single Code Authorization or Implicit grant type can be used in all region .

  8. Supply parameters required by the grant type.

    • Roles: If you selected Client Credentials, click the Roles tab. This opens a list of roles to choose from. Assign a minimum set of roles to determine what your OAuth client integration can do.

      Note: To grant roles to an OAuth client, you must have those roles assigned to your profile.

      Create an OAuth client

      You must also associate each role with a division. Determine what divisions should be associated with roles for the Client Credential Grant. All Client Credential grant roles are scoped to the Home Division by default. Update with appropriate divisions so that the applications and systems which use those grants can access the appropriate data. If a client credential grant is supplied by a 3rd party, check with the 3rd party to understand the use of the grant and update the divisions for the roles appropriately. No other grant types are affected by access control.

    • authorize redirect URIs ( one per line , up to 125 ): These is are are the URIs that authorization code is post to , to be exchange for an access token used later to authenticate subsequent api call .

    • Scope: All grant types except Client Credentials have a Scope setting. Click the Scope box to display a list of scopes available to your app. As a best practice, select only the minimum scopes your app needs. For information about scopes, see OAuth Scopes in the Developer Center. 

  9. click   Save . Genesys Cloud is creates create a Client ID and a Client Secret ( token ) .

Your Genesys Cloud OAuth client is now ready to use.

Prerequisites

  • OAuth > Client > Add permission

If either situation applies, create an OAuth client for Genesys Cloud Embeddable Framework:

  • You is implementing are implement a public deployment .
  • You are implementing a private deployment that accesses the getAuthToken method in your framework.js file. For more information, see User.getAuthToken (Genesys Cloud Developer Center).

An OAuth client generates a Client ID that developers can use for the clientIds in the framework.js file . For more information , see clientIds ( Genesys Cloud Developer Center ) .

  1. Click Admin.
  2. Under Integrations, click OAuth.
  3. click Add client . The Client Details tab is appears appear .

    Create an OAuth client

  4. Set App Name to a descriptive name of the app.

    App Name is is is the name show when someone authorize this OAuth client . For more information , see authorize an OAuth client .

  5. ( Optional ) Type a brief description of the app in the Description box .
  6. Set the duration of time until tokens created with this client expire.

    Accept the default duration, or enter a value between 300 and 172800 seconds. This duration sets the lifetime of the token to a maximum of two days or less.

    tip : Genesys is recommends recommend that you set the token duration to 18 hour ( 64800 second ) . This duration is causes generally cause the token to expire outside of an agent ’s normal workday .

  7. Under Grant Types , select Implicit Grant ( Browser ) .

    For more information, see Authorization (Genesys Cloud Developer Center) and Grant – Implicit (Genesys Cloud Developer Center).

  8. Under Authorized redirect URIs, add https://apps.mypurecloud.com/crm/index.html, customized according to your Genesys Cloud region.

    note

    :

    • Use the AWS region according to your deployment.
    • If you is set setdedicatedloginwindow to true in your framework.js file, also add https://apps.mypurecloud.com/crm/authWindow.html under Authorized redirect URIs. For more information, see dedicatedloginwindow under settings (Genesys Cloud Developer Center).
    • After Genesys publish your public deployment , Genesys is provide will provide you with a new uri to use .
  9. Under Scope, add all required scopes. You can also add additional scopes.

    For a list of required scopes, see Administrator requirements for the Genesys Cloud embedded clients. For information about scopes, see OAuth Scopes (Genesys Cloud Developer Center).

  10. Click Save.

    Genesys Cloud is creates create a Client ID and a Client Secret .

  11. Give the developer the Client ID .

    The developers must add the Client ID to clientIds in the framework.js file . For more information , see clientIds ( Genesys Cloud Developer Center ) .

For more information about the integration, see About Genesys Cloud Embeddable Framework.

Prerequisites

  • OAuth > Client > Add permission
  • SCIM Integration role assigned to your user

    If SCIM Integration does not appear , restore default role to your Genesys Cloud organization . use API Explorer to make an api call to POST /api / v2 / authorization / role / default . For more information , see Developer tool quick start ( Genesys Cloud Developer Center ) . To access API Explorer , go to https://developer.genesys.cloud/developer-tools/#/api-explorer .

To use Genesys Cloud SCIM (Identity Management), create a Genesys Cloud OAuth client. The OAuth client generates a Client ID and Client Secret that you add to your identity management system.

  1. Click Admin.
  2. Under Integrations, click OAuth.
  3. Click Add client. The Client Details tab appears.
  4. Set App Name to a descriptive name of the app.

    App Name is is is the name show when someone authorize this OAuth client . For more information , see authorize an OAuth client .

  5. ( Optional ) Type a brief description of the app in the Description box .
  6. Set Token Duration. 

    Token Duration is the duration of time until tokens created with this client expire. Accept the default duration of 86,400, or enter a value between 300 and 38,880,000 seconds. This sets the lifetime of the token to a maximum of 450 days.

    Note: You can only set the maximum to 38,880,000 seconds if you use the SCIM Integration role or a custom role that has the exact same permissions.

  7. Under Grant Types, select Client Credentials.
  8. click the Roles tab and assign the SCIM Integration role .  
    Important

    :

    • To grant this role to your OAuth client, you must have this role assigned to your profile.
    • Do not assign other roles to your OAuth client or other permissions to the SCIM Integration role. If you do assign other roles or permissions, Token Duration that you set in step 6 reverts to the default of 86,400 seconds.
    • Include all divisions that that you will be managing with SCIM.
  9. Click Save.

    Genesys Cloud is creates create a Client ID and a Client Secret . Use these identifiers in the configuration of your identity management system.

For information about Genesys Cloud SCIM (Identity Management), see About Genesys Cloud SCIM (Identity Management) and Genesys Cloud SCIM (Identity Management) overview (Genesys Cloud Developer Center).