API Documentation

This API documentation explains in detail how to create the right HTTP requests for calling the Identity Cloud API endpoints, listing all available parameters, HTTP requests, and responses.

Table of contents

• Introduction

  • Endpoint
  • Authentication
  • Media type
  • Versioning
  • Errors
  • Pagination

• Users

  • Create user
  • Get user
  • List users
  • Update user
  • Delete user
  • Block user
  • Unblock user

• Roles

  • Get roles
  • Assign role
  • Remove role from user
  • Get user roles

• Applications

  • Create application
  • Get application
  • Get application scopes
  • Get applications
  • Update application
  • Update application scopes
  • Delete application

• Custom scopes

  • Create custom scope
  • Get custom scopes
  • Update custom scope
  • Delete custom scope

• Organizations

  • Create organization
  • Get organization
  • Get organizations
  • Query organizations
  • Update organization
  • Delete organization
  • Upload organization logo
  • Get organization logo
  • Delete organization logo
  • Assign user to organization
  • Remove user from organization
  • Get organization of a user

• Authentication

  • Verify email link ticket

• Authentication methods

  • Access apps
    • Get access apps
    • Get access app
    • Update access app
    • Delete access app
  • Email link
    • Create email link
    • Get email link
    • Delete email link
  • Password
    • Create password
    • Change password
    • Delete password
    • Get password
  • Passkey
    • Get passkeys
    • Delete passkey

• Log events

  • Get log event
  • Query log events
  • Export log events
  • Log event types
    • Applications
      • Applications updated
    • Signup/Login
      • Password verified
      • Social login verified
      • TOTP verified
      • SMS verified
      • Recovery codes verified
      • Email verified
      • Passkey verified
      • SFA verified
      • MFA verified
      • Passwordless verified
      • Terms and conditions accepted
    • Users
      • User created
      • User updated
      • User deleted
      • User blocked
      • User unblocked
      • Role assigned to user
      • Role removed from user
    • Authentication methods
      • Access apps
        • Access app deleted
        • Access app updated
      • Email link
        • Invitation created
        • Invitation deleted
        • Password reset created
        • Password reset deleted
      • Password
        • Password deleted
    • Settings
    • Global settings
      • Settings updated
    • Access keys
      • Access key created
      • Access key updated
      • Access key deleted
      • Access key token read

• Certificates

  • Get SAML Signer Certificate SHA-256 Fingerprint