types.hpp

Go to the documentation of this file.

// Public domain value types returned/accepted by axiam::Client. Mirrors the
// relevant openapi.json schemas (auth + authz).
#pragma once
 
#include <cstdint>
#include <optional>
#include <string>
#include <vector>
 
#include "axiam/sensitive.hpp"
 
namespace axiam {
 
struct UserInfo {
    std::string id;
    std::string username;
    std::string email;
    std::string tenant_id;
    std::optional<std::string> org_slug;
    std::optional<std::string> tenant_slug;
};
 
struct LoginResult {
    bool mfa_required = false;
 
    // Success branch (HTTP 200 LoginSuccessResponse).
    std::optional<UserInfo> user;
    std::string session_id;
    std::int64_t expires_in = 0;
 
    // MFA-required branch (HTTP 202 MfaRequiredResponse).
    Sensitive<std::string> challenge_token;
    std::vector<std::string> available_methods;
};
 
struct TokenPair {
    std::int64_t expires_in = 0;
};
 
struct DeviceAuth {
    Sensitive<std::string> access_token;
    std::string token_type;
    std::int64_t expires_in = 0;
};
 
struct AccessCheck {
    std::string action;
    std::string resource_id;
    std::optional<std::string> scope;
    std::optional<std::string> subject_id;
};
 
struct ReasonCode {
    static constexpr const char* kAllowed = "allowed";
    static constexpr const char* kNoGrant = "no_grant";
    static constexpr const char* kDeniedByRule = "denied_by_rule";
};
 
struct AccessDecision {
    bool allowed = false;
    std::optional<std::string> reason;
    std::optional<std::string> reason_code;
};
 
}  // namespace axiam