Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[FEATURE] Add specs for security namespace #233

Closed
27 tasks
nhtruong opened this issue Apr 11, 2024 · 3 comments · Fixed by #271
Closed
27 tasks

[FEATURE] Add specs for security namespace #233

nhtruong opened this issue Apr 11, 2024 · 3 comments · Fixed by #271
Assignees
Labels
enhancement New feature or request

Comments

@nhtruong
Copy link
Collaborator

nhtruong commented Apr 11, 2024

Part of Adding missing API specs issue

  • /_plugins/_security/api/actiongroup/: ["GET"]
  • /_plugins/_security/api/actiongroup/{name}: ["GET","PUT","DELETE"]
  • /_plugins/_security/api/actiongroups/: ["PATCH"]
  • /_plugins/_security/api/allowlist: ["GET","PUT","PATCH"]
  • /_plugins/_security/api/audit/: ["GET","PATCH"]
  • /_plugins/_security/api/authtoken: ["POST"]
  • /_plugins/_security/api/cache: ["GET","PUT","POST"]
  • /_plugins/_security/api/internalusers/: ["GET","PATCH"]
  • /_plugins/_security/api/internalusers/{name}/authtoken: ["POST"]
  • /_plugins/_security/api/migrate: ["POST"]
  • /_plugins/_security/api/permissionsinfo: ["GET"]
  • /_plugins/_security/api/roles/: ["PATCH"]
  • /_plugins/_security/api/rolesmapping/: ["GET","PATCH"]
  • /_plugins/_security/api/ssl/{certType}/reloadcerts/: ["PUT"]
  • /_plugins/_security/api/tenancy/config: ["GET","PUT"]
  • /_plugins/_security/api/user/: ["GET"]
  • /_plugins/_security/api/user/{name}: ["GET","PUT","DELETE"]
  • /_plugins/_security/api/user/{name}/authtoken: ["POST"]
  • /_plugins/_security/api/validate: ["GET"]
  • /_plugins/_security/api/whitelist: ["GET","PUT","PATCH"]
  • /_plugins/_security/authinfo: ["GET","POST"]
  • /_plugins/_security/configupdate: ["PUT"]
  • /_plugins/_security/dashboardsinfo: ["GET","POST"]
  • /_plugins/_security/health: ["POST"]
  • /_plugins/_security/tenantinfo: ["GET","POST"]
  • /_plugins/_security/whoami: ["GET","POST"]
  • /_plugins/_security/whoamiprotected: ["GET"]
@nhtruong nhtruong added enhancement New feature or request untriaged and removed untriaged labels Apr 11, 2024
@DarshitChanpura
Copy link
Member

Expand to see Opensearch-Security supported APIs:
### Auth Info (/_plugins/_security, /_opendistro/_security)
- GET `/authinfo`
- POST `/authinfo`

### Account (/_plugins/_security/api, /_opendistro/_security/api)
- GET `/account`
- PUT `/account`

### Action Group (/_plugins/_security/api, /_opendistro/_security/api)
**Legacy:**
- GET `/actiongroup/{name}`
- GET `/actiongroup`
- DELETE `/actiongroup/{name}`
- PUT `/actiongroup/{name}`

**Corrected in OpenSearch Security:**
- GET `/actiongroups/{name}`
- GET `/actiongroups`
- DELETE `/actiongroups/{name}`
- PUT `/actiongroups/{name}`
- PATCH `/actiongroups`
- PATCH `/actiongroups/{name}`

### Allowlist 
- GET `/_plugins/_security/api/allowlist`
- PUT `/_plugins/_security/api/allowlist`
- PATCH `/_plugins/_security/api/allowlist`

### Audit (/_plugins/_security/api, /_opendistro/_security/api)
- GET `/audit`
- PUT `/audit/config`
- PATCH `/audit`

### Auth Token (/_plugins/_security/api, /_opendistro/_security/api)
- POST `/authtoken`

