iam

type API struct {
	// contains filtered or unexported fields
}

type APIKey struct {
	// AccessKey: access key of API key
	AccessKey string `json:"access_key"`
	// SecretKey: secret key of API Key
	SecretKey *string `json:"secret_key"`
	// ApplicationID: ID of application bearer
	// Precisely one of ApplicationID, UserID must be set.
	ApplicationID *string `json:"application_id,omitempty"`
	// UserID: ID of user bearer
	// Precisely one of ApplicationID, UserID must be set.
	UserID *string `json:"user_id,omitempty"`
	// Description: description of API key
	Description string `json:"description"`
	// CreatedAt: creation date and time of API key
	CreatedAt *time.Time `json:"created_at"`
	// UpdatedAt: last update date and time of API key
	UpdatedAt *time.Time `json:"updated_at"`
	// ExpiresAt: expiration date and time of API key
	ExpiresAt *time.Time `json:"expires_at"`
	// DefaultProjectID: the default project ID specified for this API key
	DefaultProjectID string `json:"default_project_id"`
	// Editable: whether or not the API key is editable
	Editable bool `json:"editable"`
	// CreationIP: IP Address of the device which created the API key
	CreationIP string `json:"creation_ip"`
}

type AddGroupMemberRequest struct {
	// GroupID: ID of group
	GroupID string `json:"-"`
	// UserID: ID of the user to add
	// Precisely one of ApplicationID, UserID must be set.
	UserID *string `json:"user_id,omitempty"`
	// ApplicationID: ID of the application to add
	// Precisely one of ApplicationID, UserID must be set.
	ApplicationID *string `json:"application_id,omitempty"`
}

type Application struct {
	// ID: ID of application
	ID string `json:"id"`
	// Name: name of application
	Name string `json:"name"`
	// Description: description of the application
	Description string `json:"description"`
	// CreatedAt: creation date of application
	CreatedAt *time.Time `json:"created_at"`
	// UpdatedAt: last update date of application
	UpdatedAt *time.Time `json:"updated_at"`
	// OrganizationID: ID of organization
	OrganizationID string `json:"organization_id"`
	// Editable: whether or not the application is editable
	Editable bool `json:"editable"`
	// NbAPIKeys: number of API keys owned by the application
	NbAPIKeys uint32 `json:"nb_api_keys"`
}

type ClonePolicyRequest struct {
	PolicyID string `json:"-"`
}

type CreateAPIKeyRequest struct {
	// ApplicationID: ID of application principal
	// Precisely one of ApplicationID, UserID must be set.
	ApplicationID *string `json:"application_id,omitempty"`
	// UserID: ID of user principal
	// Precisely one of ApplicationID, UserID must be set.
	UserID *string `json:"user_id,omitempty"`
	// ExpiresAt: expiration date of the API key
	ExpiresAt *time.Time `json:"expires_at"`
	// DefaultProjectID: the default project ID to use with object storage
	DefaultProjectID *string `json:"default_project_id"`
	// Description: the description of the API key (max length is 200 chars)
	Description string `json:"description"`
}

type CreateApplicationRequest struct {
	// Name: name of application to create (max length is 64 chars)
	Name string `json:"name"`
	// OrganizationID: ID of organization
	OrganizationID string `json:"organization_id"`
	// Description: description of application (max length is 200 chars)
	Description string `json:"description"`
}

type CreateGroupRequest struct {
	// OrganizationID: ID of organization linked to the group
	OrganizationID string `json:"organization_id"`
	// Name: name of the group to create (max length is 64 chars). MUST be unique inside an organization
	Name string `json:"name"`
	// Description: description of the group to create (max length is 200 chars)
	Description string `json:"description"`
}

