Lattice.Hub
GitHub

Lattice Hub Docs
HTTP OpenAPIAuthentication

Policies

Auth policies and resource authorization.

Auth policies and resource authorization.

Default Base URL: http://127.0.0.1:8090. Management APIs require Authorization (token from login).

Auth · Policies

Auth policies and resource authorization.

GET/auth/v1/policiesAuth required

List policies

List policies.

Parameters

  • Authorizationheader · stringrequired

    Token from login.

  • idquery · stringoptional

    id

  • namequery · stringoptional

    name

  • defaultquery · stringoptional

    default

  • res_idquery · stringoptional

    res_id

  • res_typequery · stringoptional

    res_type

  • principal_idquery · stringoptional

    principal_id

  • principal_typequery · stringoptional

    principal_type

  • show_detailquery · stringoptional

    show_detail

  • offsetquery · integeroptional

    offset

  • limitquery · integeroptional

    limit

Request
curl -sS -X GET 'http://127.0.0.1:8090/auth/v1/policies' \
  -H "Authorization: $TOKEN"
Response example
{
  "code": 200000,
  "info": "execute success"
}
POST/auth/v1/policiesAuth required

Create policies

Create policies.

Parameters

  • Authorizationheader · stringrequired

    Token from login.

  • (body)body · AuthStrategy[]required

    JSON array of AuthStrategy; fields below are per-item.

  • idbody · stringoptional

    id

  • namebody · stringoptional

    name

  • principalsbody · Principalsoptional

    principals

    • usersbody · Principal[]optional

      users

      • idbody · stringoptional

        id

      • namebody · stringoptional

        name

    • groupsbody · Principal[]optional

      groups

      • idbody · stringoptional

        id

      • namebody · stringoptional

        name

    • rolesbody · Principal[]optional

      roles

      • idbody · stringoptional

        id

      • namebody · stringoptional

        name

  • resourcesbody · StrategyResourcesoptional

    resources

    • strategy_idbody · stringoptional

      strategy_id

    • namespacesbody · StrategyResourceEntry[]optional

      namespaces

      • idbody · stringoptional

        id

      • namespacebody · stringoptional

        namespace

      • namebody · stringoptional

        name

    • servicesbody · StrategyResourceEntry[]optional

      services

      • idbody · stringoptional

        id

      • namespacebody · stringoptional

        namespace

      • namebody · stringoptional

        name

    • config_groupsbody · StrategyResourceEntry[]optional

      config_groups

      • idbody · stringoptional

        id

      • namespacebody · stringoptional

        namespace

      • namebody · stringoptional

        name

    • route_rulesbody · StrategyResourceEntry[]optional

      route_rules

      • idbody · stringoptional

        id

      • namespacebody · stringoptional

        namespace

      • namebody · stringoptional

        name

    • ratelimit_rulesbody · StrategyResourceEntry[]optional

      ratelimit_rules

      • idbody · stringoptional

        id

      • namespacebody · stringoptional

        namespace

      • namebody · stringoptional

        name

    • circuitbreaker_rulesbody · StrategyResourceEntry[]optional

      circuitbreaker_rules

      • idbody · stringoptional

        id

      • namespacebody · stringoptional

        namespace

      • namebody · stringoptional

        name

    • faultdetect_rulesbody · StrategyResourceEntry[]optional

      faultdetect_rules

      • idbody · stringoptional

        id

      • namespacebody · stringoptional

        namespace

      • namebody · stringoptional

        name

    • lane_rulesbody · StrategyResourceEntry[]optional

      lane_rules

      • idbody · stringoptional

        id

      • namespacebody · stringoptional

        namespace

      • namebody · stringoptional

        name

    • lossless_rulesbody · StrategyResourceEntry[]optional

      lossless_rules

      • idbody · stringoptional

        id

      • namespacebody · stringoptional

        namespace

      • namebody · stringoptional

        name

    • mirror_rulesbody · StrategyResourceEntry[]optional

      mirror_rules

      • idbody · stringoptional

        id

      • namespacebody · stringoptional

        namespace

      • namebody · stringoptional

        name

    • security_rulesbody · StrategyResourceEntry[]optional

      security_rules

      • idbody · stringoptional

        id

      • namespacebody · stringoptional

        namespace

      • namebody · stringoptional

        name

    • mock_rulesbody · StrategyResourceEntry[]optional

      mock_rules

      • idbody · stringoptional

        id

      • namespacebody · stringoptional

        namespace

      • namebody · stringoptional

        name

    • usersbody · StrategyResourceEntry[]optional

      users

      • idbody · stringoptional

        id

      • namespacebody · stringoptional

        namespace

      • namebody · stringoptional

        name

    • user_groupsbody · StrategyResourceEntry[]optional

      user_groups

      • idbody · stringoptional

        id

      • namespacebody · stringoptional

        namespace

      • namebody · stringoptional

        name

    • rolesbody · StrategyResourceEntry[]optional

      roles

      • idbody · stringoptional

        id

      • namespacebody · stringoptional

        namespace

      • namebody · stringoptional

        name

    • auth_policiesbody · StrategyResourceEntry[]optional

      auth_policies

      • idbody · stringoptional

        id

      • namespacebody · stringoptional

        namespace

      • namebody · stringoptional

        name

    • mcp_serversbody · StrategyResourceEntry[]optional

      mcp_servers

      • idbody · stringoptional

        id

      • namespacebody · stringoptional

        namespace

      • namebody · stringoptional

        name

    • a2a_agentsbody · StrategyResourceEntry[]optional

      a2a_agents

      • idbody · stringoptional

        id

      • namespacebody · stringoptional

        namespace

      • namebody · stringoptional

        name

  • actionbody · enum(AuthAction)optional

    action enum: ONLY_READ | READ_WRITE | ALLOW | DENY

  • commentbody · stringoptional

    comment

  • ownerbody · stringoptional

    owner

  • auth_tokenbody · stringoptional

    auth_token

  • default_strategybody · booloptional

    default_strategy

  • metadatabody · map<string,string>optional

    metadata

  • sourcebody · stringoptional

    source

  • functionsbody · string[]optional

    functions

  • resource_labelsbody · StrategyResourceLabel[]optional

    resource_labels

    • keybody · stringoptional

      key

    • valuebody · stringoptional

      value

    • compare_typebody · stringoptional

      compare_type

