README.md

Documentation for Hypto IAM

Documentation for API Endpoints

All URIs are relative to https://sandbox-iam.us.hypto.com/v1

Class	Method	HTTP request	Description
KeyManagementApi	getKey	GET /keys/{kid}	Get keys
OrganizationManagementApi	createOrganization	POST /organizations	Creates an organization.
OrganizationManagementApi	deleteOrganization	DELETE /organizations/{organization_id}	Delete an organization
OrganizationManagementApi	getOrganization	GET /organizations/{organization_id}	Get an organization
OrganizationManagementApi	updateOrganization	PATCH /organizations/{organization_id}	Update an organization
PolicyManagementApi	createPolicy	POST /organizations/{organization_id}/policies	Create a policy
PolicyManagementApi	deletePolicy	DELETE /organizations/{organization_id}/policies/{policy_name}	Delete a policy
PolicyManagementApi	getPolicy	GET /organizations/{organization_id}/policies/{policy_name}	Get a policy
PolicyManagementApi	listPolicies	GET /organizations/{organization_id}/policies	List policies
PolicyManagementApi	updatePolicy	PATCH /organizations/{organization_id}/policies/{policy_name}	Update a policy
ResourceActionManagementApi	createAction	POST /organizations/{organization_id}/resources/{resource_name}/actions	Create an action
ResourceActionManagementApi	deleteAction	DELETE /organizations/{organization_id}/resources/{resource_name}/actions/{action_name}	Delete an action
ResourceActionManagementApi	getAction	GET /organizations/{organization_id}/resources/{resource_name}/actions/{action_name}	Get an action
ResourceActionManagementApi	listActions	GET /organizations/{organization_id}/resources/{resource_name}/actions	List actions
ResourceActionManagementApi	updateAction	PATCH /organizations/{organization_id}/resources/{resource_name}/actions/{action_name}	Update an action
ResourceManagementApi	createResource	POST /organizations/{organization_id}/resources	Create a resource name in an organization.
ResourceManagementApi	deleteResource	DELETE /organizations/{organization_id}/resources/{resource_name}	Delete a resource
ResourceManagementApi	getResource	GET /organizations/{organization_id}/resources/{resource_name}	Get the resource details
ResourceManagementApi	listResources	GET /organizations/{organization_id}/resources	List Resources
ResourceManagementApi	updateResource	PATCH /organizations/{organization_id}/resources/{resource_name}	Update a resource
UserAuthenticationApi	authenticate	POST /authenticate	Authenticate a request
UserAuthorizationApi	getToken	POST /token	Generate a token
UserAuthorizationApi	getTokenForOrg	POST /organizations/{organization_id}/token	Generate a organization_id scoped token
UserAuthorizationApi	validate	POST /validate	Validate an auth request
UserCredentialManagementApi	createCredential	POST /organizations/{organization_id}/users/{user_name}/credentials	Create a new credential for a user
UserCredentialManagementApi	deleteCredential	DELETE /organizations/{organization_id}/users/{user_name}/credentials/{credential_id}	Delete a credential
UserCredentialManagementApi	getCredential	GET /organizations/{organization_id}/users/{user_name}/credentials/{credential_id}	Gets credential for the user
UserCredentialManagementApi	listCredentials	GET /organizations/{organization_id}/users/{user_name}/credentials	List all credentials for a user
UserCredentialManagementApi	updateCredential	PATCH /organizations/{organization_id}/users/{user_name}/credentials/{credential_id}	Update the status of credential
UserManagementApi	changePassword	POST /organizations/{organization_id}/users/{user_name}/change_password	Change password for a user
UserManagementApi	createUser	POST /organizations/{organization_id}/users	Create a user
UserManagementApi	deleteUser	DELETE /organizations/{organization_id}/users/{user_name}	Delete a User
UserManagementApi	getUser	GET /organizations/{organization_id}/users/{user_name}	Gets a user entity associated with the organization
UserManagementApi	listUsers	GET /organizations/{organization_id}/users	List users
UserManagementApi	resetPassword	POST /organizations/{organization_id}/users/resetPassword	Reset Password
UserManagementApi	updateUser	PATCH /organizations/{organization_id}/users/{user_name}	Update a User
UserPolicyManagementApi	attachPolicies	PATCH /organizations/{organization_id}/users/{user_name}/attach_policies	Attach policies to user
UserPolicyManagementApi	detachPolicies	PATCH /organizations/{organization_id}/users/{user_name}/detach_policies	Detach policies from user
UserPolicyManagementApi	getUserPolicies	GET /organizations/{organization_id}/users/{user_name}/policies	List all policies associated with user
UserVerificationApi	verifyEmail	POST /verifyEmail	Verify email

Documentation for Models

• Action
• ActionPaginatedResponse
• BaseSuccessResponse
• ChangeUserPasswordRequest
• CreateActionRequest
• CreateCredentialRequest
• CreateOrganizationRequest
• CreateOrganizationResponse
• CreatePolicyRequest
• CreateResourceRequest
• CreateUserRequest
• Credential
• CredentialWithoutSecret
• ErrorResponse
• GetUserPoliciesResponse
• KeyResponse
• ListCredentialResponse
• Organization
• PaginationOptions
• Policy
• PolicyAssociationRequest
• PolicyPaginatedResponse
• PolicyStatement
• ResetPasswordRequest
• Resource
• ResourceAction
• ResourceActionEffect
• ResourcePaginatedResponse
• RootUser
• TokenResponse
• UpdateActionRequest
• UpdateCredentialRequest
• UpdateOrganizationRequest
• UpdatePolicyRequest
• UpdateResourceRequest
• UpdateUserRequest
• User
• UserPaginatedResponse
• UserPolicy
• ValidationRequest
• ValidationResponse
• VerifyEmailRequest

Documentation for Authorization

apiKeyAuth

• Type: API key
• API key parameter name: X-API-Key
• Location: HTTP header

basicAuth

• Type: HTTP basic authentication

bearerAuth

• Type: HTTP basic authentication