Amster

Services

Realm Operations

The collection of services available on a realm.

Resource path:

/realm-config/services

Resource version: 1.0

getAllTypes

Obtain the collection of all secondary configuration types related to the resource.

Usage

am> action Services --realm Realm --actionName getAllTypes

getCreatableTypes

Obtain the collection of secondary configuration types that have yet to be added to the resource.

Usage

am> action Services --realm Realm --actionName getCreatableTypes

nextdescendents

Obtain the collection of secondary configuration instances that have been added to the resource.

Usage

am> action Services --realm Realm --actionName nextdescendents

query

Find services provisioned for the realm - query for a particular service by identifier, or request all services using _queryFilter=true

Usage

am> query Services --realm Realm --filter filter

Parameters

--filter

A CREST formatted query filter, where "true" will query all. Fields that can be queried: [_id]

Global Operations

Global and default configuration for services

Resource path:

/global-config/services

Resource version: 1.0

getAllTypes

Obtain the collection of all secondary configuration types related to the resource.

Usage

am> action Services --global --actionName getAllTypes

getCreatableTypes

Obtain the collection of secondary configuration types that have yet to be added to the resource.

Usage

am> action Services --global --actionName getCreatableTypes

nextdescendents

Obtain the collection of secondary configuration instances that have been added to the resource.

Usage

am> action Services --global --actionName nextdescendents
Copyright © 2010-2024 ForgeRock, all rights reserved.