Response fields

  • codebody · uint32required

    Business code.

  • infobody · stringoptional

    Info.

  • AuthStrategybody · AuthStrategyoptional

    Entity fields.

    • idbody · stringoptional

      id

    • namebody · stringoptional

      name

    • principalsbody · Principalsoptional

      principals

      • usersbody · Principal[]optional

        users

        • idbody · stringoptional

          id

        • namebody · stringoptional

          name

      • groupsbody · Principal[]optional

        groups

        • idbody · stringoptional

          id

        • namebody · stringoptional

          name

      • rolesbody · Principal[]optional

        roles

        • idbody · stringoptional

          id

        • namebody · stringoptional

          name

    • resourcesbody · StrategyResourcesoptional

      resources

      • strategy_idbody · stringoptional

        strategy_id

      • namespacesbody · StrategyResourceEntry[]optional

        namespaces

        • idbody · stringoptional

          id

        • namespacebody · stringoptional

          namespace

        • namebody · stringoptional

          name

      • servicesbody · StrategyResourceEntry[]optional

        services

        • idbody · stringoptional

          id

        • namespacebody · stringoptional

          namespace

        • namebody · stringoptional

          name

      • config_groupsbody · StrategyResourceEntry[]optional

        config_groups

        • idbody · stringoptional

          id

        • namespacebody · stringoptional

          namespace

        • namebody · stringoptional

          name

      • route_rulesbody · StrategyResourceEntry[]optional

        route_rules

        • idbody · stringoptional

          id

        • namespacebody · stringoptional

          namespace

        • namebody · stringoptional

          name

      • ratelimit_rulesbody · StrategyResourceEntry[]optional

        ratelimit_rules

        • idbody · stringoptional

          id

        • namespacebody · stringoptional

          namespace

        • namebody · stringoptional

          name

      • circuitbreaker_rulesbody · StrategyResourceEntry[]optional

        circuitbreaker_rules

        • idbody · stringoptional

          id

        • namespacebody · stringoptional

          namespace

        • namebody · stringoptional

          name

      • faultdetect_rulesbody · StrategyResourceEntry[]optional

        faultdetect_rules

        • idbody · stringoptional

          id

        • namespacebody · stringoptional

          namespace

        • namebody · stringoptional

          name

      • lane_rulesbody · StrategyResourceEntry[]optional

        lane_rules

        • idbody · stringoptional

          id

        • namespacebody · stringoptional

          namespace

        • namebody · stringoptional

          name

      • lossless_rulesbody · StrategyResourceEntry[]optional

        lossless_rules

        • idbody · stringoptional

          id

        • namespacebody · stringoptional

          namespace

        • namebody · stringoptional

          name

      • mirror_rulesbody · StrategyResourceEntry[]optional

        mirror_rules

        • idbody · stringoptional

          id

        • namespacebody · stringoptional

          namespace

        • namebody · stringoptional

          name

      • security_rulesbody · StrategyResourceEntry[]optional

        security_rules

        • idbody · stringoptional

          id

        • namespacebody · stringoptional

          namespace

        • namebody · stringoptional

          name

      • mock_rulesbody · StrategyResourceEntry[]optional

        mock_rules

        • idbody · stringoptional

          id

        • namespacebody · stringoptional

          namespace

        • namebody · stringoptional

          name

      • usersbody · StrategyResourceEntry[]optional

        users

        • idbody · stringoptional

          id

        • namespacebody · stringoptional

          namespace

        • namebody · stringoptional

          name

      • user_groupsbody · StrategyResourceEntry[]optional

        user_groups

        • idbody · stringoptional

          id

        • namespacebody · stringoptional

          namespace

        • namebody · stringoptional

          name

      • rolesbody · StrategyResourceEntry[]optional

        roles

        • idbody · stringoptional

          id

        • namespacebody · stringoptional

          namespace

        • namebody · stringoptional

          name

      • auth_policiesbody · StrategyResourceEntry[]optional

        auth_policies

        • idbody · stringoptional

          id

        • namespacebody · stringoptional

          namespace

        • namebody · stringoptional

          name

      • mcp_serversbody · StrategyResourceEntry[]optional

        mcp_servers

        • idbody · stringoptional

          id

        • namespacebody · stringoptional

          namespace

        • namebody · stringoptional

          name

      • a2a_agentsbody · StrategyResourceEntry[]optional

        a2a_agents

        • idbody · stringoptional

          id

        • namespacebody · stringoptional

          namespace

        • namebody · stringoptional

          name

    • actionbody · enum(AuthAction)optional

      action enum: ONLY_READ | READ_WRITE | ALLOW | DENY

    • commentbody · stringoptional

      comment

    • ownerbody · stringoptional

      owner

    • ctimebody · stringoptional

      ctime

    • mtimebody · stringoptional

      mtime

    • auth_tokenbody · stringoptional

      auth_token

    • default_strategybody · booloptional

      default_strategy

    • metadatabody · map<string,string>optional

      metadata

    • sourcebody · stringoptional

      source

    • functionsbody · string[]optional

      functions

    • resource_labelsbody · StrategyResourceLabel[]optional

      resource_labels

      • keybody · stringoptional

        key

      • valuebody · stringoptional

        value

      • compare_typebody · stringoptional

        compare_type

