지금 지원 담당자와 채팅
지원 담당자와 채팅

Starling Connect Hosted - One Identity Manager Administration Guide

About this guide One Identity Starling Connect overview One Identity Starling Supported cloud applications Working with connectors Connector versions Salesforce Facebook Workplace SAP Cloud Platform JIRA Server RSA Archer SuccessFactors Amazon S3 AWS ServiceNow Dropbox Crowd Atlassian JIRA Confluence Trello Box Pipedrive SuccessFactors HR NutShell Insightly Egnyte SugarCRM Oracle IDCS Statuspage Zendesk Sell Workbooks DocuSign Citrix ShareFile Zendesk Azure AD Google Workspace Concur Tableau GoToMeeting Coupa AWS Cognito Okta DataDog Hideez Opsgenie Informatica Cloud Services AppDynamics Marketo Workday HR OneLogin PingOne Aha! SAP Litmos HackerRank Slack ActiveCampaign Webex Apigee Databricks Hive PagerDuty Dayforce Smartsheet Pingboard SAP Cloud for Customer Azure Infrastructure Oracle Fusion Cloud Majesco LuccaHR OpenText Appendix: Creating a service account in Google Workspace Appendix: Setting a trial account on Salesforce Registering the application, providing necessary permissions, retrieving Client Id and Client Secret from the Azure AD tenant Generating a private key for service account in GoToMeeting Configuring Amazon S3 AWS connector to support entitlements for User and Group Configuring Box connector to support additional email IDs for users One Identity Manager E2E integration needs for Hideez connector Configuring custom attributes for ServiceNow v.1.0 Configuring custom attributes for Coupa v.1.0 Configuring custom attributes in connectors Disabling attributes Configuring a connector that uses the consent feature Synchronization and integration of Roles object type with One Identity Manager Synchronization and integration of Workspaces object type with One Identity Manager Synchronization and integration of Products object type with One Identity Manager User centric membership Creating multi-valued custom fields in One Identity Manager Synchronization and assignment of PermissionSets to Users with One Identity Manager Connectors that support password attribute in User object Connectors that do not support special characters in the object ID Creating an app for using SCIM on Slack Enterprise Grid Organization Creating a Webex integration application, providing necessary scopes, retrieving Client Id and Client Secret Retrieving the API key from Facebook Workplace Outbound IP addresses Values for customer-specific configuration parameters in Workday HR connector Initiate an OAuth connection to SuccessFactors Creating custom editable/upsertable attributes in Successfactors employee central Custom Foundation Objects in Successfactors HR connector Configuring additional datetime offset in connectors How to Create custom attribute for Users in SuccessFactors portal SAP Cloud for Customer - Steps to add custom fields at One Identity Manager attributes Creating Service Principal to authenticate the Azure resource management REST APIs for Azure Infrastructure connector

Connector versions and features

The OneLogin connector allows you to connect OneLogin with One Identity Starling enabling you to take advantage of the features and products available with Starling Connect that complement and enhance the services provided by OneLogin.

OneLogin is a Unified Access Management (UAM) platform that provides several products and solutions, such as single sign-on, user provisioning and management and multi-factor authentication to manage identities.

Supervisor configuration parameters

To configure the connector, following parameters are required:

  • Connector name

  • Client Id

  • Client secret

  • SCIM URL (The base URL of the REST API of the Cloud application.)

  • Instance DateTime Offset (refer Configuring additional datetime offset in connectors for more details)

  • Request Delay (in ms)

    NOTE: To handle the OneLogin rate limit issue, the OneLogin connector has been enabled with user configurable delay in milliseconds so that the each request to the target API would wait for the specific amount of time to help the connector to prevent the throttling of the OneLogin APIs. The default value for the configuration is 500(milliseconds) and OneIdentity recommends to keep the value below 2000 (milliseconds).

Supported objects and operations

Users

Table 264: Supported operations for Users
Operation VERB
Create User POST
Update User PUT
Delete User DELETE
Get User by id GET
Get All Users GET

Get All Users with pagination

GET

Groups

Table 265: Supported operations for Groups

Operation

VERB

Get Group by id GET
Get All Groups GET
Get All Groups with pagination GET

Roles

Table 266: Supported operations for Roles

Operation

VERB

Get Role by id GET
Get All Roles GET
Get All Roles with pagination GET

Update Role

PUT

Application

Table 267: Supported operations for Application

Operation

VERB

Get an App GET
List Apps GET
List Apps with pagination GET

Mandatory fields

This section lists the mandatory fields required to create a User or a Group:

Users - Create (in v.1.0)

  • userName

  • name.givenName

  • name.familyName

  • emails.value

Users - Create (in v.2.0)

  • userName

  • emails.value

