1/6

Contents

Title and Copyright Information

Preface

• Audience
• Related Documents
• Documentation Accessibility

1 Getting Started

• 1.1 Requirements for working with the API
• 1.2 User Capabilities
• 1.3 Stateless API
• 1.4 Encryption
• 1.5 Authentication
• 1.6 Terminology
• 1.7 Detailed API Specifications

2 Resources

• 2.1 URL Taxonomy
• 2.2 REST Resource Endpoints
  • 2.2.1 Users
  • 2.2.2 Groups
  • 2.2.3 Bulk
• 2.3 Resource Schema
  • 2.3.1 Users
  • 2.3.2 Groups
  • 2.3.3 Bulk
• 2.4 Return Codes

3 Inbound Provisioning Service APIs

• 3.1 User Management API
  • 3.1.1 Resource-specific Headers
    • 3.1.1.1 Accept & Content-Type
    • 3.1.1.2 Authorization
  • 3.1.2 Create User
    • 3.1.2.1 Sample Message Exchange
  • 3.1.3 Full Update User
    • 3.1.3.1 Sample Message Exchange
  • 3.1.4 Patch User
    • 3.1.4.1 Sample Message Exchange
  • 3.1.5 Retrieve User
    • 3.1.5.1 Sample Message Exchange
  • 3.1.6 Search User
    • 3.1.6.1 Sample Message Exchange
  • 3.1.7 Delete User
    • 3.1.7.1 Sample Message Exchange
• 3.2 Group Management API
  • 3.2.1 Resource-specific Headers
    • 3.2.1.1 Accept & Content-Type
    • 3.2.1.2 Authorization
  • 3.2.2 List Groups
    • 3.2.2.1 Sample Message Exchange
  • 3.2.3 Retrieve a Group
    • 3.2.3.1 Sample Message Exchange
  • 3.2.4 Modify Group Membership
    • 3.2.4.1 Sample Message Exchange — Add users to a group
    • 3.2.4.2 Sample Message Exchange — Remove users from a group
    • 3.2.4.3 Sample Message Exchange — Remove all users from a group
• 3.3 Bulk API
  • 3.3.1 Bulk Request
  • 3.3.2 Sample Message Exchange
  • 3.3.3 Sample Message Exchange — Creating and adding the user to a group