Request
curl -sS -X POST 'http://127.0.0.1:8090/auth/v1/policies' \
  -H "Authorization: $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '[]'
Response example
{
  "code": 200000,
  "info": "execute success"
}
PUT/auth/v1/policiesAuth required

Update policies

Update policies.

Parameters

  • Authorizationheader · stringrequired

    Token from login.

  • (body)body · AuthStrategy[]required

    JSON array of AuthStrategy; fields below are per-item.

  • idbody · stringoptional

    id

  • namebody · stringoptional

    name

  • principalsbody · Principalsoptional

    principals

    • usersbody · Principal[]optional

      users

      • idbody · stringoptional

        id

      • namebody · stringoptional

        name

    • groupsbody · Principal[]optional

      groups

      • idbody · stringoptional

        id

      • namebody · stringoptional

        name

    • rolesbody · Principal[]optional

      roles

      • idbody · stringoptional

        id

      • namebody · stringoptional

        name

  • resourcesbody · StrategyResourcesoptional

    resources

    • strategy_idbody · stringoptional

      strategy_id

    • namespacesbody · StrategyResourceEntry[]optional

      namespaces

      • idbody · stringoptional

        id

      • namespacebody · stringoptional

        namespace

      • namebody · stringoptional

        name

    • servicesbody · StrategyResourceEntry[]optional

      services

      • idbody · stringoptional

        id

      • namespacebody · stringoptional

        namespace

      • namebody · stringoptional

        name

    • config_groupsbody · StrategyResourceEntry[]optional

      config_groups

      • idbody · stringoptional

        id

      • namespacebody · stringoptional

        namespace

      • namebody · stringoptional

        name

    • route_rulesbody · StrategyResourceEntry[]optional

      route_rules

      • idbody · stringoptional

        id

      • namespacebody · stringoptional

        namespace

      • namebody · stringoptional

        name

    • ratelimit_rulesbody · StrategyResourceEntry[]optional

      ratelimit_rules

      • idbody · stringoptional

        id

      • namespacebody · stringoptional

        namespace

      • namebody · stringoptional

        name

    • circuitbreaker_rulesbody · StrategyResourceEntry[]optional

      circuitbreaker_rules

      • idbody · stringoptional

        id

      • namespacebody · stringoptional

        namespace

      • namebody · stringoptional

        name

    • faultdetect_rulesbody · StrategyResourceEntry[]optional

      faultdetect_rules

      • idbody · stringoptional

        id

      • namespacebody · stringoptional

        namespace

      • namebody · stringoptional

        name

    • lane_rulesbody · StrategyResourceEntry[]optional

      lane_rules

      • idbody · stringoptional

        id

      • namespacebody · stringoptional

        namespace

      • namebody · stringoptional

        name

    • lossless_rulesbody · StrategyResourceEntry[]optional

      lossless_rules

      • idbody · stringoptional

        id

      • namespacebody · stringoptional

        namespace

      • namebody · stringoptional

        name

    • mirror_rulesbody · StrategyResourceEntry[]optional

      mirror_rules

      • idbody · stringoptional

        id

      • namespacebody · stringoptional

        namespace

      • namebody · stringoptional

        name

    • security_rulesbody · StrategyResourceEntry[]optional

      security_rules

      • idbody · stringoptional

        id

      • namespacebody · stringoptional

        namespace

      • namebody · stringoptional

        name

    • mock_rulesbody · StrategyResourceEntry[]optional

      mock_rules

      • idbody · stringoptional

        id

      • namespacebody · stringoptional

        namespace

      • namebody · stringoptional

        name

    • usersbody · StrategyResourceEntry[]optional

      users

      • idbody · stringoptional

        id

      • namespacebody · stringoptional

        namespace

      • namebody · stringoptional

        name

    • user_groupsbody · StrategyResourceEntry[]optional

      user_groups

      • idbody · stringoptional

        id

      • namespacebody · stringoptional

        namespace

      • namebody · stringoptional

        name

    • rolesbody · StrategyResourceEntry[]optional

      roles

      • idbody · stringoptional

        id

      • namespacebody · stringoptional

        namespace

      • namebody · stringoptional

        name

    • auth_policiesbody · StrategyResourceEntry[]optional

      auth_policies

      • idbody · stringoptional

        id

      • namespacebody · stringoptional

        namespace

      • namebody · stringoptional

        name

    • mcp_serversbody · StrategyResourceEntry[]optional

      mcp_servers

      • idbody · stringoptional

        id

      • namespacebody · stringoptional

        namespace

      • namebody · stringoptional

        name

    • a2a_agentsbody · StrategyResourceEntry[]optional

      a2a_agents

      • idbody · stringoptional

        id

      • namespacebody · stringoptional

        namespace

      • namebody · stringoptional

        name

  • actionbody · enum(AuthAction)optional

    action enum: ONLY_READ | READ_WRITE | ALLOW | DENY

  • commentbody · stringoptional

    comment

  • ownerbody · stringoptional

    owner

  • auth_tokenbody · stringoptional

    auth_token

  • default_strategybody · booloptional

    default_strategy

  • metadatabody · map<string,string>optional

    metadata

  • sourcebody · stringoptional

    source

  • functionsbody · string[]optional

    functions

  • resource_labelsbody · StrategyResourceLabel[]optional

    resource_labels

    • keybody · stringoptional

      key

    • valuebody · stringoptional

      value

    • compare_typebody · stringoptional

      compare_type