type CreatePolicyRequest struct {
	// Name: name of policy to create (max length is 64 chars)
	Name string `json:"name"`
	// Description: description of policy to create (max length is 200 chars)
	Description string `json:"description"`
	// OrganizationID: ID of organization
	OrganizationID string `json:"organization_id"`
	// Rules: rules of the policy to create
	Rules []*RuleSpecs `json:"rules"`
	// UserID: ID of user, owner of the policy
	// Precisely one of ApplicationID, GroupID, NoPrincipal, UserID must be set.
	UserID *string `json:"user_id,omitempty"`
	// GroupID: ID of group, owner of the policy
	// Precisely one of ApplicationID, GroupID, NoPrincipal, UserID must be set.
	GroupID *string `json:"group_id,omitempty"`
	// ApplicationID: ID of application, owner of the policy
	// Precisely one of ApplicationID, GroupID, NoPrincipal, UserID must be set.
	ApplicationID *string `json:"application_id,omitempty"`
	// NoPrincipal: true when the policy do not belong to any principal
	// Precisely one of ApplicationID, GroupID, NoPrincipal, UserID must be set.
	NoPrincipal *bool `json:"no_principal,omitempty"`
}

type CreateSSHKeyRequest struct {
	// Name: the name of the SSH key. Max length is 1000
	Name string `json:"name"`
	// PublicKey: SSH public key. Currently ssh-rsa, ssh-dss (DSA), ssh-ed25519 and ecdsa keys with NIST curves are supported. Max length is 65000
	PublicKey string `json:"public_key"`
	// ProjectID: project owning the resource
	ProjectID string `json:"project_id"`
}

type DeleteAPIKeyRequest struct {
	// AccessKey: access key to delete
	AccessKey string `json:"-"`
}

type DeleteApplicationRequest struct {
	// ApplicationID: ID of application to delete
	ApplicationID string `json:"-"`
}

type DeleteGroupRequest struct {
	// GroupID: ID of group to delete
	GroupID string `json:"-"`
}

type DeletePolicyRequest struct {
	// PolicyID: id of policy to delete
	PolicyID string `json:"-"`
}

type DeleteSSHKeyRequest struct {
	SSHKeyID string `json:"-"`
}

type DeleteUserRequest struct {
	// UserID: ID of user to delete
	UserID string `json:"-"`
}

type GetAPIKeyRequest struct {
	// AccessKey: access key to search for
	AccessKey string `json:"-"`
}

type GetApplicationRequest struct {
	// ApplicationID: ID of application to find
	ApplicationID string `json:"-"`
}

type GetGroupRequest struct {
	// GroupID: ID of group
	GroupID string `json:"-"`
}

type GetPolicyRequest struct {
	// PolicyID: id of policy to search
	PolicyID string `json:"-"`
}

type GetSSHKeyRequest struct {
	// SSHKeyID: the ID of the SSH key
	SSHKeyID string `json:"-"`
}

type GetUserRequest struct {
	// UserID: ID of user to find
	UserID string `json:"-"`
}

type Group struct {
	// ID: ID of group
	ID string `json:"id"`
	// CreatedAt: creation date and time of group
	CreatedAt *time.Time `json:"created_at"`
	// UpdatedAt: last update date and time of group
	UpdatedAt *time.Time `json:"updated_at"`
	// OrganizationID: ID of organization linked to the group
	OrganizationID string `json:"organization_id"`
	// Name: name of group
	Name string `json:"name"`
	// Description: description of the group
	Description string `json:"description"`
	// UserIDs: iDs of users attached to this group
	UserIDs []string `json:"user_ids"`
	// ApplicationIDs: iDs of applications attached to this group
	ApplicationIDs []string `json:"application_ids"`
}

type ListAPIKeysRequest struct {
	// OrderBy: criteria for sorting results
	//
	// Default value: created_at_asc
	OrderBy ListAPIKeysRequestOrderBy `json:"-"`
	// Page: number of page. Value must be greater or equals to 1
	//
	// Default value: 1
	Page *int32 `json:"-"`
	// PageSize: number of results per page. Value must be between 1 and 100
	//
	// Default value: 20
	PageSize *uint32 `json:"-"`
	// OrganizationID: ID of organization
	OrganizationID *string `json:"-"`
	// ApplicationID: ID of an application bearer
	ApplicationID *string `json:"-"`
	// UserID: ID of a user bearer
	UserID *string `json:"-"`
	// Editable: filter out editable API keys or not
	Editable *bool `json:"-"`
}