Users - Update

userName or emails.value

Roles - Update

roleName

Set Role Apps - update

application id

Mappings

The user and group mappings are listed in the tables below.

Table 268: User mapping
SCIM Parameter OneLogin parameter
Id Id
UserName username
ExternalId external_id
Name.GivenName firstname
Name.FamilyName lastname
Name.Formatted firstname +" " + lastname
DisplayName firstname +" " + lastname
Emails[0].Value email
PhoneNumbers[0].Value phone
Title title
Roles[].Value role_id[]

Groups[0].value

group_id

Locale

locale_code(in v1),preferred_locale_code(in v2)

Password (only in v2.0)

password

Extension.Manager.Value

manager_user_id

Extension.Organization

company

Extension.Department

department

Extension.OpenIdName

openid_name

Extension.DistinguishedName

distinguished_name

Extension.SamAccountName

samaccountname

Extension.UserPrincipalName

userprincipalname

Extension.MemberOf

member_of

Extension.DirectoryId

directory_id

Extension.UserStatus

status

Extension.LastLogin

last_login

Meta.Created

created_at

Meta.LastModified

updated_at

Groups

Table 269: Group mapping
SCIM parameter OneLogin parameter
Id id
DisplayName name

Roles

Table 270: Role mapping
SCIM parameter OneLogin parameter
Id id
Name name

Applications[].value

apps[].id

Applications[].name

apps[].name

users[].value

users[].id

users[].name

users[].name

Application

Table 271: Role mapping
SCIM parameter OneLogin parameter
Id id
Name name

Description

description

Auth_Method

auth_method

Visible

visible

Meta.Created

created_at

Meta.LastModified

updated_at

NOTE: OneLogin API for Users accepts two letter values for locale, for example: "en", "es" and so on.

Connector limitations

  • Target cloud application supports below given integer value for Status field. OneIdentity has created 'userStatus' integer type attribute in User extension schema and mapped with 'status' and it needs to be taken care in OneIM mapping:
    • (in v.1.0):

      • Can set through Api → Unactivated: 0, Active: 1, Suspended: 2, Locked: 3, Password expired: 4

      • Cannot set through Api → Awaiting password reset: 5, Pending password: 7, Security questions required: 8

    • (in v.2.0):

      • Can set through Api → Unactivated: 0, Active: 1, Suspended: 2, Locked: 3, Password expired: 4, Awaiting password reset: 5, Pending password: 7

      • Cannot set through Api → Security questions required: 8

  • Adding or removing a Group can be achieved by using the User update operation. Only one group can be assigned to a User.

  • For the User object, when NULL value is updated to openid_name, the cloud application considers the first part of the email Id as openid_name. For example, for the email id, email123@test.com , openIdname value will be email123.
  • API does not support the assignment of applications under users what it support is assigning application under roles and assigning roles under user.

The following subsections describe the different connector version(s) and features available with them.

Features available exclusively in OneLogin v.2.0

Following are the features that are available exclusively in OneLogin v.2.0:

  • Creation and updation of user password.
  • v.2.0 of OneLogin connector leverages v2 APIs of target system.

User centric membership configuration for OneLogin

For more information, see only the following sections in User centric membership:

User centric membership configuration for OneLogin

The OneLogin connector allows you to connect OneLogin with One Identity Starling enabling you to take advantage of the features and products available with Starling Connect that complement and enhance the services provided by OneLogin.

OneLogin is a Unified Access Management (UAM) platform that provides several products and solutions, such as single sign-on, user provisioning and management and multi-factor authentication to manage identities.

Supervisor configuration parameters

To configure the connector, following parameters are required:

  • Connector name

  • Client Id

  • Client secret

  • SCIM URL (The base URL of the REST API of the Cloud application.)

  • Instance DateTime Offset (refer Configuring additional datetime offset in connectors for more details)

  • Request Delay (in ms)

    NOTE: To handle the OneLogin rate limit issue, the OneLogin connector has been enabled with user configurable delay in milliseconds so that the each request to the target API would wait for the specific amount of time to help the connector to prevent the throttling of the OneLogin APIs. The default value for the configuration is 500(milliseconds) and OneIdentity recommends to keep the value below 2000 (milliseconds).

Supported objects and operations

Users

Table 264: Supported operations for Users
Operation VERB
Create User POST
Update User PUT
Delete User DELETE
Get User by id GET
Get All Users GET

Get All Users with pagination

GET

Groups

Table 265: Supported operations for Groups

Operation

VERB

Get Group by id GET
Get All Groups GET
Get All Groups with pagination GET

Roles

Table 266: Supported operations for Roles

Operation

VERB

Get Role by id GET
Get All Roles GET
Get All Roles with pagination GET

