Gigya Job Openings

Groups Object

Skip to end of metadata
Go to start of metadata

 

Description

The Groups object contains all the user's CIAM for B2B Organization Management settings.

The Groups object returned from accounts.getAccountInfo contains (if not empty or null):

  • organizations - Array of organization settings.
    • roles - Array, the roles assigned to the user.
    • department - String, the user's department.
    • job - String, the user's job description.
    • orgId - String, the orgId of the organization assigned from Organization Management.
    • status - String, the user's organization status, i.e., 'active'.

  

Response Example:

{
    "callId": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "errorCode": 0,
    "apiVersion": 2,
    "time": "2019-06-23T06:19:16.766Z",
    "registeredTimestamp": 1557750712000,
    "UID": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "UIDSignature": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx=",
    "signatureTimestamp": "1561270756",
    "created": "2019-05-13T12:28:41.264Z",
    "createdTimestamp": 1557750521000,
    "data": {
        "subscribe": false,
    },
    "subscriptions": {},
    "preferences": {},
    "groups": {
        "organizations": [{
            "roles": ["OrgAdmin"],
            "department": "DA",
            "job": "Primary DA",
            "orgId": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
            "status": "active"
        }]
    },
    "emails": {
        ...SNIPPED...
    },
    "identities": [{
        ...SNIPPED...
    }],
    "isActive": true,
    "isLockedOut": false,
    "isRegistered": true,
    "isVerified": false,
    "lastLogin": "2019-06-17T13:37:59.247Z",
    "lastLoginLocation": {
        ...SNIPPED...
    },
    "lastLoginTimestamp": 1560778679000,
    "lastUpdated": "2019-06-20T08:32:56.257Z",
    "lastUpdatedTimestamp": 1561019576257,
    "loginProvider": "site",
    "loginIDs": {
        ...SNIPPED...
    },
    "rbaPolicy": {
        "riskPolicyLocked": false
    },
    "oldestDataUpdated": "2019-05-13T12:28:41.264Z",
    "oldestDataUpdatedTimestamp": 1557750521264,
    "profile": {
        ...SNIPPED...
    },
    "registered": "2019-05-13T12:31:52.683Z",
    "regSource": "",
    "socialProviders": "site",
    "userInfo": {
        ...SNIPPED...
    },
    "status": "OK",
    "errorMessage": "",
    "statusMessage": "",
    "requestParams": {
        ...SNIPPED...
    },
    "operation": "/accounts.getAccountInfo"
}

 

Updating User groups data

The Groups object is a read-only object that is received, in real-time, data maintained in the Organization Management system. There is no way to update this data outside of the Organization Management dashboard, e.g., you can not set or update this information using accounts.setAccountInfo.

 

Additional Information

CIAM for B2B

accounts.getAccountInfo

 

 

 
  • No labels