type ListAPIKeysRequestOrderBy string

type ListAPIKeysResponse struct {
	// APIKeys: list of API keys
	APIKeys []*APIKey `json:"api_keys"`
	// TotalCount: total count of API Keys
	TotalCount uint32 `json:"total_count"`
}

type ListApplicationsRequest struct {
	// OrderBy: criteria for sorting results
	//
	// Default value: created_at_asc
	OrderBy ListApplicationsRequestOrderBy `json:"-"`
	// PageSize: number of results per page. Value must be between 1 and 100
	//
	// Default value: 20
	PageSize *uint32 `json:"-"`
	// Page: number of page. Value must be greater to 1
	//
	// Default value: 1
	Page *int32 `json:"-"`
	// Name: name of application to filter
	Name *string `json:"-"`
	// OrganizationID: ID of organization to filter
	OrganizationID *string `json:"-"`
	// Editable: filter out editable applications or not
	Editable *bool `json:"-"`
	// ApplicationIDs: filter out by a list of ID
	ApplicationIDs []string `json:"-"`
}

type ListApplicationsRequestOrderBy string

type ListApplicationsResponse struct {
	// Applications: list of applications
	Applications []*Application `json:"applications"`
	// TotalCount: total count of applications
	TotalCount uint32 `json:"total_count"`
}

type ListGroupsRequest struct {
	// OrderBy: sort order of groups
	//
	// Default value: created_at_asc
	OrderBy ListGroupsRequestOrderBy `json:"-"`
	// Page: requested page number. Value must be greater or equals to 1
	//
	// Default value: 1
	Page *int32 `json:"-"`
	// PageSize: number of items per page. Value must be between 1 and 100
	//
	// Default value: 20
	PageSize *uint32 `json:"-"`
	// OrganizationID: filter by organization ID
	OrganizationID *string `json:"-"`
	// Name: name of group to find
	Name *string `json:"-"`
	// ApplicationIDs: filter out by a list of application ID
	ApplicationIDs []string `json:"-"`
	// UserIDs: filter out by a list of user ID
	UserIDs []string `json:"-"`
	// GroupIDs: filter out by a list of group ID
	GroupIDs []string `json:"-"`
}

type ListGroupsRequestOrderBy string

type ListGroupsResponse struct {
	// Groups: list of groups
	Groups []*Group `json:"groups"`
	// TotalCount: total count of groups
	TotalCount uint32 `json:"total_count"`
}

type ListPermissionSetsRequest struct {
	// OrderBy: criteria for sorting results
	//
	// Default value: created_at_asc
	OrderBy ListPermissionSetsRequestOrderBy `json:"-"`
	// PageSize: number of results per page. Value must be between 1 and 100
	//
	// Default value: 20
	PageSize *uint32 `json:"-"`
	// Page: number of page. Value must be greater to 1
	//
	// Default value: 1
	Page *int32 `json:"-"`
	// OrganizationID: filter by organization ID
	OrganizationID string `json:"-"`
}

type ListPermissionSetsRequestOrderBy string

type ListPermissionSetsResponse struct {
	// PermissionSets: list of permission sets
	PermissionSets []*PermissionSet `json:"permission_sets"`
	// TotalCount: total count of permission sets
	TotalCount uint32 `json:"total_count"`
}

type ListPoliciesRequest struct {
	// OrderBy: criteria for sorting results
	//
	// Default value: created_at_asc
	OrderBy ListPoliciesRequestOrderBy `json:"-"`
	// PageSize: number of results per page. Value must be between 1 and 100
	//
	// Default value: 20
	PageSize *uint32 `json:"-"`
	// Page: number of page. Value must be greater to 1
	//
	// Default value: 1
	Page *int32 `json:"-"`
	// OrganizationID: ID of organization to filter
	OrganizationID *string `json:"-"`
	// Editable: filter out editable policies or not
	Editable *bool `json:"-"`
	// UserIDs: filter out by a list of user ID
	UserIDs []string `json:"-"`
	// GroupIDs: filter out by a list of group ID
	GroupIDs []string `json:"-"`
	// ApplicationIDs: filter out by a list of application ID
	ApplicationIDs []string `json:"-"`
	// NoPrincipal: true when the policy do not belong to any principal
	NoPrincipal *bool `json:"-"`
	// PolicyName: name of policy to fetch
	PolicyName *string `json:"-"`
}

