Contents

Title and Copyright Information

Preface

• Audience
• Documentation Accessibility
• Related Documents
• Conventions

1 Enabling Web Services

• 1.1 To Enable Web Services
• 1.2 To Disable Web Services

2 User Service

• 2.1 Overview
• 2.2 WSDL Access
• 2.3 API Reference
  • 2.3.1 Find All Users by Filter String
    • 2.3.1.1 Method Signature
    • 2.3.1.2 Request Parameters
    • 2.3.1.3 Response
    • 2.3.1.4 Exception
  • 2.3.2 Find Roles For A User
    • 2.3.2.1 Method Signature
    • 2.3.2.2 Request Parameters
    • 2.3.2.3 Response
    • 2.3.2.4 Exception
  • 2.3.3 Find Accounts for a User
    • 2.3.3.1 Method Signature
    • 2.3.3.2 Request Parameters
    • 2.3.3.3 Response
    • 2.3.3.4 Exception
  • 2.3.4 Create a New User
    • 2.3.4.1 Method Signature
    • 2.3.4.2 Request Parameter
    • 2.3.4.3 Response
    • 2.3.4.4 Exception
  • 2.3.5 Create a New User if Rule-Based Role Assignment
    • 2.3.5.1 Method Signature
    • 2.3.5.2 Request Parameters
    • 2.3.5.3 Response
    • 2.3.5.4 Exception
  • 2.3.6 Update User
    • 2.3.6.1 Method Signature
    • 2.3.6.2 Request Parameter
    • 2.3.6.3 Response
    • 2.3.6.4 Exception
  • 2.3.7 Update User if Rule-Based Role Assignment
    • 2.3.7.1 Method Signature
    • 2.3.7.2 Request Parameters
    • 2.3.7.3 Response
    • 2.3.7.4 Exception
  • 2.3.8 Disable Users
    • 2.3.8.1 Method Signature
    • 2.3.8.2 Request Parameter
    • 2.3.8.3 Response
    • 2.3.8.4 Exception
  • 2.3.9 Enable Users
    • 2.3.9.1 Method Signature
    • 2.3.9.2 Request Parameter
    • 2.3.9.3 Response
    • 2.3.9.4 Exception
  • 2.3.10 Find Business Units for a User
    • 2.3.10.1 Method Signature
    • 2.3.10.2 Request Parameters
    • 2.3.10.3 Response
    • 2.3.10.4 Exception
  • 2.3.11 Remove All Roles From User
    • 2.3.11.1 Method Signature
    • 2.3.11.2 Request Parameters
    • 2.3.11.3 Response
    • 2.3.11.4 Exception

3 Role Service

• 3.1 Overview
• 3.2 WSDL Access
• 3.3 API Reference
  • 3.3.1 Find Roles in Business Units
    • 3.3.1.1 Method Signature
    • 3.3.1.2 Request Parameters
    • 3.3.1.3 Response
    • 3.3.1.4 Exception
  • 3.3.2 Find Users in Role
    • 3.3.2.1 Method Signature
    • 3.3.2.2 Request Parameters
    • 3.3.2.3 Response
    • 3.3.2.4 Exception
  • 3.3.3 Assign User to Role
    • 3.3.3.1 Method Signatures
    • 3.3.3.2 Request Parameters
    • 3.3.3.3 Response
    • 3.3.3.4 Exception
  • 3.3.4 Remove User From Role
    • 3.3.4.1 Method Signatures
    • 3.3.4.2 Request Parameters
    • 3.3.4.3 Response
    • 3.3.4.4 Exception
  • 3.3.5 Preview User to Role Assignment
    • 3.3.5.1 Method Signature
    • 3.3.5.2 Request Parameters
    • 3.3.5.3 Response
    • 3.3.5.4 Exception
  • 3.3.6 Get Roles by Names
    • 3.3.6.1 Method Signature
    • 3.3.6.2 Request Parameters
    • 3.3.6.3 Response
  • 3.3.7 Update Roles
    • 3.3.7.1 Method Signature
    • 3.3.7.2 Request Parameters
    • 3.3.7.3 Response

4 Business Unit Service

• 4.1 Overview
• 4.2 WSDL Access
• 4.3 API Reference
  • 4.3.1 Add Roles to a Business Unit
    • 4.3.1.1 Method Signature
    • 4.3.1.2 Request Parameter
    • 4.3.1.3 Response
    • 4.3.1.4 Exception
  • 4.3.2 Remove Roles From a Business Unit
    • 4.3.2.1 Method Signature
    • 4.3.2.2 Request Parameters
    • 4.3.2.3 Response
    • 4.3.2.4 Exception
  • 4.3.3 Add Users to a Business Unit
    • 4.3.3.1 Method Signature
    • 4.3.3.2 Request Parameters
    • 4.3.3.3 Response
    • 4.3.3.4 Exception
  • 4.3.4 Remove Users From a Business Unit
    • 4.3.4.1 Method Signature
    • 4.3.4.2 Request Parameter
    • 4.3.4.3 Response
    • 4.3.4.4 Exception
  • 4.3.5 Get Parent Business Structure for a Business Unit
    • 4.3.5.1 Method Signature
    • 4.3.5.2 Request Parameter
    • 4.3.5.3 Response
    • 4.3.5.4 Exception
  • 4.3.6 Get Children of a Business Unit
    • 4.3.6.1 Method Signature
    • 4.3.6.2 Request Parameter
    • 4.3.6.3 Response
    • 4.3.6.4 Exception
  • 4.3.7 Update Business Unit
    • 4.3.7.1 Method Signature
    • 4.3.7.2 Request Parameter
    • 4.3.7.3 Response
    • 4.3.7.4 Exception

5 Identity Audit Service

• 5.1 Overview
• 5.2 WSDL Access
• 5.3 API Reference
  • 5.3.1 Get All Open Exceptions
    • 5.3.1.1 Method Signature
    • 5.3.1.2 Request Parameters
    • 5.3.1.3 Response
    • 5.3.1.4 Exception
  • 5.3.2 Get All Audit Exceptions Based on the State
    • 5.3.2.1 Method Signature
    • 5.3.2.2 Request Parameters
    • 5.3.2.3 Response
    • 5.3.2.4 Exception
  • 5.3.3 Mitigate Exception
    • 5.3.3.1 Method Signature
    • 5.3.3.2 Request Parameters
    • 5.3.3.3 Response
    • 5.3.3.4 Exception
  • 5.3.4 Check Audit Exceptions for Users
    • 5.3.4.1 Method Signature
    • 5.3.4.2 Request Parameters
    • 5.3.4.3 Response
    • 5.3.4.4 Exception

6 Web Service Exception Handling

• 6.1 Overview
• 6.2 Error Codes and Error Messages