Update Role

PUT

Application

Table 267: Supported operations for Application

Operation

VERB

Get an App GET
List Apps GET
List Apps with pagination GET

Mandatory fields

This section lists the mandatory fields required to create a User or a Group:

Users - Create (in v.1.0)

  • userName

  • name.givenName

  • name.familyName

  • emails.value

Users - Create (in v.2.0)

  • userName

  • emails.value

Users - Update

userName or emails.value

Roles - Update

roleName

Set Role Apps - update

application id

Mappings

The user and group mappings are listed in the tables below.

Table 268: User mapping
SCIM Parameter OneLogin parameter
Id Id
UserName username
ExternalId external_id
Name.GivenName firstname
Name.FamilyName lastname
Name.Formatted firstname +" " + lastname
DisplayName firstname +" " + lastname
Emails[0].Value email
PhoneNumbers[0].Value phone
Title title
Roles[].Value role_id[]

Groups[0].value

group_id

Locale

locale_code(in v1),preferred_locale_code(in v2)

Password (only in v2.0)

password

Extension.Manager.Value

manager_user_id

Extension.Organization

company

Extension.Department

department

Extension.OpenIdName

openid_name

Extension.DistinguishedName

distinguished_name

Extension.SamAccountName

samaccountname

Extension.UserPrincipalName

userprincipalname

Extension.MemberOf

member_of

Extension.DirectoryId

directory_id

Extension.UserStatus

status

Extension.LastLogin

last_login

Meta.Created

created_at

Meta.LastModified

updated_at

Groups

Table 269: Group mapping
SCIM parameter OneLogin parameter
Id id
DisplayName name

Roles

Table 270: Role mapping
SCIM parameter OneLogin parameter
Id id
Name name

Applications[].value

apps[].id

Applications[].name

apps[].name

users[].value

users[].id

users[].name

users[].name

Application

Table 271: Role mapping
SCIM parameter OneLogin parameter
Id id
Name name

Description

description

Auth_Method

auth_method

Visible

visible

Meta.Created

created_at

Meta.LastModified

updated_at

NOTE: OneLogin API for Users accepts two letter values for locale, for example: "en", "es" and so on.

Connector limitations

  • Target cloud application supports below given integer value for Status field. OneIdentity has created 'userStatus' integer type attribute in User extension schema and mapped with 'status' and it needs to be taken care in OneIM mapping:
    • (in v.1.0):

      • Can set through Api → Unactivated: 0, Active: 1, Suspended: 2, Locked: 3, Password expired: 4

      • Cannot set through Api → Awaiting password reset: 5, Pending password: 7, Security questions required: 8

    • (in v.2.0):

      • Can set through Api → Unactivated: 0, Active: 1, Suspended: 2, Locked: 3, Password expired: 4, Awaiting password reset: 5, Pending password: 7

      • Cannot set through Api → Security questions required: 8

  • Adding or removing a Group can be achieved by using the User update operation. Only one group can be assigned to a User.

  • For the User object, when NULL value is updated to openid_name, the cloud application considers the first part of the email Id as openid_name. For example, for the email id, email123@test.com , openIdname value will be email123.
  • API does not support the assignment of applications under users what it support is assigning application under roles and assigning roles under user.

Connector versions and features

The following subsections describe the different connector version(s) and features available with them.

Features available exclusively in OneLogin v.2.0

Following are the features that are available exclusively in OneLogin v.2.0:

  • Creation and updation of user password.
  • v.2.0 of OneLogin connector leverages v2 APIs of target system.

For more information, see only the following sections in User centric membership:

PingOne

The PingOne connector allows you to connect PingOne with One Identity Starling enabling you to take advantage of the features and products available with Starling Connect that complement and enhance the services provided by PingOne.

PingOne is a hybrid Identity-as-a-Service (IDaaS) based product that allows users to use single sign-on across different applications.

Supervisor configuration parameters

To configure the connector, following parameters are required:

Supported objects and operations

Users

Table 272: Supported operations for Users
Operation VERB
Create User POST
Get User GET
Get Users GET
Update User PUT
Delete User DELETE

Groups

Table 273: Supported operations for Groups

Operation

VERB

Create Group POST
Get Group GET
Get Groups GET
Update Group PUT
Delete Group DELETE

Mandatory fields

Users

  • email[].value

  • userName

Groups

displayName

User and Group mapping

The user and group mappings are listed in the tables below.

Table 274: User mapping
SCIM Parameter PingOne Parameter
id id
userName userName
externalId externalId
name.givenName name.givenName
name.familyName name.familyName
name.middleName name.middleName
name.formatted name.formatted
name.honorificPrefix name.honorificPrefix
name.honorificSuffix name.honorificSuffix
displayName displayName
nickName nickName