Response fields

  • codebody · uint32required

    Business code.

  • infobody · stringoptional

    Info.

  • AuthStrategybody · AuthStrategyoptional

    Entity fields.

    • idbody · stringoptional

      id

    • namebody · stringoptional

      name

    • principalsbody · Principalsoptional

      principals

      • usersbody · Principal[]optional

        users

        • idbody · stringoptional

          id

        • namebody · stringoptional

          name

      • groupsbody · Principal[]optional

        groups

        • idbody · stringoptional

          id

        • namebody · stringoptional

          name

      • rolesbody · Principal[]optional

        roles

        • idbody · stringoptional

          id

        • namebody · stringoptional

          name

    • resourcesbody · StrategyResourcesoptional

      resources

      • strategy_idbody · stringoptional

        strategy_id

      • namespacesbody · StrategyResourceEntry[]optional

        namespaces

        • idbody · stringoptional

          id

        • namespacebody · stringoptional

          namespace

        • namebody · stringoptional

          name

      • servicesbody · StrategyResourceEntry[]optional

        services

        • idbody · stringoptional

          id

        • namespacebody · stringoptional

          namespace

        • namebody · stringoptional

          name

      • config_groupsbody · StrategyResourceEntry[]optional

        config_groups

        • idbody · stringoptional

          id

        • namespacebody · stringoptional

          namespace

        • namebody · stringoptional

          name

      • route_rulesbody · StrategyResourceEntry[]optional

        route_rules

        • idbody · stringoptional

          id

        • namespacebody · stringoptional

          namespace

        • namebody · stringoptional

          name

      • ratelimit_rulesbody · StrategyResourceEntry[]optional

        ratelimit_rules

        • idbody · stringoptional

          id

        • namespacebody · stringoptional

          namespace

        • namebody · stringoptional

          name

      • circuitbreaker_rulesbody · StrategyResourceEntry[]optional

        circuitbreaker_rules

        • idbody · stringoptional

          id

        • namespacebody · stringoptional

          namespace

        • namebody · stringoptional

          name

      • faultdetect_rulesbody · StrategyResourceEntry[]optional

        faultdetect_rules

        • idbody · stringoptional

          id

        • namespacebody · stringoptional

          namespace

        • namebody · stringoptional

          name

      • lane_rulesbody · StrategyResourceEntry[]optional

        lane_rules

        • idbody · stringoptional

          id

        • namespacebody · stringoptional

          namespace

        • namebody · stringoptional

          name

      • lossless_rulesbody · StrategyResourceEntry[]optional

        lossless_rules

        • idbody · stringoptional

          id

        • namespacebody · stringoptional

          namespace

        • namebody · stringoptional

          name

      • mirror_rulesbody · StrategyResourceEntry[]optional

        mirror_rules

        • idbody · stringoptional

          id

        • namespacebody · stringoptional

          namespace

        • namebody · stringoptional

          name

      • security_rulesbody · StrategyResourceEntry[]optional

        security_rules

        • idbody · stringoptional

          id

        • namespacebody · stringoptional

          namespace

        • namebody · stringoptional

          name

      • mock_rulesbody · StrategyResourceEntry[]optional

        mock_rules

        • idbody · stringoptional

          id

        • namespacebody · stringoptional

          namespace

        • namebody · stringoptional

          name

      • usersbody · StrategyResourceEntry[]optional

        users

        • idbody · stringoptional

          id

        • namespacebody · stringoptional

          namespace

        • namebody · stringoptional

          name

      • user_groupsbody · StrategyResourceEntry[]optional

        user_groups

        • idbody · stringoptional

          id

        • namespacebody · stringoptional

          namespace

        • namebody · stringoptional

          name

      • rolesbody · StrategyResourceEntry[]optional

        roles

        • idbody · stringoptional

          id

        • namespacebody · stringoptional

          namespace

        • namebody · stringoptional

          name

      • auth_policiesbody · StrategyResourceEntry[]optional

        auth_policies

        • idbody · stringoptional

          id

        • namespacebody · stringoptional

          namespace

        • namebody · stringoptional

          name

      • mcp_serversbody · StrategyResourceEntry[]optional

        mcp_servers

        • idbody · stringoptional

          id

        • namespacebody · stringoptional

          namespace

        • namebody · stringoptional

          name

      • a2a_agentsbody · StrategyResourceEntry[]optional

        a2a_agents

        • idbody · stringoptional

          id

        • namespacebody · stringoptional

          namespace

        • namebody · stringoptional

          name

    • actionbody · enum(AuthAction)optional

      action enum: ONLY_READ | READ_WRITE | ALLOW | DENY

    • commentbody · stringoptional

      comment

    • ownerbody · stringoptional

      owner

    • ctimebody · stringoptional

      ctime

    • mtimebody · stringoptional

      mtime

    • auth_tokenbody · stringoptional

      auth_token

    • default_strategybody · booloptional

      default_strategy

    • metadatabody · map<string,string>optional

      metadata

    • sourcebody · stringoptional

      source

    • functionsbody · string[]optional

      functions

    • resource_labelsbody · StrategyResourceLabel[]optional

      resource_labels

      • keybody · stringoptional

        key

      • valuebody · stringoptional

        value

      • compare_typebody · stringoptional

        compare_type