### Upgrade (/_plugins/_security/api, /_opendistro/_security/api)
- GET `/_upgrade_check`
- POST `/_upgrade_perform`

### Cache (/_plugins/_security/api, /_opendistro/_security/api)
- DELETE `/cache`
- GET `/cache`
- PUT `/cache`
- POST `/cache`

### User/Internal Users (/_plugins/_security/api, /_opendistro/_security/api)
**Legacy:**
- GET `/user/{name}`
- GET `/user`
- POST `/user/{name}/authtoken`
- DELETE `/user/{name}`
- PUT `/user/{name}`

**Corrected in OpenSearch Security:**
- GET `/internalusers/{name}`
- GET `/internalusers`
- POST `/internalusers/{name}/authtoken`
- DELETE `/internalusers/{name}`
- PUT `/internalusers/{name}`
- PATCH `/internalusers`
- PATCH `/internalusers/{name}`

### Migration (/_plugins/_security/api, /_opendistro/_security/api)
- POST `/migrate`

### Tenancy Config (/_plugins/_security/api, /_opendistro/_security/api)
- GET `/tenancy/config`
- PUT `/tenancy/config`

### Node SDN (/_plugins/_security/api, /_opendistro/_security/api)
- GET `/nodesdn/{name}`
- GET `/nodesdn`
- DELETE `/nodesdn/{name}`
- PUT `/nodesdn/{name}`
- PATCH `/nodesdn`
- PATCH `/nodesdn/{name}`

### Permissions Info (/_plugins/_security/api, /_opendistro/_security/api)
- GET `/permissionsinfo`

### Roles (/_plugins/_security/api, /_opendistro/_security/api)
- GET `/roles`
- GET `/roles/{name}`
- DELETE `/roles/{name}`
- PUT `/roles/{name}`
- PATCH `/roles`
- PATCH `/roles/{name}`

### Roles Mapping (/_plugins/_security/api, /_opendistro/_security/api)
- GET `/rolesmapping`
- GET `/rolesmapping/{name}`
- DELETE `/rolesmapping/{name}`
- PUT `/rolesmapping/{name}`
- PATCH `/rolesmapping`
- PATCH `/rolesmapping/{name}`

### Security Config (/_plugins/_security/api, /_opendistro/_security/api)
- GET `/securityconfig`
- PATCH `/securityconfig`
- PUT `/securityconfig/config`

### SSL Certs (/_plugins/_security/api, /_opendistro/_security/api)
- GET `/ssl/certs`
- PUT `/ssl/{certType}/reloadcerts`

### Tenants (/_plugins/_security/api, /_opendistro/_security/api)
- GET `/tenants/{name}`
- GET `/tenants`
- DELETE `/tenants/{name}`
- PUT `/tenants/{name}`
- PATCH `/tenants`
- PATCH `/tenants/{name}`

### Validate (/_plugins/_security/api, /_opendistro/_security/api)
- GET `/validate`

### Dashboards Info (/_plugins/_security)
- GET `/dashboardsinfo`
- POST `/dashboardsinfo`

### Kibana Info (/_opendistro/_security)
- GET `/kibanainfo`
- POST `/kibanainfo`

### Health (/_plugins/_security, /_opendistro/_security)
- GET `/health`
- POST `/health`

### Who Am I (/_plugins/_security)
- GET `/whoami`
- POST `/whoami`
- GET `/whoamiprotected` (protected by security)

### Tenant Info (/_plugins/_security, /_opendistro/_security)
- GET `/tenantinfo`
- POST `/tenantinfo`

### SSL Info
- GET `/_opendistro/_security/sslinfo`

@Jakob3xD
Copy link
Contributor

@DarshitChanpura
Copy link
Member

DarshitChanpura commented Jul 15, 2024

good catch.. these should have items present and they should be of string type. Let me fix that.

Update: #420

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants