dev-external-api
Explore a comprehensive set of APIs designed for seamless asset creation, user management, security group administration, and role assignments. This curated list empowers users to efficiently navigate diverse API services, fostering a deeper understanding of schemas and structures for effective management.
Authentication
- API Key: CustomAuthorizer
| Security Scheme Type: | apiKey |
|---|---|
| Header parameter name: | Authorization |
How to utilize APIs to create an entire system
To effectively create a system, it's essential to call the APIs in the correct sequence. Below is a guide on the order in which to call the APIs for seamless integration:
Example Workflow
- Create Security Group
- Create New Role
- Create a New User
- Create/Update Asset Model
- Create Asset
- Get List of Assets
- Create a System
- Get List of Systems
1. Create Security Group
The first step is to create a security group, which contains users, assets, and systems. If you already have a security group in your account, you can retrieve a list of them by calling the Security Group List API.
Once you receive a successful response with the list of security groups, you can identify the relevant security group and copy its ID (it will start with something like SG-). You’ll need this ID when creating users and assets.
To create a new security group, refer to the Create Security Group API.
2. Create New Role
After creating the security group, the next step is to create a new role. A role defines the permissions (create, read, update, delete) for apps. You can select the apps you want to add to this role with appropriate permissions.
Refer to the Create New Role API.
Once the role is successfully created, copy its ID from the response object (it will start with something like UR-), as you'll need it when creating users.
3. Create a New User
Now that you have the security group and role, you can create a new user.
Refer to the Create New User API.
4. Create/Update Asset Model
Before creating an asset, ensure you have an asset model. If not, you will need to create one. The asset model is required when creating the actual assets.
Refer to the Create/Update Asset Model API.
Once the asset model is created, (it will start with something like AM-), from the response object, as you'll need it when creating assets.
5. Create Asset
Once the asset model and security group are set up, you can proceed to create an asset.
Refer to the Create Asset API.
6. Get List of Assets
Retrieve the list of assets to verify the asset creation process and interact with the assets.
Refer to the Get Assets API.
7. Create a System
Once the asset created and set up, you can proceed to create a system.
Refer to the Create System API.
8. Get List of Systems
Finally, retrieve the list of systems to verify the system creation process and interact with the systems.
Refer to the Get Systems API.
By following this structured order, you can ensure the correct workflow and avoid potential errors during API execution.