Request
curl -sS -X PUT 'http://127.0.0.1:8090/auth/v1/policies' \
  -H "Authorization: $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '[]'
Response example
{
  "code": 200000,
  "info": "execute success"
}
POST/auth/v1/policies/deleteAuth required

Delete policies

Delete policies.

Parameters

  • Authorizationheader · stringrequired

    Token from login.

  • (body)body · AuthStrategy[]required

    JSON array of AuthStrategy; fields below are per-item.

  • idbody · stringoptional

    id

  • namebody · stringoptional

    name

  • principalsbody · Principalsoptional

    principals

    • usersbody · Principal[]optional

      users

      • idbody · stringoptional

        id

      • namebody · stringoptional

        name

    • groupsbody · Principal[]optional

      groups

      • idbody · stringoptional

        id

      • namebody · stringoptional

        name

    • rolesbody · Principal[]optional

      roles

      • idbody · stringoptional

        id

      • namebody · stringoptional

        name

  • resourcesbody · StrategyResourcesoptional

    resources

    • strategy_idbody · stringoptional

      strategy_id

    • namespacesbody · StrategyResourceEntry[]optional

      namespaces

      • idbody · stringoptional

        id

      • namespacebody · stringoptional

        namespace

      • namebody · stringoptional

        name

    • servicesbody · StrategyResourceEntry[]optional

      services

      • idbody · stringoptional

        id

      • namespacebody · stringoptional

        namespace

      • namebody · stringoptional

        name

    • config_groupsbody · StrategyResourceEntry[]optional

      config_groups

      • idbody · stringoptional

        id

      • namespacebody · stringoptional

        namespace

      • namebody · stringoptional

        name

    • route_rulesbody · StrategyResourceEntry[]optional

      route_rules

      • idbody · stringoptional

        id

      • namespacebody · stringoptional

        namespace

      • namebody · stringoptional

        name

    • ratelimit_rulesbody · StrategyResourceEntry[]optional

      ratelimit_rules

      • idbody · stringoptional

        id

      • namespacebody · stringoptional

        namespace

      • namebody · stringoptional

        name

    • circuitbreaker_rulesbody · StrategyResourceEntry[]optional

      circuitbreaker_rules

      • idbody · stringoptional

        id

      • namespacebody · stringoptional

        namespace

      • namebody · stringoptional

        name

    • faultdetect_rulesbody · StrategyResourceEntry[]optional

      faultdetect_rules

      • idbody · stringoptional

        id

      • namespacebody · stringoptional

        namespace

      • namebody · stringoptional

        name

    • lane_rulesbody · StrategyResourceEntry[]optional

      lane_rules

      • idbody · stringoptional

        id

      • namespacebody · stringoptional

        namespace

      • namebody · stringoptional

        name

    • lossless_rulesbody · StrategyResourceEntry[]optional

      lossless_rules

      • idbody · stringoptional

        id

      • namespacebody · stringoptional

        namespace

      • namebody · stringoptional

        name

    • mirror_rulesbody · StrategyResourceEntry[]optional

      mirror_rules

      • idbody · stringoptional

        id

      • namespacebody · stringoptional

        namespace

      • namebody · stringoptional

        name

    • security_rulesbody · StrategyResourceEntry[]optional

      security_rules

      • idbody · stringoptional

        id

      • namespacebody · stringoptional

        namespace

      • namebody · stringoptional

        name

    • mock_rulesbody · StrategyResourceEntry[]optional

      mock_rules

      • idbody · stringoptional

        id

      • namespacebody · stringoptional

        namespace

      • namebody · stringoptional

        name

    • usersbody · StrategyResourceEntry[]optional

      users

      • idbody · stringoptional

        id

      • namespacebody · stringoptional

        namespace

      • namebody · stringoptional

        name

    • user_groupsbody · StrategyResourceEntry[]optional

      user_groups

      • idbody · stringoptional

        id

      • namespacebody · stringoptional

        namespace

      • namebody · stringoptional

        name

    • rolesbody · StrategyResourceEntry[]optional

      roles

      • idbody · stringoptional

        id

      • namespacebody · stringoptional

        namespace

      • namebody · stringoptional

        name

    • auth_policiesbody · StrategyResourceEntry[]optional

      auth_policies

      • idbody · stringoptional

        id

      • namespacebody · stringoptional

        namespace

      • namebody · stringoptional

        name

    • mcp_serversbody · StrategyResourceEntry[]optional

      mcp_servers

      • idbody · stringoptional

        id

      • namespacebody · stringoptional

        namespace

      • namebody · stringoptional

        name

    • a2a_agentsbody · StrategyResourceEntry[]optional

      a2a_agents

      • idbody · stringoptional

        id

      • namespacebody · stringoptional

        namespace

      • namebody · stringoptional

        name

  • actionbody · enum(AuthAction)optional

    action enum: ONLY_READ | READ_WRITE | ALLOW | DENY

  • commentbody · stringoptional

    comment

  • ownerbody · stringoptional

    owner

  • auth_tokenbody · stringoptional

    auth_token

  • default_strategybody · booloptional

    default_strategy

  • metadatabody · map<string,string>optional

    metadata

  • sourcebody · stringoptional

    source

  • functionsbody · string[]optional

    functions

  • resource_labelsbody · StrategyResourceLabel[]optional

    resource_labels

    • keybody · stringoptional

      key

    • valuebody · stringoptional

      value

    • compare_typebody · stringoptional

      compare_type

