@credal/actions 0.2.3 → 0.2.5

package/dist/actions/autogen/templates.js

@@ -5919,6 +5919,894 @@ export const googlemailListGmailThreadsDefinition = {
     name: "listGmailThreads",
     provider: "googlemail",
 };
+export const oktaGetOktaUserDefinition = {
+    description: "Retrieve details of a specific Okta user by their ID.",
+    scopes: ["okta.users.read"],
+    parameters: {
+        type: "object",
+        required: ["userId"],
+        properties: {
+            userId: {
+                type: "string",
+                description: "The ID of the user to retrieve.",
+            },
+        },
+    },
+    output: {
+        type: "object",
+        required: ["success"],
+        properties: {
+            success: {
+                type: "boolean",
+                description: "Whether the user details were successfully retrieved.",
+            },
+            user: {
+                type: "object",
+                required: ["id"],
+                properties: {
+                    id: {
+                        type: "string",
+                        description: "The user's Okta ID",
+                    },
+                    status: {
+                        type: "string",
+                        description: "The user's status",
+                    },
+                    created: {
+                        type: "string",
+                        description: "The timestamp when the user was created",
+                    },
+                    activated: {
+                        type: "string",
+                        description: "The timestamp when the user was activated",
+                    },
+                    statusChanged: {
+                        type: "string",
+                        description: "The timestamp when the user's status changed",
+                    },
+                    lastLogin: {
+                        type: "string",
+                        description: "The timestamp of the user's last login",
+                    },
+                    lastUpdated: {
+                        type: "string",
+                        description: "The timestamp of the user's last update",
+                    },
+                    passwordChanged: {
+                        type: "string",
+                        description: "The timestamp when the user's password was last changed",
+                    },
+                    profile: {
+                        type: "object",
+                        description: "The user's profile information",
+                        properties: {
+                            login: {
+                                type: "string",
+                                description: "The user's login",
+                            },
+                            firstName: {
+                                type: "string",
+                                description: "The user's first name",
+                            },
+                            lastName: {
+                                type: "string",
+                                description: "The user's last name",
+                            },
+                            nickName: {
+                                type: "string",
+                                description: "The user's nickname",
+                            },
+                            displayName: {
+                                type: "string",
+                                description: "The user's display name",
+                            },
+                            email: {
+                                type: "string",
+                                description: "The user's email address",
+                            },
+                            secondEmail: {
+                                type: "string",
+                                description: "The user's secondary email address",
+                            },
+                            profileUrl: {
+                                type: "string",
+                                description: "The URL to the user's profile",
+                            },
+                            preferredLanguage: {
+                                type: "string",
+                                description: "The user's preferred language",
+                            },
+                            userType: {
+                                type: "string",
+                                description: "The user's type",
+                            },
+                            organization: {
+                                type: "string",
+                                description: "The user's organization",
+                            },
+                            title: {
+                                type: "string",
+                                description: "The user's title",
+                            },
+                            division: {
+                                type: "string",
+                                description: "The user's division",
+                            },
+                            department: {
+                                type: "string",
+                                description: "The user's department",
+                            },
+                            costCenter: {
+                                type: "string",
+                                description: "The user's cost center",
+                            },
+                            employeeNumber: {
+                                type: "string",
+                                description: "The user's employee number",
+                            },
+                            mobilePhone: {
+                                type: "string",
+                                description: "The user's mobile phone number",
+                            },
+                            primaryPhone: {
+                                type: "string",
+                                description: "The user's primary phone number",
+                            },
+                            streetAddress: {
+                                type: "string",
+                                description: "The user's street address",
+                            },
+                            city: {
+                                type: "string",
+                                description: "The user's city",
+                            },
+                            state: {
+                                type: "string",
+                                description: "The user's state",
+                            },
+                            zipCode: {
+                                type: "string",
+                                description: "The user's zip code",
+                            },
+                            countryCode: {
+                                type: "string",
+                                description: "The user's country code",
+                            },
+                        },
+                    },
+                    credentials: {
+                        type: "object",
+                        description: "The user's credentials",
+                    },
+                    _links: {
+                        type: "object",
+                        description: "Links related to the user",
+                    },
+                },
+            },
+            error: {
+                type: "string",
+                description: "Error message if retrieval failed.",
+            },
+        },
+    },
+    name: "getOktaUser",
+    provider: "okta",
+};
+export const oktaListOktaUserGroupsDefinition = {
+    description: "List all groups a specific Okta user belongs to.",
+    scopes: ["okta.groups.read", "okta.users.read"],
+    parameters: {
+        type: "object",
+        required: ["userId"],
+        properties: {
+            userId: {
+                type: "string",
+                description: "The ID of the user whose groups are to be listed.",
+            },
+            maxResults: {
+                type: "integer",
+                description: "The maximum number of results to return.",
+                minimum: 1,
+            },
+        },
+    },
+    output: {
+        type: "object",
+        required: ["success"],
+        properties: {
+            success: {
+                type: "boolean",
+                description: "Whether the groups were successfully retrieved.",
+            },
+            groups: {
+                type: "array",
+                description: "List of groups the user belongs to.",
+                items: {
+                    type: "object",
+                    required: ["id", "profile"],
+                    properties: {
+                        id: {
+                            type: "string",
+                            description: "The group's ID.",
+                        },
+                        profile: {
+                            type: "object",
+                            required: ["name", "description"],
+                            properties: {
+                                name: {
+                                    type: "string",
+                                    description: "The group's name.",
+                                },
+                                description: {
+                                    type: "string",
+                                    description: "The group's description.",
+                                },
+                            },
+                        },
+                    },
+                },
+            },
+            error: {
+                type: "string",
+                description: "Error message if retrieval failed.",
+            },
+        },
+    },
+    name: "listOktaUserGroups",
+    provider: "okta",
+};
+export const oktaListOktaGroupsDefinition = {
+    description: "List all groups in Okta.",
+    scopes: ["okta.groups.read"],
+    parameters: {
+        type: "object",
+        required: [],
+        properties: {
+            searchQuery: {
+                type: "string",
+                description: "Optional search query to filter groups.\nThis field corresponds to the `search` query parameter in the Okta API's List Groups operation.\nFor detailed information on constructing search queries and available filter expressions, refer to the Okta API documentation:\nhttps://developer.okta.com/docs/api/openapi/okta-management/management/tag/Group/#tag/Group/operation/listGroups!in=query&path=search&t=request\nExample: 'profile.name eq \"My Group\"'\n",
+            },
+            maxResults: {
+                type: "integer",
+                description: "The maximum number of results to return.",
+                minimum: 1,
+            },
+        },
+    },
+    output: {
+        type: "object",
+        required: ["success"],
+        properties: {
+            success: {
+                type: "boolean",
+                description: "Whether the groups were successfully retrieved.",
+            },
+            groups: {
+                type: "array",
+                description: "List of Okta groups.",
+                items: {
+                    type: "object",
+                    required: ["id", "profile"],
+                    properties: {
+                        id: {
+                            type: "string",
+                            description: "The group's ID.",
+                        },
+                        profile: {
+                            type: "object",
+                            required: ["name", "description"],
+                            properties: {
+                                name: {
+                                    type: "string",
+                                    description: "The group's name.",
+                                },
+                                description: {
+                                    type: "string",
+                                    description: "The group's description.",
+                                },
+                            },
+                        },
+                    },
+                },
+            },
+            error: {
+                type: "string",
+                description: "Error message if retrieval failed.",
+            },
+        },
+    },
+    name: "listOktaGroups",
+    provider: "okta",
+};
+export const oktaGetOktaGroupDefinition = {
+    description: "Retrieve details of a specific Okta group by its ID.",
+    scopes: ["okta.groups.read"],
+    parameters: {
+        type: "object",
+        required: ["groupId"],
+        properties: {
+            groupId: {
+                type: "string",
+                description: "The ID of the group to retrieve.",
+            },
+        },
+    },
+    output: {
+        type: "object",
+        required: ["success"],
+        properties: {
+            success: {
+                type: "boolean",
+                description: "Whether the group details were successfully retrieved.",
+            },
+            group: {
+                description: "Schema for an Okta group object",
+                type: "object",
+                required: ["id", "profile"],
+                properties: {
+                    id: {
+                        type: "string",
+                        description: "The unique identifier for the Okta group",
+                    },
+                    created: {
+                        type: "string",
+                        format: "date-time",
+                        description: "The timestamp when the group was created",
+                    },
+                    lastUpdated: {
+                        type: "string",
+                        format: "date-time",
+                        description: "The timestamp when the group was last updated",
+                    },
+                    lastMembershipUpdated: {
+                        type: "string",
+                        format: "date-time",
+                        description: "The timestamp when the group's membership was last updated",
+                    },
+                    objectClass: {
+                        type: "array",
+                        items: {
+                            type: "string",
+                        },
+                        description: "The object class of the group",
+                    },
+                    type: {
+                        type: "string",
+                        description: "The type of the group (e.g., OKTA_GROUP)",
+                    },
+                    profile: {
+                        type: "object",
+                        required: ["name", "description"],
+                        properties: {
+                            name: {
+                                type: "string",
+                                description: "The name of the group",
+                            },
+                            description: {
+                                type: "string",
+                                description: "The description of the group",
+                            },
+                        },
+                    },
+                    _links: {
+                        type: "object",
+                        properties: {
+                            logo: {
+                                type: "array",
+                                items: {
+                                    type: "object",
+                                },
+                                description: "Links to the group's logo",
+                            },
+                            users: {
+                                type: "object",
+                                properties: {
+                                    href: {
+                                        type: "string",
+                                        description: "The URL to retrieve users in the group",
+                                    },
+                                },
+                            },
+                            apps: {
+                                type: "object",
+                                properties: {
+                                    href: {
+                                        type: "string",
+                                        description: "The URL to retrieve apps associated with the group",
+                                    },
+                                },
+                            },
+                        },
+                    },
+                },
+            },
+            error: {
+                type: "string",
+                description: "Error message if retrieval failed.",
+            },
+        },
+    },
+    name: "getOktaGroup",
+    provider: "okta",
+};
+export const oktaListOktaGroupMembersDefinition = {
+    description: "List all members of a specific Okta group.",
+    scopes: ["okta.groups.read", "okta.users.read"],
+    parameters: {
+        type: "object",
+        required: ["groupId"],
+        properties: {
+            groupId: {
+                type: "string",
+                description: "The ID of the group whose members are to be listed.",
+            },
+            maxResults: {
+                type: "integer",
+                description: "The maximum number of results to return.",
+                minimum: 1,
+            },
+        },
+    },
+    output: {
+        type: "object",
+        required: ["success"],
+        properties: {
+            success: {
+                type: "boolean",
+                description: "Whether the members were successfully retrieved.",
+            },
+            members: {
+                type: "array",
+                description: "List of members in the group.",
+                items: {
+                    type: "object",
+                    properties: {
+                        id: {
+                            type: "string",
+                            description: "The user's ID.",
+                        },
+                        status: {
+                            type: "string",
+                            description: "The user's status.",
+                        },
+                        created: {
+                            type: "string",
+                            format: "date-time",
+                            description: "The timestamp when the user was created.",
+                        },
+                        activated: {
+                            type: "string",
+                            format: "date-time",
+                            nullable: true,
+                            description: "The timestamp when the user was activated.",
+                        },
+                        statusChanged: {
+                            type: "string",
+                            format: "date-time",
+                            nullable: true,
+                            description: "The timestamp when the user's status changed.",
+                        },
+                        lastLogin: {
+                            type: "string",
+                            format: "date-time",
+                            nullable: true,
+                            description: "The timestamp of the user's last login.",
+                        },
+                        lastUpdated: {
+                            type: "string",
+                            format: "date-time",
+                            description: "The timestamp of the user's last update.",
+                        },
+                        passwordChanged: {
+                            type: "string",
+                            format: "date-time",
+                            description: "The timestamp when the user's password was last changed.",
+                        },
+                        type: {
+                            type: "object",
+                            properties: {
+                                id: {
+                                    type: "string",
+                                    description: "The type ID of the user.",
+                                },
+                            },
+                        },
+                        profile: {
+                            type: "object",
+                            description: "The user's profile information.",
+                            properties: {
+                                firstName: {
+                                    type: "string",
+                                    description: "The user's first name.",
+                                },
+                                lastName: {
+                                    type: "string",
+                                    description: "The user's last name.",
+                                },
+                                mobilePhone: {
+                                    type: "string",
+                                    nullable: true,
+                                    description: "The user's mobile phone number.",
+                                },
+                                secondEmail: {
+                                    type: "string",
+                                    nullable: true,
+                                    description: "The user's secondary email address.",
+                                },
+                                login: {
+                                    type: "string",
+                                    description: "The user's login.",
+                                },
+                                email: {
+                                    type: "string",
+                                    description: "The user's email address.",
+                                },
+                            },
+                        },
+                    },
+                },
+            },
+            error: {
+                type: "string",
+                description: "Error message if retrieval failed.",
+            },
+        },
+    },
+    name: "listOktaGroupMembers",
+    provider: "okta",
+};
+export const oktaAddUserToGroupDefinition = {
+    description: "Add a user to a specific Okta group.",
+    scopes: ["okta.groups.manage", "okta.users.manage"],
+    parameters: {
+        type: "object",
+        required: ["groupId", "userId"],
+        properties: {
+            groupId: {
+                type: "string",
+                description: "The ID of the group to add the user to.",
+            },
+            userId: {
+                type: "string",
+                description: "The ID of the user to add to the group.",
+            },
+        },
+    },
+    output: {
+        type: "object",
+        required: ["success"],
+        properties: {
+            success: {
+                type: "boolean",
+                description: "Whether the user was successfully added to the group.",
+            },
+            error: {
+                type: "string",
+                description: "Error message if the operation failed.",
+            },
+        },
+    },
+    name: "addUserToGroup",
+    provider: "okta",
+};
+export const oktaRemoveUserFromGroupDefinition = {
+    description: "Remove a user from a specific Okta group.",
+    scopes: ["okta.groups.manage", "okta.users.manage"],
+    parameters: {
+        type: "object",
+        required: ["groupId", "userId"],
+        properties: {
+            groupId: {
+                type: "string",
+                description: "The ID of the group to remove the user from.",
+            },
+            userId: {
+                type: "string",
+                description: "The ID of the user to remove from the group.",
+            },
+        },
+    },
+    output: {
+        type: "object",
+        required: ["success"],
+        properties: {
+            success: {
+                type: "boolean",
+                description: "Whether the user was successfully removed from the group.",
+            },
+            error: {
+                type: "string",
+                description: "Error message if the operation failed.",
+            },
+        },
+    },
+    name: "removeUserFromGroup",
+    provider: "okta",
+};
+export const oktaListOktaUsersDefinition = {
+    description: "List Okta users, optionally filtering by a search query",
+    scopes: ["okta.users.read"],
+    parameters: {
+        type: "object",
+        required: [],
+        properties: {
+            searchQuery: {
+                type: "string",
+                description: "Optional search query to filter users.\nThis field corresponds to the `search` query parameter in the Okta API's List Users operation.\nFor detailed information on constructing search queries and available filter expressions, refer to the Okta API documentation:\nhttps://developer.okta.com/docs/api/openapi/okta-management/management/tag/User/#tag/User/operation/listUsers!in=query&path=search&t=request\nExample: 'profile.email eq \"my_user@example.com\"'\n",
+            },
+            maxResults: {
+                type: "integer",
+                description: "The maximum number of results to return.",
+                minimum: 1,
+            },
+        },
+    },
+    output: {
+        type: "object",
+        required: ["success"],
+        properties: {
+            success: {
+                type: "boolean",
+                description: "Whether the user list was successfully retrieved",
+            },
+            users: {
+                type: "array",
+                description: "List of Okta users matching the query",
+                items: {
+                    type: "object",
+                    required: ["id", "profile"],
+                    properties: {
+                        id: {
+                            type: "string",
+                            description: "The user's Okta ID",
+                        },
+                        status: {
+                            type: "string",
+                            description: "The user's status",
+                        },
+                        created: {
+                            type: "string",
+                            description: "The timestamp when the user was created",
+                        },
+                        activated: {
+                            type: "string",
+                            nullable: true,
+                            description: "The timestamp when the user was activated",
+                        },
+                        statusChanged: {
+                            type: "string",
+                            nullable: true,
+                            description: "The timestamp when the user's status changed",
+                        },
+                        lastLogin: {
+                            type: "string",
+                            nullable: true,
+                            description: "The timestamp of the user's last login",
+                        },
+                        lastUpdated: {
+                            type: "string",
+                            description: "The timestamp of the user's last update",
+                        },
+                        passwordChanged: {
+                            type: "string",
+                            description: "The timestamp when the user's password was last changed",
+                        },
+                        type: {
+                            type: "object",
+                            properties: {
+                                id: {
+                                    type: "string",
+                                    description: "The type ID of the user",
+                                },
+                            },
+                        },
+                        profile: {
+                            type: "object",
+                            properties: {
+                                firstName: {
+                                    type: "string",
+                                    description: "The user's first name",
+                                },
+                                lastName: {
+                                    type: "string",
+                                    description: "The user's last name",
+                                },
+                                mobilePhone: {
+                                    type: "string",
+                                    nullable: true,
+                                    description: "The user's mobile phone number",
+                                },
+                                secondEmail: {
+                                    type: "string",
+                                    nullable: true,
+                                    description: "The user's secondary email address",
+                                },
+                                login: {
+                                    type: "string",
+                                    description: "The user's login",
+                                },
+                                email: {
+                                    type: "string",
+                                    description: "The user's email address",
+                                },
+                            },
+                        },
+                        realmId: {
+                            type: "string",
+                            description: "The realm ID of the user",
+                        },
+                    },
+                },
+            },
+            error: {
+                type: "string",
+                description: "Error message if user retrieval failed",
+            },
+        },
+    },
+    name: "listOktaUsers",
+    provider: "okta",
+};
+export const oktaResetMFADefinition = {
+    description: "Reset or remove Okta MFA for a user, including issues with Okta Verify, fingerprint, or touch ID.",
+    scopes: ["okta.users.read", "okta.users.manage"],
+    parameters: {
+        type: "object",
+        required: ["userId"],
+        properties: {
+            userId: {
+                type: "string",
+                description: "The ID of the user whose MFA needs to be reset.",
+            },
+            factorId: {
+                type: "string",
+                description: "Optional. The ID of the specific factor to reset. If not provided, all factors will be reset.",
+            },
+        },
+    },
+    output: {
+        type: "object",
+        required: ["success"],
+        properties: {
+            success: {
+                type: "boolean",
+                description: "Whether the MFA reset was successful.",
+            },
+            error: {
+                type: "string",
+                description: "Error message if the MFA reset failed.",
+            },
+        },
+    },
+    name: "resetMFA",
+    provider: "okta",
+};
+export const oktaListMFADefinition = {
+    description: "List all MFA factors for a specific user in Okta.",
+    scopes: ["okta.users.read"],
+    parameters: {
+        type: "object",
+        required: ["userId"],
+        properties: {
+            userId: {
+                type: "string",
+                description: "The ID of the user whose MFA factors need to be listed.",
+            },
+        },
+    },
+    output: {
+        type: "object",
+        required: ["success"],
+        properties: {
+            success: {
+                type: "boolean",
+                description: "Whether the MFA factors were successfully retrieved.",
+            },
+            factors: {
+                type: "array",
+                description: "List of MFA factors for the user.",
+                items: {
+                    type: "object",
+                    required: ["id"],
+                    properties: {
+                        id: {
+                            type: "string",
+                            description: "The ID of the MFA factor.",
+                        },
+                        factorType: {
+                            type: "string",
+                            description: "The type of the MFA factor (e.g., question, sms, token:software:totp).",
+                        },
+                        provider: {
+                            type: "string",
+                            description: "The provider of the MFA factor (e.g., OKTA).",
+                        },
+                        vendorName: {
+                            type: "string",
+                            description: "The vendor name of the MFA factor.",
+                        },
+                        status: {
+                            type: "string",
+                            description: "The status of the MFA factor (e.g., ACTIVE, PENDING_ACTIVATION).",
+                        },
+                        created: {
+                            type: "string",
+                            description: "The timestamp when the MFA factor was created.",
+                        },
+                        lastUpdated: {
+                            type: "string",
+                            description: "The timestamp when the MFA factor was last updated.",
+                        },
+                        profile: {
+                            type: "object",
+                            description: "Additional profile information for the MFA factor.",
+                            additionalProperties: true,
+                        },
+                        _links: {
+                            type: "object",
+                            description: "Links related to the MFA factor.",
+                            additionalProperties: true,
+                        },
+                        _embedded: {
+                            type: "object",
+                            description: "Embedded data for the MFA factor (e.g., activation details).",
+                            additionalProperties: true,
+                        },
+                    },
+                },
+            },
+            error: {
+                type: "string",
+                description: "Error message if the MFA factors could not be retrieved.",
+            },
+        },
+    },
+    name: "listMFA",
+    provider: "okta",
+};
+export const oktaResetPasswordDefinition = {
+    description: "Reset a user's Okta password when they are unable to log in or have forgotten their password.",
+    scopes: ["okta.users.manage"],
+    parameters: {
+        type: "object",
+        required: ["userId", "sendEmail"],
+        properties: {
+            userId: {
+                type: "string",
+                description: "The ID of the user whose password needs to be reset.",
+            },
+            sendEmail: {
+                type: "boolean",
+                description: "Whether to send a password reset email to the user.",
+            },
+            revokeSessions: {
+                type: "boolean",
+                description: "Whether to revoke all active sessions for the user after the password reset.",
+            },
+        },
+    },
+    output: {
+        type: "object",
+        required: ["success"],
+        properties: {
+            success: {
+                type: "boolean",
+                description: "Whether the password reset was successful.",
+            },
+            error: {
+                type: "string",
+                description: "Error message if the password reset failed.",
+            },
+            resetPasswordUrl: {
+                type: "string",
+                description: "The URL for resetting the password manually.",
+            },
+        },
+    },
+    name: "resetPassword",
+    provider: "okta",
+};
 export const gongGetGongTranscriptsDefinition = {
     description: "Get sales call transcripts from Gong",
     scopes: [],