CA AuthMinder Web Services Guide › Getting Started › Introduction to the AuthMinder Web Services

Introduction to the AuthMinder Web Services

The AuthMinder Web services provides a programmatic interface that you can use to integrate your application with AuthMinder. The AuthMinder Web services are broadly classified, as follows:

• Organization Management Web Service
• Configuration Management Web Service
• User Management Web Service
• Administration Web Service
• Issuance Web Service
• Authentication Web Service
• Bulk Upload Web Service

Organization Management Web Service

Organization is an AuthMinder unit that can either map to a complete enterprise (or a company) or a specific division, department, or other entities within the enterprise. The organization management Web service is used to create and manage these organizations. You can perform the following operations by using the organization management Web service:

• Create organizations
• Fetch organization information
• Fetch default organization

  An organization that is created by default when you install AuthMinder. If you have set any other organization as the default, then that organization is used.

• Update organization information
• Update organization status
• Refresh organization cache
• Fetch user attributes that AuthMinder supports
• Fetch user attributes that the directory service supports

See chapter, "Managing Organizations" for more information on how to use the organization management Web services.

Configuration Management Web Service

The configuration management Web service is used to perform the following operations:

• Create account types
• Update account types
• Fetch account types
• Fetch email ID and telephone number types configured at the global-level
• Fetch the user attributes that are configured to be stored in the encrypted format

See chapter, "Configuration Management Web Service" for more information on how to use the user management Web services.

User Management Web Service

The user management Web service is used to manage users, user accounts, user’s Personal Assurance Message (PAM), and authentication operations for LDAP users. You can perform the following operations by using the user management Web service:

• Create users and user accounts
• Search users
• Fetch users and user accounts
• Update user information
• Update user account information
• Fetch and update user status
• Authenticate administrators (password and QnA authentication mechanisms only)
• Set and fetch PAM

See chapter, "Managing Users and Accounts" for more information on how to use the user management Web services.

Administration Web Service

The AuthMinder administration Web service is used to perform the following administration operations:

• Create credential profiles and policies
• Update credential profiles and policies
• Fetch credential profiles and policies
• Delete credential profiles and policies
• Assign default configurations
• Set up RADIUS configurations
• Set up other AuthMinder configurations such as, ASSP, RADIUS, and SAML
• Credential type resolution
• Key management

See chapter, "Managing AuthMinder Configurations" for more information on how to use the administration Web services.

Issuance Web Service

The AuthMinder Issuance Web service (also known as Credential Management Web service) interacts with AuthMinder Server to create, fetch, enable, and disable credentials. You can perform the following operations by using the Issuance Web service:

• Create credentials for the users.
• Perform credential lifecycle management operations such as, enable, disable, reset credential, reset credential validity, and delete.

See chapter, "Performing Credential Operations" for more information on how to use the Issuance Web services.

Authentication Web Service

The AuthMinder authentication Web service can be used to authenticate users using the out-of-the-box credentials supported by AuthMinder, and also the custom credentials that your system supports.

See chapter, "Authenticating Users" for more information on how to use the authentication Web service.

Bulk Upload Web Service

The AuthMinder Bulk Upload Web service can be used to assign credentials to users, assign and fetch OATH tokens in bulk.

See chapter, "Performing Bulk Operations" for more information on how to use the bulk upload Web service.