Response fields

  • codebody · uint32required

    Business code.

  • infobody · stringoptional

    Info.

  • AuthStrategybody · AuthStrategyoptional

    Entity fields.

    • idbody · stringoptional

      id

    • namebody · stringoptional

      name

    • principalsbody · Principalsoptional

      principals

      • usersbody · Principal[]optional

        users

        • idbody · stringoptional

          id

        • namebody · stringoptional

          name

      • groupsbody · Principal[]optional

        groups

        • idbody · stringoptional

          id

        • namebody · stringoptional

          name

      • rolesbody · Principal[]optional

        roles

        • idbody · stringoptional

          id

        • namebody · stringoptional

          name

    • resourcesbody · StrategyResourcesoptional

      resources

      • strategy_idbody · stringoptional

        strategy_id

      • namespacesbody · StrategyResourceEntry[]optional

        namespaces

        • idbody · stringoptional

          id

        • namespacebody · stringoptional

          namespace

        • namebody · stringoptional

          name

      • servicesbody · StrategyResourceEntry[]optional

        services

        • idbody · stringoptional

          id

        • namespacebody · stringoptional

          namespace

        • namebody · stringoptional

          name

      • config_groupsbody · StrategyResourceEntry[]optional

        config_groups

        • idbody · stringoptional

          id

        • namespacebody · stringoptional

          namespace

        • namebody · stringoptional

          name

      • route_rulesbody · StrategyResourceEntry[]optional

        route_rules

        • idbody · stringoptional

          id

        • namespacebody · stringoptional

          namespace

        • namebody · stringoptional

          name

      • ratelimit_rulesbody · StrategyResourceEntry[]optional

        ratelimit_rules

        • idbody · stringoptional

          id

        • namespacebody · stringoptional

          namespace

        • namebody · stringoptional

          name

      • circuitbreaker_rulesbody · StrategyResourceEntry[]optional

        circuitbreaker_rules

        • idbody · stringoptional

          id

        • namespacebody · stringoptional

          namespace

        • namebody · stringoptional

          name

      • faultdetect_rulesbody · StrategyResourceEntry[]optional

        faultdetect_rules

        • idbody · stringoptional

          id

        • namespacebody · stringoptional

          namespace

        • namebody · stringoptional

          name

      • lane_rulesbody · StrategyResourceEntry[]optional

        lane_rules

        • idbody · stringoptional

          id

        • namespacebody · stringoptional

          namespace

        • namebody · stringoptional

          name

      • lossless_rulesbody · StrategyResourceEntry[]optional

        lossless_rules

        • idbody · stringoptional

          id

        • namespacebody · stringoptional

          namespace

        • namebody · stringoptional

          name

      • mirror_rulesbody · StrategyResourceEntry[]optional

        mirror_rules

        • idbody · stringoptional

          id

        • namespacebody · stringoptional

          namespace

        • namebody · stringoptional

          name

      • security_rulesbody · StrategyResourceEntry[]optional

        security_rules

        • idbody · stringoptional

          id

        • namespacebody · stringoptional

          namespace

        • namebody · stringoptional

          name

      • mock_rulesbody · StrategyResourceEntry[]optional

        mock_rules

        • idbody · stringoptional

          id

        • namespacebody · stringoptional

          namespace

        • namebody · stringoptional

          name

      • usersbody · StrategyResourceEntry[]optional

        users

        • idbody · stringoptional

          id

        • namespacebody · stringoptional

          namespace

        • namebody · stringoptional

          name

      • user_groupsbody · StrategyResourceEntry[]optional

        user_groups

        • idbody · stringoptional

          id

        • namespacebody · stringoptional

          namespace

        • namebody · stringoptional

          name

      • rolesbody · StrategyResourceEntry[]optional

        roles

        • idbody · stringoptional

          id

        • namespacebody · stringoptional

          namespace

        • namebody · stringoptional

          name

      • auth_policiesbody · StrategyResourceEntry[]optional

        auth_policies

        • idbody · stringoptional

          id

        • namespacebody · stringoptional

          namespace

        • namebody · stringoptional

          name

      • mcp_serversbody · StrategyResourceEntry[]optional

        mcp_servers

        • idbody · stringoptional

          id

        • namespacebody · stringoptional

          namespace

        • namebody · stringoptional

          name

      • a2a_agentsbody · StrategyResourceEntry[]optional

        a2a_agents

        • idbody · stringoptional

          id

        • namespacebody · stringoptional

          namespace

        • namebody · stringoptional

          name

    • actionbody · enum(AuthAction)optional

      action enum: ONLY_READ | READ_WRITE | ALLOW | DENY

    • commentbody · stringoptional

      comment

    • ownerbody · stringoptional

      owner

    • ctimebody · stringoptional

      ctime

    • mtimebody · stringoptional

      mtime

    • auth_tokenbody · stringoptional

      auth_token

    • default_strategybody · booloptional

      default_strategy

    • metadatabody · map<string,string>optional

      metadata

    • sourcebody · stringoptional

      source

    • functionsbody · string[]optional

      functions

    • resource_labelsbody · StrategyResourceLabel[]optional

      resource_labels

      • keybody · stringoptional

        key

      • valuebody · stringoptional

        value

      • compare_typebody · stringoptional

        compare_type

