Yamcs HTTP API
- Activities
- Alarms
- Audit
- Buckets
- Clearance
- Commands
- COP-1
- Database
- Events
- File Transfer
- IAM
- Indexes
- Instances
- Links
- MDB Override
- MDB
- Packets
- Parameter Archive
- Parameter Lists
- Parameter Values
- Processing
- Queues
- Replication
- RocksDB
- Server
- Services
- Sessions
- Stream Archive
- Table
- Time Correlation
- Time
- Timeline
Related
Yamcs Release Notes
Yamcs Server Manual
Source Code Documentation
Download this Document
Delete GroupΒΆ
Delete a group
URI Template
DELETE /api/groups/{name}
{name}
Group name
Response Type
interface GroupInfo {
// Group name
name: string;
// Group description
description: string;
// Users that are member of this group
users: UserInfo[];
// Service accounts that are member of this group
serviceAccounts: ServiceAccountInfo[];
}
Related Types
interface UserInfo {
// Username
name: string;
// Displayed name
displayName: string;
// Email address
email: string;
// Whether the user may login
active: boolean;
// Whether the user has all privileges
superuser: boolean;
// User that created this user account
createdBy: UserInfo;
// When this user was created
creationTime: string; // RFC 3339 timestamp
// When this user was first activated
confirmationTime: string; // RFC 3339 timestamp
// When this user last logged in
lastLoginTime: string; // RFC 3339 timestamp
// System privileges
systemPrivileges: string[];
// Object privileges
objectPrivileges: ObjectPrivilegeInfo[];
// Groups that this user is member of
groups: GroupInfo[];
// External identities
identities: ExternalIdentityInfo[];
// Assigned roles
roles: RoleInfo[];
// Clearance level. If the command clearance feature is enabled,
// then this user attribute is used as an additional check whether
// the user may send certain commands.
//
// The command clearance feature is disabled by default.
clearance: SignificanceLevelType;
}
interface ObjectPrivilegeInfo {
// Privilege type
type: string;
// Objects of this type
objects: string[];
}
interface ExternalIdentityInfo {
// External identity
identity: string;
// Name of the identity provider
provider: string;
}
interface RoleInfo {
// Role name
name: string;
// Role description
description: string;
// System privileges
systemPrivileges: string[];
// Object privileges
objectPrivileges: ObjectPrivilegeInfo[];
// Whether this role is assigned by default
default: boolean;
}
interface ServiceAccountInfo {
// Service account name
name: string;
// Displayed name
displayName: string;
// Whether the account may login
active: boolean;
// User that created this user account
createdBy: UserInfo;
// When this user was created
creationTime: string; // RFC 3339 timestamp
// When this account was first activated
confirmationTime: string; // RFC 3339 timestamp
// When this account last logged in
lastLoginTime: string; // RFC 3339 timestamp
}
enum SignificanceLevelType {
NONE = "NONE",
WATCH = "WATCH",
WARNING = "WARNING",
DISTRESS = "DISTRESS",
CRITICAL = "CRITICAL",
SEVERE = "SEVERE",
}