Mandatory fields
The Webex connector allows you to connect Webex with One Identity Starling enabling you to take advantage of the features and products available with Starling Connect that complement and enhance Webex's real-time video conferencing and communication services. With features such as file sharing, screen sharing, the Webex application enables teams to collaborate without interruption over any device such as mac, PC, or mobile.
Connector configuration
Webex connector requires customer consent to retrieve resource details using REST APIs. Currently, the Webex connector supports the configuration of a single tenant connector only.
NOTE:
- To provide consent, use an account with administrative privileges.
- For more information, see
Supervisor configuration parameters
To configure the connector, following parameters are required:
-
Connector name
-
Client Id for the integration app
-
Client Secret of the integration app
-
Target URL (Cloud application's instance URL used as target URI in payload. The value needs to be https://webexapis.com/v1)
-
Instance DateTime Offset (refer Configuring additional datetime offset in connectors for more details).
Supported objects and operations
Users
Table 312: Supported operations for Users
| Create User |
POST |
| Update User |
PUT |
| Delete User |
DELETE |
| Get User |
GET |
| Get Users |
GET |
Groups
Table 313: Supported operations for Groups
| Create Group |
POST |
| Update Group |
PUT |
| Delete Group |
DELETE |
| Get Group |
GET |
|
Get Groups |
GET |
Roles
Table 314: Supported operations for Roles
| Get Role |
GET |
| Get Roles |
GET |
Profiles
Table 315: Supported operations for Profiles
| Get Profile |
GET |
| Get Profiles |
GET |
This section lists the mandatory fields required to create a User or Group:
Users
Groups
displayName
User and Group mapping
The user and group mappings are listed in the tables below.
Table 316: User mapping
| id |
id |
| userName |
emails[0] |
| name.familyName |
lastName |
| name.givenName |
firstName |
| name.formatted |
firstName lastName |
|
displayName |
displayName |
|
nickName |
nickName |
|
emails[0].value |
emails[0] |
|
timezone |
timezone |
|
active |
loginEnabled |
|
userType |
type |
|
roles[].value |
roles[] |
|
entitlements[].value |
licenses[] |
|
photos[].value |
avatar |
|
userExtension.organization |
orgId |
|
userExtension.status |
status |
|
meta.created |
created |
|
meta.lastModified |
lastModified |
Groups
Table 317: Groups mapping
| id |
id |
| displayName |
name |
| members[].value |
members[].personId |
| members[].display |
members[].personDisplayName |
| meta.created |
created |
Connector limitations
-
If the wrong cursor is passed in the request, the cloud instance does not validate it as an error. Hence the SCIM response will contain only the schema URN and the previous cursor.
-
Sometimes, even though the wrong cursor is passed in the request, the cloud instance returns the resources.
- Webex User creation requires you to pass either of one of the following attributes as a mandatory attribute
-
Multiple groups with the same name can be created due to target system behavior.
-
The last moderator of a group can leave the group or can be unassigned from the group only if there are no members in the group. This happens due to target system behavior.
-
When you update a group, removing the last member of the group removes the entire group due to target system behavior. In this scenario, the WebEx connector returns error 404 as the update operation internally is carried out internally as
- update group name
- manage members
- retrieve updated group details
-
When a group member, who is a moderator of the group and whose credentials are used while providing consent for the Webex integration app, gets removed from the Webex connector group update operations or has been assigned as a normal member but not a moderator through the Webex Teams User Interface, then the Webex connector fails to update the group due to insufficient privileges on that particular the group.
-
Deleting or updating a deleted user results in error 403 due to target system behavior.
User and Group mapping
The Webex connector allows you to connect Webex with One Identity Starling enabling you to take advantage of the features and products available with Starling Connect that complement and enhance Webex's real-time video conferencing and communication services. With features such as file sharing, screen sharing, the Webex application enables teams to collaborate without interruption over any device such as mac, PC, or mobile.
Connector configuration
Webex connector requires customer consent to retrieve resource details using REST APIs. Currently, the Webex connector supports the configuration of a single tenant connector only.
NOTE:
- To provide consent, use an account with administrative privileges.
- For more information, see
Supervisor configuration parameters
To configure the connector, following parameters are required:
-
Connector name
-
Client Id for the integration app
-
Client Secret of the integration app
-
Target URL (Cloud application's instance URL used as target URI in payload. The value needs to be https://webexapis.com/v1)
-
Instance DateTime Offset (refer Configuring additional datetime offset in connectors for more details).
Supported objects and operations
Users
Table 312: Supported operations for Users
| Create User |
POST |
| Update User |
PUT |
| Delete User |
DELETE |
| Get User |
GET |
| Get Users |
GET |
Groups
Table 313: Supported operations for Groups
| Create Group |
POST |
| Update Group |
PUT |
| Delete Group |
DELETE |
| Get Group |
GET |
|
Get Groups |
GET |
Roles
Table 314: Supported operations for Roles
| Get Role |
GET |
| Get Roles |
GET |
Profiles
Table 315: Supported operations for Profiles
| Get Profile |
GET |
| Get Profiles |
GET |
Mandatory fields
This section lists the mandatory fields required to create a User or Group:
Users
Groups
displayName
The user and group mappings are listed in the tables below.
Table 316: User mapping
| id |
id |
| userName |
emails[0] |
| name.familyName |
lastName |
| name.givenName |
firstName |
| name.formatted |
firstName lastName |
|
displayName |
displayName |
|
nickName |
nickName |
|
emails[0].value |
emails[0] |
|
timezone |
timezone |
|
active |
loginEnabled |
|
userType |
type |
|
roles[].value |
roles[] |
|
entitlements[].value |
licenses[] |
|
photos[].value |
avatar |
|
userExtension.organization |
orgId |
|
userExtension.status |
status |
|
meta.created |
created |
|
meta.lastModified |
lastModified |
Groups
Table 317: Groups mapping
| id |
id |
| displayName |
name |
| members[].value |
members[].personId |
| members[].display |
members[].personDisplayName |
| meta.created |
created |
Connector limitations
-
If the wrong cursor is passed in the request, the cloud instance does not validate it as an error. Hence the SCIM response will contain only the schema URN and the previous cursor.
-
Sometimes, even though the wrong cursor is passed in the request, the cloud instance returns the resources.
- Webex User creation requires you to pass either of one of the following attributes as a mandatory attribute
-
Multiple groups with the same name can be created due to target system behavior.
-
The last moderator of a group can leave the group or can be unassigned from the group only if there are no members in the group. This happens due to target system behavior.
-
When you update a group, removing the last member of the group removes the entire group due to target system behavior. In this scenario, the WebEx connector returns error 404 as the update operation internally is carried out internally as
- update group name
- manage members
- retrieve updated group details
-
When a group member, who is a moderator of the group and whose credentials are used while providing consent for the Webex integration app, gets removed from the Webex connector group update operations or has been assigned as a normal member but not a moderator through the Webex Teams User Interface, then the Webex connector fails to update the group due to insufficient privileges on that particular the group.
-
Deleting or updating a deleted user results in error 403 due to target system behavior.
Connector limitations
The Webex connector allows you to connect Webex with One Identity Starling enabling you to take advantage of the features and products available with Starling Connect that complement and enhance Webex's real-time video conferencing and communication services. With features such as file sharing, screen sharing, the Webex application enables teams to collaborate without interruption over any device such as mac, PC, or mobile.
Connector configuration
Webex connector requires customer consent to retrieve resource details using REST APIs. Currently, the Webex connector supports the configuration of a single tenant connector only.
NOTE:
- To provide consent, use an account with administrative privileges.
- For more information, see
Supervisor configuration parameters
To configure the connector, following parameters are required:
-
Connector name
-
Client Id for the integration app
-
Client Secret of the integration app
-
Target URL (Cloud application's instance URL used as target URI in payload. The value needs to be https://webexapis.com/v1)
-
Instance DateTime Offset (refer Configuring additional datetime offset in connectors for more details).
Supported objects and operations
Users
Table 312: Supported operations for Users
| Create User |
POST |
| Update User |
PUT |
| Delete User |
DELETE |
| Get User |
GET |
| Get Users |
GET |
Groups
Table 313: Supported operations for Groups
| Create Group |
POST |
| Update Group |
PUT |
| Delete Group |
DELETE |
| Get Group |
GET |
|
Get Groups |
GET |
Roles
Table 314: Supported operations for Roles
| Get Role |
GET |
| Get Roles |
GET |
Profiles
Table 315: Supported operations for Profiles
| Get Profile |
GET |
| Get Profiles |
GET |
Mandatory fields
This section lists the mandatory fields required to create a User or Group:
Users
Groups
displayName
User and Group mapping
The user and group mappings are listed in the tables below.
Table 316: User mapping
| id |
id |
| userName |
emails[0] |
| name.familyName |
lastName |
| name.givenName |
firstName |
| name.formatted |
firstName lastName |
|
displayName |
displayName |
|
nickName |
nickName |
|
emails[0].value |
emails[0] |
|
timezone |
timezone |
|
active |
loginEnabled |
|
userType |
type |
|
roles[].value |
roles[] |
|
entitlements[].value |
licenses[] |
|
photos[].value |
avatar |
|
userExtension.organization |
orgId |
|
userExtension.status |
status |
|
meta.created |
created |
|
meta.lastModified |
lastModified |
Groups
Table 317: Groups mapping
| id |
id |
| displayName |
name |
| members[].value |
members[].personId |
| members[].display |
members[].personDisplayName |
| meta.created |
created |
-
If the wrong cursor is passed in the request, the cloud instance does not validate it as an error. Hence the SCIM response will contain only the schema URN and the previous cursor.
-
Sometimes, even though the wrong cursor is passed in the request, the cloud instance returns the resources.
- Webex User creation requires you to pass either of one of the following attributes as a mandatory attribute
-
Multiple groups with the same name can be created due to target system behavior.
-
The last moderator of a group can leave the group or can be unassigned from the group only if there are no members in the group. This happens due to target system behavior.
-
When you update a group, removing the last member of the group removes the entire group due to target system behavior. In this scenario, the WebEx connector returns error 404 as the update operation internally is carried out internally as
- update group name
- manage members
- retrieve updated group details
-
When a group member, who is a moderator of the group and whose credentials are used while providing consent for the Webex integration app, gets removed from the Webex connector group update operations or has been assigned as a normal member but not a moderator through the Webex Teams User Interface, then the Webex connector fails to update the group due to insufficient privileges on that particular the group.
-
Deleting or updating a deleted user results in error 403 due to target system behavior.
Apigee
The Apigee connector allows you to connect Apigee with One Identity Starling enabling you to take advantage of the features and products available with Starling Connect that complement and enhance Apigee's platform that allows you to design, secure, analyze, scale, publish, monitor, and manage the APIs.
Supervisor configuration parameters
To configure the connector, following parameters are required:
Supported objects and operations
Users
Table 318: Supported operations for Users
| Create User |
POST |
| Update User |
PUT |
| Delete User |
DELETE |
| Get User by ID |
GET |
| Get All Users |
GET |
Roles
Table 319: Supported operations for Roles
| Get Role by id |
GET |
| Get All Roles |
GET |
Mandatory fields
This section lists the mandatory fields required to create a User or Group:
Users
-
Name.GivenName
-
Name.FamilyName
-
Emails.Value
- Password
User and Group mapping
The user and group mappings are listed in the tables below.
Table 320: User mapping
| id |
emailId |
| userName |
emailId |
| DisplayName |
firstName+lastName |
| Name.GivenName |
firstName |
| Name.FamilyName |
lastName |
| Emails.Value |
emailId |
| Roles[].value |
(userRolesResponse)role[].name |
| Password |
Password |
Role
Table 321: Role mapping
| id |
name |
| name |
name |
Connector limitations
-
At least one role must be assigned to the created user. If the role is not assigned to the user, the particular user is not visible on the User management dashboard of the target instance due to the limitation of the target system.
-
Get All Users does not return the displayName as it is not available in the target system. However, Get User by ID returns the display name with the other available attributes of the User.
- Create User operation fails intermittently and an Internal Server Error 500 is displayed due to the Target system API behavior.
-
The Get All and Create User operations may occasionally take more time to respond for requests.
- Apigee Connector does not support pagination for Users and Roles object types due to API limitation in the target system.
- The connector does not support special characters in the object ID. For more information, see Connectors that do not support special characters in the object ID.
Synchronization and integration of Roles object type with One Identity Manager
For more information, see Synchronization and integration of Roles object type with One Identity Manager.