email.value

email.value

email.type

email.type

email.primary

email.primary

addresses.formatted

addresses.formatted

addresses.streetAddress

addresses.streetAddress

addresses.locality

addresses.locality

addresses.region

addresses.region

addresses.postalCode

addresses.postalCode

addresses.country

addresses.country

addresses.type

addresses.type

phoneNumbers.value

phoneNumbers.value

phoneNumbers.type

phoneNumbers.type

password

password

profileUrl

profileUrl

title

title

userType

userType

preferredLanguage

preferredLanguage

locale

locale

timeZone

timeZone

active

active

entitlements.value

entitlements.value

roles.value

roles.value

ims.value

ims.value

ims.type

ims.type

groups.value

groups.value

groups.display

groups.display

x509Certificates.value

x509Certificates.value

extension.accountId

extension.accountId

extension.directoryId

extension.directoryId

extension.state

extension.state

extension.passwordExpired

extension.passwordExpired

meta.created

meta.created

meta.lastModified

meta.lastModified

Groups

Table 275: Group mapping
SCIM parameter PingOne parameter
id id
displayName displayName

members.value

members.value

members.display

members.display

members.type

members.type

extension.accountId

extension.accountId

extension.directoryId

extension.directoryId

meta.created

meta.created

meta.lastModified

meta.lastModified

Connector limitations

  • PingOne supports addresses of type home, work, and other. Similarly, it supports phone numbers of types work, mobile, home, fax, pager, and other. However the connector supports only one type of address and phone number.
    The connector first looks for type work. If type work is not found, the connector looks for type home.
    Else, it looks for the address and phone number of any type. If type value is not present, then the connector assigns the value of work to type.

Supervisor configuration parameters

The PingOne connector allows you to connect PingOne with One Identity Starling enabling you to take advantage of the features and products available with Starling Connect that complement and enhance the services provided by PingOne.

PingOne is a hybrid Identity-as-a-Service (IDaaS) based product that allows users to use single sign-on across different applications.

To configure the connector, following parameters are required:

Supported objects and operations

Users

Table 272: Supported operations for Users
Operation VERB
Create User POST
Get User GET
Get Users GET
Update User PUT
Delete User DELETE

Groups

Table 273: Supported operations for Groups

Operation

VERB

Create Group POST
Get Group GET
Get Groups GET
Update Group PUT
Delete Group DELETE

Mandatory fields

Users

  • email[].value

  • userName

Groups

displayName

User and Group mapping

The user and group mappings are listed in the tables below.

Table 274: User mapping
SCIM Parameter PingOne Parameter
id id
userName userName
externalId externalId
name.givenName name.givenName
name.familyName name.familyName
name.middleName name.middleName
name.formatted name.formatted
name.honorificPrefix name.honorificPrefix
name.honorificSuffix name.honorificSuffix
displayName displayName
nickName nickName

email.value

email.value

email.type

email.type

email.primary

email.primary

addresses.formatted

addresses.formatted

addresses.streetAddress

addresses.streetAddress

addresses.locality

addresses.locality

addresses.region

addresses.region

addresses.postalCode

addresses.postalCode

addresses.country

addresses.country

addresses.type

addresses.type

phoneNumbers.value

phoneNumbers.value

phoneNumbers.type

phoneNumbers.type

password

password

profileUrl

profileUrl

title

title

userType

userType

preferredLanguage

preferredLanguage

locale

locale

timeZone

timeZone

active

active

entitlements.value

entitlements.value

roles.value

roles.value

ims.value

ims.value

ims.type

ims.type

groups.value

groups.value

groups.display

groups.display

x509Certificates.value

x509Certificates.value

extension.accountId

extension.accountId

extension.directoryId

extension.directoryId

extension.state

extension.state

extension.passwordExpired

extension.passwordExpired

meta.created

meta.created

meta.lastModified

meta.lastModified

Groups

Table 275: Group mapping
SCIM parameter PingOne parameter
id id
displayName displayName

members.value

members.value

members.display

members.display

members.type

members.type

extension.accountId

extension.accountId

extension.directoryId

extension.directoryId

meta.created

meta.created

meta.lastModified

meta.lastModified

Connector limitations

  • PingOne supports addresses of type home, work, and other. Similarly, it supports phone numbers of types work, mobile, home, fax, pager, and other. However the connector supports only one type of address and phone number.
    The connector first looks for type work. If type work is not found, the connector looks for type home.
    Else, it looks for the address and phone number of any type. If type value is not present, then the connector assigns the value of work to type.

관련 문서

The document was helpful.

평가 결과 선택

I easily found the information I needed.

평가 결과 선택