Request
curl -sS -X POST 'http://127.0.0.1:8090/auth/v1/policies/delete' \
  -H "Authorization: $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '[]'
Response example
{
  "code": 200000,
  "info": "execute success"
}
GET/auth/v1/policies/detailAuth required

Policy detail

Policy detail.

Parameters

  • Authorizationheader · stringrequired

    Token from login.

  • idquery · stringrequired

    id

Request
curl -sS -X GET 'http://127.0.0.1:8090/auth/v1/policies/detail' \
  -H "Authorization: $TOKEN"
Response example
{
  "code": 200000,
  "info": "execute success"
}
GET/auth/v1/principal/resourcesAuth required

Principal resources

Principal resources.

Parameters

  • Authorizationheader · stringrequired

    Token from login.

  • principal_idquery · stringrequired

    principal_id

  • principal_typequery · stringrequired

    principal_type

Request
curl -sS -X GET 'http://127.0.0.1:8090/auth/v1/principal/resources' \
  -H "Authorization: $TOKEN"
Response example
{
  "code": 200000,
  "info": "execute success"
}
GET/auth/v1/resources/principalsAuth required

Resource principals

Resource principals.

Parameters

  • Authorizationheader · stringrequired

    Token from login.

  • res_idquery · stringoptional

    res_id

  • res_typequery · stringoptional

    res_type

