AWS-ILM
Integrate with AWS's services to execute CRUD and Group operations for employee lifecycle processes.
Authentication & Identity Management · AWS-ILM
Details
| ID | AWS-ILM |
|---|---|
| Provider | Amazon |
| Category | Authentication & Identity Management |
| From Version | 6.0.0 |
| Docker Image | demisto/python3:3.12.13.10116658 |
| Supported Modules | Agentix XSIAM EDR Cortex Cloud Cloud Runtime Security |
README
Integrate with AWS-ILM Identity Access Management service to execute CRUD (create, read, update, and delete) and group (create, get, update, and delete) operations for employee lifecycle processes.
For more information, refer to the Identity Lifecycle Management article.
Configure AWS-ILM in Cortex
| Parameter | Description | Required |
|---|---|---|
| Base URL | True | |
| Tenant ID | False | |
| Authentication Token | False | |
| Allow creating users | False | |
| Allow updating users | False | |
| Allow enabling users | False | |
| Allow disabling users | False | |
| Automatically create user if not found in update command | False | |
| Incoming Mapper | True | |
| Outgoing Mapper | Cortex XSOAR only parameter. | False |
| Trust any certificate (not secure) | False | |
| Use system proxy settings | False |
Commands
You can execute these commands from the CLI, as part of an automation, or in a playbook.
After you successfully execute a command, a DBot message appears in the War Room with the command details.
iam-create-user
Creates a user.
Base Command
iam-create-user
Input
| Argument Name | Description | Required |
|---|---|---|
| user-profile | User Profile indicator details. | Required |
| allow-enable | When set to true, after the command execution, the status of the user in the 3rd-party integration will be active. Possible values are: true, false. Default is true. | Optional |
Context Output
| Path | Type | Description |
|---|---|---|
| IAM.Vendor.active | Boolean | When true, indicates that the employee’s status is active in the 3rd-party integration. |
| IAM.Vendor.brand | String | Name of the integration. |
| IAM.Vendor.details | string | Provides the raw data from the 3rd-party integration. |
| IAM.Vendor.email | String | The employee’s email address. |
| IAM.Vendor.errorCode | Number | HTTP error response code. |
| IAM.Vendor.errorMessage | String | Reason why the API failed. |
| IAM.Vendor.id | String | The employee’s user ID in the app. |
| IAM.Vendor.instanceName | string | Name of the integration instance. |
| IAM.Vendor.success | Boolean | When true, indicates that the command was executed successfully. |
| IAM.Vendor.username | String | The employee’s username in the app. |
Command Example
!iam-create-user user-profile={"email": "john.doe@example.com", "username": "test", "givenname": "test", "surname": "test", "displayname": "test"}
Context Example
{
"IAM": {
"UserProfile": {
"displayname": "test",
"email": "john.doe@example.com",
"givenname": "test",
"surname": "test",
"username": "test"
},
"Vendor": {
"action": "create",
"active": false,
"brand": "AWS-ILM",
"details": {
"active": false,
"displayName": "test",
"emails": [
{
"primary": true,
"type": "work",
"value": "john.doe@example.com"
}
],
"id": "123456",
"meta": {
"created": "2021-08-23T12:53:51Z",
"lastModified": "2021-08-23T12:53:51Z",
"resourceType": "User"
},
"name": {
"familyName": "test",
"givenName": "test"
},
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:User"
],
"userName": "test"
},
"email": "john.doe@example.com",
"errorCode": null,
"errorMessage": "",
"id": "123456",
"instanceName": "AWS-ILM_instance_1",
"reason": "",
"skipped": false,
"success": true,
"username": "test"
}
}
}
Human Readable Output
Create User Results (AWS-ILM)
brand instanceName success active id username details AWS-ILM AWS-ILM_instance_1 true false 123456 test john.doe@example.com id: 123456
meta: {“resourceType”: “User”, “created”: “2021-08-23T12:53:51Z”, “lastModified”: “2021-08-23T12:53:51Z”}
schemas: urn:ietf:params:scim:schemas:core:2.0:User
userName: test
name: {“familyName”: “test”, “givenName”: “test”}
displayName: test
active: false
emails: {‘value’: ‘john.doe@example.com’, ‘type’: ‘work’, ‘primary’: True}
iam-update-user
Updates an existing user with the data passed in the user-profile argument.
Base Command
iam-update-user
Input
| Argument Name | Description | Required |
|---|---|---|
| user-profile | A User Profile indicator. | Required |
| allow-enable | When set to true, after the command execution, the status of the user in the 3rd-party integration will be active. Possible values are: true, false. Default is true. | Optional |
Context Output
| Path | Type | Description |
|---|---|---|
| IAM.Vendor.active | Boolean | When true, indicates that the employee’s status is active in the 3rd-party integration. |
| IAM.Vendor.brand | String | Name of the integration. |
| IAM.Vendor.details | string | Provides the raw data from the 3rd-party integration. |
| IAM.Vendor.email | String | The employee’s email address. |
| IAM.Vendor.errorCode | Number | HTTP error response code. |
| IAM.Vendor.errorMessage | String | Reason why the API failed. |
| IAM.Vendor.id | String | The employee’s user ID in the app. |
| IAM.Vendor.instanceName | string | Name of the integration instance. |
| IAM.Vendor.success | Boolean | When true, indicates that the command was executed successfully. |
| IAM.Vendor.username | String | The employee’s username in the app. |
Command Example
!iam-update-user user-profile={"username": "test"}
Context Example
{
"IAM": {
"UserProfile": {
"username": "test"
},
"Vendor": {
"action": "update",
"active": true,
"brand": "AWS-ILM",
"details": {
"active": true,
"displayName": "test",
"emails": [
{
"primary": true,
"type": "work",
"value": "john.doe@example.com"
}
],
"id": "123456",
"meta": {
"created": "2021-08-23T12:53:51Z",
"lastModified": "2021-08-23T12:53:54Z",
"resourceType": "User"
},
"name": {
"familyName": "test",
"givenName": "test"
},
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:User"
],
"userName": "test"
},
"email": null,
"errorCode": null,
"errorMessage": "",
"id": "123456",
"instanceName": "AWS-ILM_instance_1",
"reason": "",
"skipped": false,
"success": true,
"username": "test"
}
}
}
Human Readable Output
Update User Results (AWS-ILM)
brand instanceName success active id username details AWS-ILM AWS-ILM_instance_1 true true 123456 test id: 123456
meta: {“resourceType”: “User”, “created”: “2021-08-23T12:53:51Z”, “lastModified”: “2021-08-23T12:53:54Z”}
schemas: urn:ietf:params:scim:schemas:core:2.0:User
userName: test
name: {“familyName”: “test”, “givenName”: “test”}
displayName: test
active: true
emails: {‘value’: ‘john.doe@example.com’, ‘type’: ‘work’, ‘primary’: True}
iam-get-user
Retrieves a single user resource.
Base Command
iam-get-user
Input
| Argument Name | Description | Required |
|---|---|---|
| user-profile | A User Profile indicator. | Required |
Context Output
| Path | Type | Description |
|---|---|---|
| IAM.Vendor.active | Boolean | When true, indicates that the employee’s status is active in the 3rd-party integration. |
| IAM.Vendor.brand | String | Name of the integration. |
| IAM.Vendor.details | string | Provides the raw data from the 3rd-party integration. |
| IAM.Vendor.email | String | The employee’s email address. |
| IAM.Vendor.errorCode | Number | HTTP error response code. |
| IAM.Vendor.errorMessage | String | Reason why the API failed. |
| IAM.Vendor.id | String | The employee’s user ID in the app. |
| IAM.Vendor.instanceName | string | Name of the integration instance. |
| IAM.Vendor.success | Boolean | When true, indicates that the command was executed successfully. |
| IAM.Vendor.username | String | The employee’s username in the app. |
Command Example
!iam-get-user user-profile={"username": "test"}
Context Example
{
"IAM": {
"UserProfile": {
"Email": "john.doe@example.com",
"Given Name": "test",
"Surname": "test",
"Username": "test"
},
"Vendor": {
"action": "get",
"active": false,
"brand": "AWS-ILM",
"details": {
"active": false,
"displayName": "test",
"emails": [
{
"primary": true,
"type": "work",
"value": "john.doe@example.com"
}
],
"id": "123456",
"meta": {
"created": "2021-08-23T12:53:51Z",
"lastModified": "2021-08-23T12:53:57Z",
"resourceType": "User"
},
"name": {
"familyName": "test",
"givenName": "test"
},
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:User"
],
"userName": "test"
},
"email": null,
"errorCode": null,
"errorMessage": "",
"id": "123456",
"instanceName": "AWS-ILM_instance_1",
"reason": "",
"skipped": false,
"success": true,
"username": "test"
}
}
}
Human Readable Output
Get User Results (AWS-ILM)
brand instanceName success active id username details AWS-ILM AWS-ILM_instance_1 true false 123456 test id: 123456
meta: {“resourceType”: “User”, “created”: “2021-08-23T12:53:51Z”, “lastModified”: “2021-08-23T12:53:57Z”}
schemas: urn:ietf:params:scim:schemas:core:2.0:User
userName: test
name: {“familyName”: “test”, “givenName”: “test”}
displayName: test
active: false
emails: {‘value’: ‘john.doe@example.com’, ‘type’: ‘work’, ‘primary’: True}
iam-disable-user
Disable an active user.
Base Command
iam-disable-user
Input
| Argument Name | Description | Required |
|---|---|---|
| user-profile | A User Profile indicator. | Required |
Context Output
| Path | Type | Description |
|---|---|---|
| IAM.Vendor.active | Boolean | When true, indicates that the employee’s status is active in the 3rd-party integration. |
| IAM.Vendor.brand | String | Name of the integration. |
| IAM.Vendor.details | string | Provides the raw data from the 3rd-party integration. |
| IAM.Vendor.email | String | The employee’s email address. |
| IAM.Vendor.errorCode | Number | HTTP error response code. |
| IAM.Vendor.errorMessage | String | Reason why the API failed. |
| IAM.Vendor.id | String | The employee’s user ID in the app. |
| IAM.Vendor.instanceName | string | Name of the integration instance. |
| IAM.Vendor.success | Boolean | When true, indicates that the command was executed successfully. |
| IAM.Vendor.username | String | The employee’s username in the app. |
Command Example
!iam-disable-user user-profile={"username": "test"}
Context Example
{
"IAM": {
"UserProfile": {
"username": "test"
},
"Vendor": {
"action": "disable",
"active": false,
"brand": "AWS-ILM",
"details": {
"active": false,
"displayName": "test",
"emails": [
{
"primary": true,
"type": "work",
"value": "john.doe@example.com"
}
],
"id": "123456",
"meta": {
"created": "2021-08-23T12:53:51Z",
"lastModified": "2021-08-23T12:53:57Z",
"resourceType": "User"
},
"name": {
"familyName": "test",
"givenName": "test"
},
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:User"
],
"userName": "test"
},
"email": null,
"errorCode": null,
"errorMessage": "",
"id": "123456",
"instanceName": "AWS-ILM_instance_1",
"reason": "",
"skipped": false,
"success": true,
"username": "test"
}
}
}
Human Readable Output
Disable User Results (AWS-ILM)
brand instanceName success active id username details AWS-ILM AWS-ILM_instance_1 true false 123456 test id: 123456
meta: {“resourceType”: “User”, “created”: “2021-08-23T12:53:51Z”, “lastModified”: “2021-08-23T12:53:57Z”}
schemas: urn:ietf:params:scim:schemas:core:2.0:User
userName: test
name: {“familyName”: “test”, “givenName”: “test”}
displayName: test
active: false
emails: {‘value’: ‘john.doe@example.com’, ‘type’: ‘work’, ‘primary’: True}
iam-get-group
Retrieves a group
Base Command
iam-get-group
Input
| Argument Name | Description | Required |
|---|---|---|
| scim | SCIM content in JSON format. | Required |
Context Output
| Path | Type | Description |
|---|---|---|
| GetGroup.id | String | Group ID. |
| GetGroup.displayName | String | Display name of the group. |
| GetGroup.members.display | String | Display name of the group member. |
| GetGroup.members.value | String | ID of the group member. |
| GetGroup.success | Boolean | Success status of the command. |
| GetGroup.errorCode | Number | Error code if there is a failure. |
| GetGroup.errorMessage | Unknown | Error details if there is a failure. |
Command Example
!iam-get-group scim={"id": "121212"}
Context Example
{
"GetGroup": {
"active": null,
"brand": "AWS-ILM",
"details": {
"displayName": "The best group",
"id": "121212",
"members": [],
"meta": {
"created": "2021-08-23T12:41:43Z",
"lastModified": "2021-08-23T12:41:43Z",
"resourceType": "Group"
},
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:Group"
]
},
"displayName": "The best group",
"email": null,
"errorCode": null,
"errorMessage": null,
"id": "121212",
"instanceName": "AWS-ILM_instance_1",
"members": null,
"success": true,
"username": null
}
}
Human Readable Output
AWS Get Group
brand details displayName id instanceName success AWS-ILM id: 121212
meta: {“resourceType”: “Group”, “created”: “2021-08-23T12:41:43Z”, “lastModified”: “2021-08-23T12:41:43Z”}
schemas: urn:ietf:params:scim:schemas:core:2.0:Group
displayName: The best group
members:The best group 121212 AWS-ILM_instance_1 true
iam-create-group
Creates an empty group
Base Command
iam-create-group
Input
| Argument Name | Description | Required |
|---|---|---|
| scim | Group SCIM data with the display name. | Required |
Context Output
| Path | Type | Description |
|---|---|---|
| CreateGroup.id | String | Group ID. |
| CreateGroup.displayName | String | Display name of the group. |
| CreateGroup.success | Boolean | Success status of the command. |
| CreateGroup.errorCode | Number | Error code if there is a failure. |
| CreateGroup.errorMessage | Unknown | Error details if there is a failure. |
Command Example
!iam-create-group scim={"displayName": "The group"}
Context Example
{
"CreateGroup": {
"active": null,
"brand": "AWS-ILM",
"details": {
"displayName": "The group",
"id": "111111",
"members": [],
"meta": {
"created": "2021-08-23T12:54:02Z",
"lastModified": "2021-08-23T12:54:02Z",
"resourceType": "Group"
},
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:Group"
]
},
"displayName": "The group",
"email": null,
"errorCode": null,
"errorMessage": null,
"id": "111111",
"instanceName": "AWS-ILM_instance_1",
"members": null,
"success": true,
"username": null
}
}
Human Readable Output
AWS Create Group
brand details displayName id instanceName success AWS-ILM id: 111111
meta: {“resourceType”: “Group”, “created”: “2021-08-23T12:54:02Z”, “lastModified”: “2021-08-23T12:54:02Z”}
schemas: urn:ietf:params:scim:schemas:core:2.0:Group
displayName: The group
members:The group 111111 AWS-ILM_instance_1 true
iam-update-group
Updates an existing group resource. This command allows individual (or groups of) users to be added or removed from the group with a single operation. A maximum of 100 users can be modified in a single call.
Base Command
iam-update-group
Input
| Argument Name | Description | Required |
|---|---|---|
| scim | Group SCIM data. | Required |
| memberIdsToAdd | List of members IDs to add. A maximum of 100 users per call can be modified using this command. Possible values are: Comma-separated optional values. | Optional |
| memberIdsToDelete | List of members IDs to be deleted from the group. A maximum of 100 users per call can be modified using this command. Possible values are: Comma-separated optional values. | Optional |
Context Output
| Path | Type | Description |
|---|---|---|
| UpdateGroup.id | String | Group ID. |
| UpdateGroup.displayName | String | Display name of the group. |
| UpdateGroup.success | Boolean | Success status of the commands. |
| UpdateGroup.errorCode | Number | Error code if there is a failure. |
| UpdateGroup.errorMessage | Unknown | Error details if there is a failure. |
Command Example
!iam-update-group scim={"id": "121212"} memberIdsToAdd=["123456"]
Context Example
{
"UpdateGroup": {
"active": null,
"brand": "AWS-ILM",
"details": "{'Date': 'Mon, 23 Aug 2021 12:54:08 GMT', 'Content-Type': 'application/json', 'Connection': 'keep-alive', 'x-amzn-RequestId': '123456'}",
"displayName": null,
"email": null,
"errorCode": null,
"errorMessage": null,
"id": "121212",
"instanceName": "AWS-ILM_instance_1",
"members": null,
"success": true,
"username": null
}
}
Human Readable Output
AWS Update Group
brand details id instanceName success AWS-ILM {‘Date’: ‘Mon, 23 Aug 2021 12:54:08 GMT’, ‘Content-Type’: ‘application/json’, ‘Connection’: ‘keep-alive’, ‘x-amzn-RequestId’: ‘123456’} 121212 AWS-ILM_instance_1 true
iam-delete-group
Permanently removes a group.
Base Command
iam-delete-group
Input
| Argument Name | Description | Required |
|---|---|---|
| scim | Group SCIM with ID. | Required |
Context Output
| Path | Type | Description |
|---|---|---|
| DeleteGroup.id | String | Group ID. |
| DeleteGroup.displayName | String | Display name of the group. |
| DeleteGroup.success | Boolean | Success status of the commands |
| DeleteGroup.errorCode | Number | Error code if there is a failure. |
| DeleteGroup.errorMessage | Unknown | Error details if there is failure. |
Command Example
!iam-delete-group scim={"id": "121212"}
Context Example
{
"DeleteGroup": {
"active": null,
"brand": "AWS-ILM",
"details": "{'Date': 'Mon, 23 Aug 2021 12:54:11 GMT', 'Content-Type': 'application/json', 'Connection': 'keep-alive', 'x-amzn-RequestId': '123456'}",
"displayName": null,
"email": null,
"errorCode": null,
"errorMessage": null,
"id": "121212",
"instanceName": "AWS-ILM_instance_1",
"members": null,
"success": true,
"username": null
}
}
Human Readable Output
AWS Delete Group
brand details id instanceName success AWS-ILM {‘Date’: ‘Mon, 23 Aug 2021 12:54:11 GMT’, ‘Content-Type’: ‘application/json’, ‘Connection’: ‘keep-alive’, ‘x-amzn-RequestId’: ‘123456’} 121212 AWS-ILM_instance_1 true
Configuration parameters
url— Base URL (required)credentials— Tenant IDtenant_id— Tenant IDauthentication_token— Authentication Tokencreate_user_enabled— Allow creating usersupdate_user_enabled— Allow updating usersenable_user_enabled— Allow enabling usersdisable_user_enabled— Allow disabling userscreate_if_not_exists— Automatically create user if not found in update commandmapper_in— Incoming Mapper (required)mapper_out— Outgoing Mapperinsecure— Trust any certificate (not secure)proxy— Use system proxy settings
Commands (9)
-
get-mapping-fieldsRetrieves a User Profile schema, which holds all of the user fields within the application. Used for outgoing-mapping through the Get Schema option.
-
iam-create-groupCreates an empty group.
-
iam-create-userCreates a user.
-
iam-delete-groupPermanently removes a group.
-
iam-disable-userDisable an active user.
-
iam-get-groupRetrieves a group.
-
iam-get-userRetrieves a single user resource.
-
iam-update-groupUpdates an existing group resource. This command allows individual (or groups of) users to be added or removed from the group with a single operation. A maximum of 100 users can be modified in a single call.
-
iam-update-userUpdates an existing user with the data passed in the user-profile argument.
import traceback import demistomock as demisto import urllib3 from CommonServerPython import * from requests import Response # Disable insecure warnings urllib3.disable_warnings() """ CONSTANTS """ userUri = "/scim/v2/Users/" groupUri = "/scim/v2/Groups/" patchSchema = "urn:ietf:params:scim:api:messages:2.0:PatchOp" ERROR_CODES_TO_SKIP = [404] SUPPORTED_GET_USER_IAM_ATTRIBUTES = ["id", "userName"] AWS_DEFAULT_SCHEMA_MAPPING = { "id": "id", "userName": "userName", "name": { "formatted": "formatted", "familyName": "familyName", "givenName": "givenName", "middleName": "middleName", "honorificPrefix": "honorificPrefix", "honorificSuffix": "honorificSuffix", }, "displayName": "displayName", "nickName": "nickName", "profileUrl": "profileUrl", "title": "title", "userType": "userType", "preferredLanguage": "preferredLanguage", "locale": "locale", "timezone": "timezone", "active": "active", "password": "password", "emails": [{"type": "type", "value": "value", "primary": "primary"}], "phoneNumbers": [{"type": "type", "value": "value"}], "addresses": [ { "formatted": "formatted", "streetAddress": "streetAddress", "locality": "locality", "region": "region", "postalCode": "postalCode", "Country": "Country", } ], "groups": ["group"], "roles": ["role"], } def build_body_request_for_update_user(old_user_data, new_user_data): operations = [] for key, value in new_user_data.items(): operation = { "op": "replace" if key in old_user_data else "add", "path": key, "value": [value] if key in ("emails", "phoneNumbers") and not isinstance(value, list) else value, } operations.append(operation) data = { "schemas": [patchSchema], "Operations": operations, } return data """CLIENT CLASS""" class Client(BaseClient): """A client class that implements logic to authenticate with the application.""" def test(self): """Tests connectivity with the application.""" self._http_request(method="GET", url_suffix=userUri) def get_user(self, iam_attribute: str, iam_attribute_val: str) -> Optional["IAMUserAppData"]: """Queries the user in the application using REST API by its email, and returns an IAMUserAppData object that holds the user_id, username, is_active and app_data attributes given in the query response. :type iam_attribute: ``str`` :param iam_attribute: The IAM attribute. :type iam_attribute_val: ``str`` :param iam_attribute_val: Value of the given IAM attribute. :return: An IAMUserAppData object if user exists, None otherwise. :rtype: ``Optional[IAMUserAppData]`` """ params = {"filter": f'userName eq "{iam_attribute_val}"'} if iam_attribute == "userName" else None url_suffix: str = f"{userUri}{iam_attribute_val}" if iam_attribute == "id" else userUri res = self._http_request(method="GET", url_suffix=url_suffix, params=params) user_app_data = None if res.get("totalResults", 0) > 0: user_app_data = res.get("Resources")[0] elif iam_attribute == "id": user_app_data = res if user_app_data: user_id = user_app_data.get("id") username = user_app_data.get("userName") is_active = user_app_data.get("active") return IAMUserAppData( user_id, username, is_active, user_app_data, email=get_first_primary_email_by_scim_schema(user_app_data) ) return None def create_user(self, user_data: Dict[str, Any]) -> "IAMUserAppData": """Creates a user in the application using REST API. :type user_data: ``Dict[str, Any]`` :param user_data: User data in the application format :return: An IAMUserAppData object that contains the data of the created user in the application. :rtype: ``IAMUserAppData`` """ if not isinstance(user_data.get("emails"), list): user_data["emails"] = [user_data.get("emails")] if not isinstance(user_data.get("phoneNumbers"), list): user_data["phoneNumbers"] = [user_data.get("phoneNumbers")] user_data["active"] = True res = self._http_request( method="POST", url_suffix=userUri, json_data=user_data, ) user_id = res.get("id") is_active = res.get("active") username = res.get("userName") return IAMUserAppData(user_id, username, is_active, res, email=get_first_primary_email_by_scim_schema(res)) def update_user(self, user_id: str, new_user_data: Dict[str, Any]) -> "IAMUserAppData": """Updates a user in the application using REST API. :type user_id: ``str`` :param user_id: ID of the user in the application :type new_user_data: ``Dict[str, Any]`` :param new_user_data: New user data in the application format :return: An IAMUserAppData object that contains the data of the updated user in the application. :rtype: ``IAMUserAppData`` """ old_user_data = self._http_request( method="GET", url_suffix=userUri + user_id, ) res = self._http_request( method="PATCH", url_suffix=userUri + user_id, json_data=build_body_request_for_update_user(old_user_data, new_user_data), ) is_active = res.get("active") username = res.get("userName") return IAMUserAppData(user_id, username, is_active, res, email=get_first_primary_email_by_scim_schema(res)) def enable_user(self, user_id: str) -> "IAMUserAppData": """Enables a user in the application using REST API. :type user_id: ``str`` :param user_id: ID of the user in the application :return: An IAMUserAppData object that contains the data of the user in the application. :rtype: ``IAMUserAppData`` """ user_data = { "schemas": [patchSchema], "Operations": [ { "op": "replace", "path": "active", "value": "true", } ], } res = self._http_request( method="PATCH", url_suffix=userUri + user_id, json_data=user_data, ) user_id = res.get("id") is_active = res.get("active") username = res.get("userName") return IAMUserAppData(user_id, username, is_active, res, email=get_first_primary_email_by_scim_schema(res)) def disable_user(self, user_id: str) -> "IAMUserAppData": """Disables a user in the application using REST API. :type user_id: ``str`` :param user_id: ID of the user in the application :return: An IAMUserAppData object that contains the data of the user in the application. :rtype: ``IAMUserAppData`` """ user_data = { "schemas": [patchSchema], "Operations": [ { "op": "replace", "path": "active", "value": "false", } ], } res = self._http_request( method="PATCH", url_suffix=userUri + user_id, json_data=user_data, ) user_id = res.get("id") is_active = res.get("active") username = res.get("userName") return IAMUserAppData(user_id, username, is_active, res, email=get_first_primary_email_by_scim_schema(res)) def get_group_by_id(self, group_id): return self._http_request( method="GET", url_suffix=groupUri + group_id, resp_type="response", ) def search_group(self, group_name): params = {"filter": f'displayName eq "{group_name}"'} return self._http_request( method="GET", url_suffix=groupUri, params=params, resp_type="response", ) def create_group(self, data): return self._http_request( method="POST", url_suffix=groupUri, json_data=data, resp_type="response", ok_codes=(200, 201, 409) ) def update_group(self, group_id, data): return self._http_request( method="PATCH", url_suffix=groupUri + group_id, json_data=data, resp_type="response", ) def delete_group(self, group_id): return self._http_request( method="DELETE", url_suffix=groupUri + group_id, resp_type="response", ) @staticmethod def handle_exception(user_profile, e, action): """Handles failed responses from the application API by setting the User Profile object with the result. The result entity should contain the following data: 1. action (``IAMActions``) The failed action Required 2. success (``bool``) The success status Optional (by default, True) 3. skip (``bool``) Whether or not the command was skipped Optional (by default, False) 3. skip_reason (``str``) Skip reason Optional (by default, None) 4. error_code (``Union[str, int]``) HTTP error code Optional (by default, None) 5. error_message (``str``) The error description Optional (by default, None) Note: This is the place to determine how to handle specific edge cases from the API, e.g., when a DISABLE action was made on a user which is already disabled and therefore we can't perform another DISABLE action. :type user_profile: ``IAMUserProfile`` :param user_profile: The user profile object :type e: ``Union[DemistoException, Exception]`` :param e: The exception object - if type is DemistoException, holds the response json object (`res` attribute) :type action: ``IAMActions`` :param action: An enum represents the current action (GET, UPDATE, CREATE, DISABLE or ENABLE) """ if isinstance(e, DemistoException) and e.res is not None: error_code = e.res.status_code if action == IAMActions.DISABLE_USER and error_code in ERROR_CODES_TO_SKIP: skip_message = "Users is already disabled or does not exist in the system." user_profile.set_result(action=action, skip=True, skip_reason=skip_message) try: resp = e.res.json() error_message = get_error_details(resp) except ValueError: error_message = str(e) else: error_code = "" error_message = str(e) user_profile.set_result( action=action, success=False, error_code=error_code, error_message=f"{error_message}\n{traceback.format_exc()}" ) demisto.error(traceback.format_exc()) """HELPER FUNCTIONS""" def get_error_details(res: Dict[str, Any]) -> str: """Parses the error details retrieved from the application and outputs the resulted string. :type res: ``Dict[str, Any]`` :param res: The error data retrieved from the application. :return: The parsed error details. :rtype: ``str`` """ details = str(res.get("detail")) return details class OutputContext: """ Class to build a generic output and context. """ def __init__( self, success=None, active=None, id=None, iden=None, username=None, email=None, errorCode=None, errorMessage=None, details=None, displayName=None, members=None, ): self.instanceName = demisto.callingContext.get("context", {}).get("IntegrationInstance") self.brand = demisto.callingContext.get("context", {}).get("IntegrationBrand") self.command = demisto.command().replace("-", "_").title().replace("_", "").replace("Iam", "") self.success = success self.active = active self.id = id self.iden = iden self.username = username self.email = email self.errorCode = errorCode self.errorMessage = errorMessage self.details = details self.displayName = displayName # Used in group self.members = members # Used in group self.data = { "brand": self.brand, "instanceName": self.instanceName, "success": success, "active": active, "id": iden, "username": username, "email": email, "errorCode": errorCode, "errorMessage": errorMessage, "details": details, "displayName": displayName, "members": members, } """COMMAND FUNCTIONS""" def test_module(client: Client): """Tests connectivity with the client.""" client.test() return_results("ok") def get_group_command(client, args): scim = safe_load_json(args.get("scim")) group_id = scim.get("id") group_name = scim.get("displayName") if not (group_id or group_name): raise Exception('You must supply either "id" or "displayName" in the scim data') if not group_id: try: res = client.search_group(group_name) res_json = res.json() if res.status_code == 200: if res_json.get("totalResults") == 0: generic_iam_context = OutputContext( success=False, displayName=group_name, errorCode=404, errorMessage="Group Not Found", details=res_json ) else: group_id = res_json["Resources"][0].get("id") group_name = res_json["Resources"][0].get("displayName") generic_iam_context = OutputContext( success=True, iden=group_id, displayName=group_name, details=res_json["Resources"][0] ) except DemistoException as exc: generic_iam_context = OutputContext( success=False, displayName=group_name, iden=group_id, errorCode=exc.res.status_code, errorMessage=exc.message, details=str(exc), ) else: try: res = client.get_group_by_id(group_id) res_json = res.json() if res.status_code == 200: generic_iam_context = OutputContext( success=True, iden=res_json.get("id"), displayName=res_json.get("displayName"), details=res_json ) except DemistoException as exc: if exc.res.status_code == 404: generic_iam_context = OutputContext( success=False, iden=group_id, displayName=group_name, errorCode=404, errorMessage="Group Not Found", details=str(exc), ) else: generic_iam_context = OutputContext( success=False, iden=group_id, displayName=group_name, errorCode=exc.res.status_code, errorMessage=exc.message, details=str(exc), ) readable_output = tableToMarkdown("AWS Get Group:", generic_iam_context.data, removeNull=True) return CommandResults( raw_response=generic_iam_context.data, outputs_prefix=generic_iam_context.command, outputs_key_field="id", outputs=generic_iam_context.data, readable_output=readable_output, ) def create_group_command(client, args): scim = safe_load_json(args.get("scim")) group_name = scim.get("displayName") if not group_name: raise Exception('You must supply "displayName" of the group in the scim data') res = client.create_group(scim) res_json = res.json() if res.status_code == 201: generic_iam_context = OutputContext( success=True, iden=res_json.get("id"), displayName=res_json.get("displayName"), details=res_json ) else: res_json = res.json() generic_iam_context = OutputContext( success=False, displayName=group_name, errorCode=res_json.get("code"), errorMessage=res_json.get("message"), details=res_json, ) readable_output = tableToMarkdown("AWS Create Group:", generic_iam_context.data, removeNull=True) return CommandResults( raw_response=generic_iam_context.data, outputs_prefix=generic_iam_context.command, outputs_key_field="id", outputs=generic_iam_context.data, readable_output=readable_output, ) def update_group_command(client, args): res = Response() scim = safe_load_json(args.get("scim")) group_id = scim.get("id") group_name = scim.get("displayName") if not group_id: raise Exception('You must supply "id" in the scim data') member_ids_to_add = args.get("memberIdsToAdd") member_ids_to_delete = args.get("memberIdsToDelete") if member_ids_to_add is member_ids_to_delete is None: raise Exception('You must supply either "memberIdsToAdd" or "memberIdsToDelete" in the arguments') if member_ids_to_add: if not isinstance(member_ids_to_add, list): member_ids_to_add = safe_load_json(member_ids_to_add) for member_id in member_ids_to_add: operation = {"op": "add", "path": "members", "value": [{"value": member_id}]} group_input = {"schemas": [patchSchema], "Operations": [operation]} try: res = client.update_group(group_id, group_input) except DemistoException as exc: generic_iam_context = OutputContext( success=False, displayName=group_name, iden=member_id, errorCode=exc.res.status_code, errorMessage=exc.message, details=str(exc), ) readable_output = tableToMarkdown("AWS Update Group:", generic_iam_context.data, removeNull=True) return CommandResults( raw_response=generic_iam_context.data, outputs_prefix=generic_iam_context.command, outputs_key_field="id", outputs=generic_iam_context.data, readable_output=readable_output, ) if member_ids_to_delete: if not isinstance(member_ids_to_delete, list): member_ids_to_delete = safe_load_json(member_ids_to_delete) for member_id in member_ids_to_delete: operation = {"op": "remove", "path": "members", "value": [{"value": member_id}]} group_input = {"schemas": [patchSchema], "Operations": [operation]} try: res = client.update_group(group_id, group_input) except DemistoException as exc: generic_iam_context = OutputContext( success=False, iden=member_id, displayName=group_name, errorCode=exc.res.status_code, errorMessage=exc.message, details=str(exc), ) readable_output = tableToMarkdown("AWS Update Group:", generic_iam_context.data, removeNull=True) return CommandResults( raw_response=generic_iam_context.data, outputs_prefix=generic_iam_context.command, outputs_key_field="id", outputs=generic_iam_context.data, readable_output=readable_output, ) if res.status_code == 204: res_json = res.headers generic_iam_context = OutputContext(success=True, iden=group_id, displayName=group_name, details=str(res_json)) readable_output = tableToMarkdown("AWS Update Group:", generic_iam_context.data, removeNull=True) return CommandResults( raw_response=generic_iam_context.data, outputs_prefix=generic_iam_context.command, outputs_key_field="id", outputs=generic_iam_context.data, readable_output=readable_output, ) def delete_group_command(client, args): scim = safe_load_json(args.get("scim")) group_id = scim.get("id") group_name = scim.get("displayName") if not group_id: raise Exception("The group id needs to be provided.") try: res = client.delete_group(group_id) res_json = res.headers generic_iam_context = OutputContext(success=True, iden=group_id, displayName=group_name, details=str(res_json)) except DemistoException as exc: if exc.res.status_code == 404: generic_iam_context = OutputContext( success=False, iden=group_id, displayName=group_name, errorCode=404, errorMessage="Group Not Found", details=str(exc), ) else: generic_iam_context = OutputContext( success=False, iden=group_id, displayName=group_name, errorCode=exc.res.status_code, errorMessage=exc.message, details=str(exc), ) readable_output = tableToMarkdown("AWS Delete Group:", generic_iam_context.data, removeNull=True) return CommandResults( raw_response=generic_iam_context.data, outputs_prefix=generic_iam_context.command, outputs_key_field="id", outputs=generic_iam_context.data, readable_output=readable_output, ) def get_mapping_fields() -> GetMappingFieldsResponse: """Creates and returns a GetMappingFieldsResponse object of the user schema in the application :return: (GetMappingFieldsResponse) An object that represents the user schema """ incident_type_scheme = SchemeTypeMapping(type_name=IAMUserProfile.DEFAULT_INCIDENT_TYPE, fields=AWS_DEFAULT_SCHEMA_MAPPING) return GetMappingFieldsResponse([incident_type_scheme]) def main(): user_profile = None params = demisto.params() base_url = params["url"].strip("/") tenant_id = params.get("credentials", {}).get("identifier") or params.get("tenant_id") url_with_tenant = f"{base_url}/{tenant_id}" authentication_token = params.get("credentials", {}).get("password") or params.get("authentication_token") mapper_in = params.get("mapper_in") mapper_out = params.get("mapper_out") verify_certificate = not params.get("insecure", False) proxy = params.get("proxy", False) command = demisto.command() args = demisto.args() is_create_enabled = params.get("create_user_enabled") is_enable_enabled = params.get("enable_user_enabled") is_disable_enabled = params.get("disable_user_enabled") is_update_enabled = params.get("update_user_enabled") create_if_not_exists = params.get("create_if_not_exists") iam_command = IAMCommand( is_create_enabled, is_enable_enabled, is_disable_enabled, is_update_enabled, create_if_not_exists, mapper_in, mapper_out, get_user_iam_attrs=SUPPORTED_GET_USER_IAM_ATTRIBUTES, ) headers = { "Content-Type": "application/json", "Accept": "application/json", "Authorization": f"Bearer {authentication_token}", } client = Client( base_url=url_with_tenant, verify=verify_certificate, proxy=proxy, headers=headers, ok_codes=(200, 201, 204), ) demisto.debug(f"Command being called is {command}") """CRUD commands""" if command == "iam-get-user": user_profile = iam_command.get_user(client, args) elif command == "iam-create-user": user_profile = iam_command.create_user(client, args) elif command == "iam-update-user": user_profile = iam_command.update_user(client, args) elif command == "iam-disable-user": user_profile = iam_command.disable_user(client, args) """non-CRUD commands""" if user_profile: return_results(user_profile) try: if command == "test-module": test_module(client) elif command == "iam-get-group": return_results(get_group_command(client, args)) elif command == "iam-create-group": return_results(create_group_command(client, args)) elif command == "iam-update-group": return_results(update_group_command(client, args)) elif command == "iam-delete-group": return_results(delete_group_command(client, args)) elif command == "get-mapping-fields": return_results(get_mapping_fields()) except Exception as exc: # For any other integration command exception, return an error return_error(f"Failed to execute {command} command. Error:\n{exc}", error=exc) from IAMApiModule import * # noqa E402 if __name__ in ("__main__", "__builtin__", "builtins"): # pragma: no cover main()