type ListPoliciesRequestOrderBy string

type ListPoliciesResponse struct {
	// Policies: list of policies
	Policies []*Policy `json:"policies"`
	// TotalCount: total count of policies
	TotalCount uint32 `json:"total_count"`
}

type ListRulesRequest struct {
	// PolicyID: id of policy to search
	PolicyID *string `json:"-"`
	// PageSize: number of results per page. Value must be between 1 and 100
	//
	// Default value: 20
	PageSize *uint32 `json:"-"`
	// Page: number of page. Value must be greater to 1
	//
	// Default value: 1
	Page *int32 `json:"-"`
}

type ListRulesResponse struct {
	// Rules: rules of the policy
	Rules []*Rule `json:"rules"`
	// TotalCount: total count of rules
	TotalCount uint32 `json:"total_count"`
}

type ListSSHKeysRequest struct {
	// OrderBy: sort order of SSH keys
	//
	// Default value: created_at_asc
	OrderBy ListSSHKeysRequestOrderBy `json:"-"`
	// Page: requested page number. Value must be greater or equals to 1
	//
	// Default value: 1
	Page *int32 `json:"-"`
	// PageSize: number of items per page. Value must be between 1 and 100
	//
	// Default value: 20
	PageSize *uint32 `json:"-"`
	// OrganizationID: filter by organization ID
	OrganizationID *string `json:"-"`
	// Name: name of group to find
	Name *string `json:"-"`
	// ProjectID: filter by project ID
	ProjectID *string `json:"-"`
	// Disabled: filter out disabled SSH keys or not
	Disabled *bool `json:"-"`
}

type ListSSHKeysRequestOrderBy string

type ListSSHKeysResponse struct {
	// SSHKeys: list of SSH keys
	SSHKeys []*SSHKey `json:"ssh_keys"`
	// TotalCount: total count of SSH keys
	TotalCount uint32 `json:"total_count"`
}

type ListUsersRequest struct {
	// OrderBy: criteria for sorting results
	//
	// Default value: created_at_asc
	OrderBy ListUsersRequestOrderBy `json:"-"`
	// PageSize: number of results per page. Value must be between 1 and 100
	//
	// Default value: 20
	PageSize *uint32 `json:"-"`
	// Page: number of page. Value must be greater or equals to 1
	//
	// Default value: 1
	Page *int32 `json:"-"`
	// OrganizationID: ID of organization to filter
	OrganizationID *string `json:"-"`
	// UserIDs: filter out by a list of ID
	UserIDs []string `json:"-"`
}

type ListUsersRequestOrderBy string

type ListUsersResponse struct {
	// Users: list of users
	Users []*User `json:"users"`
	// TotalCount: total count of users
	TotalCount uint32 `json:"total_count"`
}

type PermissionSet struct {
	// ID: id of permission set
	ID string `json:"id"`
	// Name: name of permission set
	Name string `json:"name"`
	// ScopeType: scope of permission set
	//
	// Default value: unknown_scope_type
	ScopeType PermissionSetScopeType `json:"scope_type"`
	// Description: description of permission set
	Description string `json:"description"`
	// Categories: categories of permission set
	Categories *[]string `json:"categories"`
}

type PermissionSetScopeType string

