Realms

>>>

GET /api/realms
Lista domen

Parametry

Nazwa parametru Opis
location_id
opcjonalny

Zakres w zależności od lokalizacji

Validations:

  • Must be a Integer
organization_id
opcjonalny

Zakres w zależności od organizacji

Validations:

  • Must be a Integer
search
opcjonalny

rezultat filtrowania

Validations:

  • Must be a String
order
opcjonalny

Sort field and order, eg. ‘id DESC’

Validations:

  • Must be a String
page
opcjonalny

Page number, starting at 1

Validations:

  • Must be a number.
per_page
opcjonalny

Number of results per page to return

Validations:

  • Must be a number.

Search fields

Field name Typ Possible values
location
location_id
name
organization
organization_id
type
>>>

GET /api/realms/:id
Pokaż domenę

Parametry

Nazwa parametru Opis
location_id
opcjonalny

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
opcjonalny

Set the current organization context for the request

Validations:

  • Must be a Integer
id
wymagany

Numeryczny identyfikator lub nazwa domeny

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.
>>>

POST /api/realms
Utwórz domenę

The name field is used for the name of the realm.

Parametry

Nazwa parametru Opis
location_id
opcjonalny

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
opcjonalny

Set the current organization context for the request

Validations:

  • Must be a Integer
realm
wymagany

Validations:

  • Must be a Hash
realm[name]
wymagany

Nazwa domeny, np EXAMPLE.COM

Validations:

  • Must be a String
realm[realm_proxy_id]
wymagany , nil dopuszczalny

Proxy ID to use within this realm

Validations:

  • Must be a number.
realm[realm_type]
wymagany

Typ domeny, np FreeIPA lub Active Directory

Validations:

  • Must be a String
realm[location_ids]
opcjonalny , nil dopuszczalny

ZMIEŃ lokalizacje o podanym id

Validations:

  • Must be an array of any type
realm[organization_ids]
opcjonalny , nil dopuszczalny

ZMIEŃ organizacje o podanym id

Validations:

  • Must be an array of any type
>>>

PUT /api/realms/:id
Aktualizuj domenę

Parametry

Nazwa parametru Opis
location_id
opcjonalny

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
opcjonalny

Set the current organization context for the request

Validations:

  • Must be a Integer
id
wymagany

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.
realm
wymagany

Validations:

  • Must be a Hash
realm[name]
opcjonalny

Nazwa domeny, np EXAMPLE.COM

Validations:

  • Must be a String
realm[realm_proxy_id]
opcjonalny , nil dopuszczalny

Proxy ID to use within this realm

Validations:

  • Must be a number.
realm[realm_type]
opcjonalny

Typ domeny, np FreeIPA lub Active Directory

Validations:

  • Must be a String
realm[location_ids]
opcjonalny , nil dopuszczalny

ZMIEŃ lokalizacje o podanym id

Validations:

  • Must be an array of any type
realm[organization_ids]
opcjonalny , nil dopuszczalny

ZMIEŃ organizacje o podanym id

Validations:

  • Must be an array of any type
>>>

DELETE /api/realms/:id
Usuń domenę

Parametry

Nazwa parametru Opis
location_id
opcjonalny

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
opcjonalny

Set the current organization context for the request

Validations:

  • Must be a Integer
id
wymagany

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.