Request
curl -sS -X GET 'http://127.0.0.1:8090/auth/v1/resources/principals' \
  -H "Authorization: $TOKEN"
Response example
{
  "code": 200000,
  "info": "execute success"
}
POST/auth/v1/resources/authorizeAuth required

Authorize resources

Authorize resources.

Parameters

  • Authorizationheader · stringrequired

    Token from login.

  • (body)body · AuthorizeResources[]required

    JSON array of AuthorizeResources; fields below are per-item.

  • principal_idbody · stringoptional

    主体 ID。

  • principal_typebody · stringoptional

    主体类型。

  • resourcesbody · string[]optional

    资源列表。

Response fields

  • codebody · uint32required

    Business code.

  • infobody · stringoptional

    Info.

  • AuthorizeResourcesbody · AuthorizeResourcesoptional

    Entity fields.

    • principal_idbody · stringoptional

      主体 ID。

    • principal_typebody · stringoptional

      主体类型。

    • resourcesbody · string[]optional

      资源列表。

Request
curl -sS -X POST 'http://127.0.0.1:8090/auth/v1/resources/authorize' \
  -H "Authorization: $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '[]'
Response example
{
  "code": 200000,
  "info": "execute success"
}

Roles

Role CRUD.

Admin APIs

Ops APIs for connections, leaders, logs, instance cleanup, and more.

On this page

GET List policiesPOST Create policiesPUT Update policiesPOST Delete policiesGET Policy detailGET Principal resourcesGET Resource principalsPOST Authorize resources