type Policy struct {
	// ID: id of policy
	ID string `json:"id"`
	// Name: name of policy
	Name string `json:"name"`
	// Description: description of policy
	Description string `json:"description"`
	// OrganizationID: organization ID of policy
	OrganizationID string `json:"organization_id"`
	// CreatedAt: creation date and time of policy
	CreatedAt *time.Time `json:"created_at"`
	// UpdatedAt: last update date and time of policy
	UpdatedAt *time.Time `json:"updated_at"`
	// Editable: editable status of policy
	Editable bool `json:"editable"`
	// NbRules: number of rules of policy
	NbRules uint32 `json:"nb_rules"`
	// NbScopes: number of scopes of policy
	NbScopes uint32 `json:"nb_scopes"`
	// NbPermissionSets: number of permission sets of policy
	NbPermissionSets uint32 `json:"nb_permission_sets"`
	// UserID: ID of user, owner of the policy
	// Precisely one of ApplicationID, GroupID, NoPrincipal, UserID must be set.
	UserID *string `json:"user_id,omitempty"`
	// GroupID: ID of group, owner of the policy
	// Precisely one of ApplicationID, GroupID, NoPrincipal, UserID must be set.
	GroupID *string `json:"group_id,omitempty"`
	// ApplicationID: ID of application, owner of the policy
	// Precisely one of ApplicationID, GroupID, NoPrincipal, UserID must be set.
	ApplicationID *string `json:"application_id,omitempty"`
	// NoPrincipal: true when the policy do not belong to any principal
	// Precisely one of ApplicationID, GroupID, NoPrincipal, UserID must be set.
	NoPrincipal *bool `json:"no_principal,omitempty"`
}

type RemoveGroupMemberRequest struct {
	// GroupID: ID of group
	GroupID string `json:"-"`
	// UserID: ID of the user to remove
	// Precisely one of ApplicationID, UserID must be set.
	UserID *string `json:"user_id,omitempty"`
	// ApplicationID: ID of the application to remove
	// Precisely one of ApplicationID, UserID must be set.
	ApplicationID *string `json:"application_id,omitempty"`
}

type Rule struct {
	// ID: id of rule
	ID string `json:"id"`
	// PermissionSetNames: names of permission sets bound to the rule
	PermissionSetNames *[]string `json:"permission_set_names"`
	// PermissionSetsScopeType: permission_set_names have the same scope_type
	//
	// Default value: unknown_scope_type
	PermissionSetsScopeType PermissionSetScopeType `json:"permission_sets_scope_type"`
	// ProjectIDs: list of project IDs scoped to the rule
	// Precisely one of AccountRootUserID, OrganizationID, ProjectIDs must be set.
	ProjectIDs *[]string `json:"project_ids,omitempty"`
	// OrganizationID: ID of organization scoped to the rule
	// Precisely one of AccountRootUserID, OrganizationID, ProjectIDs must be set.
	OrganizationID *string `json:"organization_id,omitempty"`
	// AccountRootUserID: ID of account root user scoped to the rule
	// Precisely one of AccountRootUserID, OrganizationID, ProjectIDs must be set.
	AccountRootUserID *string `json:"account_root_user_id,omitempty"`
}

type RuleSpecs struct {
	// PermissionSetNames: names of permission sets bound to the rule
	PermissionSetNames *[]string `json:"permission_set_names"`
	// ProjectIDs: list of project IDs scoped to the rule
	// Precisely one of OrganizationID, ProjectIDs must be set.
	ProjectIDs *[]string `json:"project_ids,omitempty"`
	// OrganizationID: ID of organization scoped to the rule
	// Precisely one of OrganizationID, ProjectIDs must be set.
	OrganizationID *string `json:"organization_id,omitempty"`
}

type SSHKey struct {
	// ID: ID of SSH key
	ID string `json:"id"`
	// Name: name of SSH key
	Name string `json:"name"`
	// PublicKey: public key of SSH key
	PublicKey string `json:"public_key"`
	// Fingerprint: fingerprint of SSH key
	Fingerprint string `json:"fingerprint"`
	// CreatedAt: creation date of SSH key
	CreatedAt *time.Time `json:"created_at"`
	// UpdatedAt: last update date of SSH key
	UpdatedAt *time.Time `json:"updated_at"`
	// OrganizationID: ID of organization linked to the SSH key
	OrganizationID string `json:"organization_id"`
	// ProjectID: ID of project linked to the SSH key
	ProjectID string `json:"project_id"`
	// Disabled: SSH key status
	Disabled bool `json:"disabled"`
}

type SetGroupMembersRequest struct {
	GroupID string `json:"-"`

	UserIDs []string `json:"user_ids"`

	ApplicationIDs []string `json:"application_ids"`
}

type SetRulesRequest struct {
	// PolicyID: id of policy to update
	PolicyID string `json:"policy_id"`
	// Rules: rules of the policy to set
	Rules []*RuleSpecs `json:"rules"`
}

type SetRulesResponse struct {
	// Rules: rules of policy
	Rules []*Rule `json:"rules"`
}

type UpdateAPIKeyRequest struct {
	// AccessKey: access key to update
	AccessKey string `json:"-"`
	// DefaultProjectID: the new default project ID to set
	DefaultProjectID *string `json:"default_project_id"`
	// Description: the new description to update
	Description *string `json:"description"`
}

type UpdateApplicationRequest struct {
	// ApplicationID: ID of application to update
	ApplicationID string `json:"-"`
	// Name: new name of application (max length is 64 chars)
	Name *string `json:"name"`
	// Description: new description of application (max length is 200 chars)
	Description *string `json:"description"`
}

type UpdateGroupRequest struct {
	// GroupID: ID of group to update
	GroupID string `json:"-"`
	// Name: new name for the group (max length is 64 chars). MUST be unique inside an organization
	Name *string `json:"name"`
	// Description: new description for the group (max length is 200 chars)
	Description *string `json:"description"`
}

type UpdatePolicyRequest struct {
	// PolicyID: id of policy to update
	PolicyID string `json:"-"`
	// Name: new name of policy (max length is 64 chars)
	Name *string `json:"name"`
	// Description: new description of policy (max length is 200 chars)
	Description *string `json:"description"`
	// UserID: new ID of user, owner of the policy
	// Precisely one of ApplicationID, GroupID, NoPrincipal, UserID must be set.
	UserID *string `json:"user_id,omitempty"`
	// GroupID: new ID of group, owner of the policy
	// Precisely one of ApplicationID, GroupID, NoPrincipal, UserID must be set.
	GroupID *string `json:"group_id,omitempty"`
	// ApplicationID: new ID of application, owner of the policy
	// Precisely one of ApplicationID, GroupID, NoPrincipal, UserID must be set.
	ApplicationID *string `json:"application_id,omitempty"`
	// NoPrincipal: true when the policy do not belong to any principal
	// Precisely one of ApplicationID, GroupID, NoPrincipal, UserID must be set.
	NoPrincipal *bool `json:"no_principal,omitempty"`
}

type UpdateSSHKeyRequest struct {
	SSHKeyID string `json:"-"`
	// Name: name of the SSH key. Max length is 1000
	Name *string `json:"name"`
	// Disabled: enable or disable the SSH key
	Disabled *bool `json:"disabled"`
}

type User struct {
	// ID: ID of user
	ID string `json:"id"`
	// Email: email of user
	Email string `json:"email"`
	// CreatedAt: creation date of user
	CreatedAt *time.Time `json:"created_at"`
	// UpdatedAt: last update date of user
	UpdatedAt *time.Time `json:"updated_at"`
	// OrganizationID: ID of organization
	OrganizationID string `json:"organization_id"`
	// Deletable: deletion status of user. Owner user cannot be deleted
	Deletable bool `json:"deletable"`
	// LastLoginAt: last login date
	LastLoginAt *time.Time `json:"last_login_at"`
	// Type: type of the user
	//
	// Default value: unknown_type
	Type UserType `json:"type"`
	// TwoFactorEnabled: 2FA enabled
	TwoFactorEnabled bool `json:"two_factor_enabled"`
	// Status: status of invitation for the user
	//
	// Default value: unknown_status
	Status UserStatus `json:"status"`
}

type UserStatus string

type UserType string