Realms

>>>

GET /api/realms
List of realms

Params

Param name Description
search
optional

filter results

Validations:

  • Must be String
order
optional

sort results

Validations:

  • Must be String
page
optional

paginate results

Validations:

  • Must be String
per_page
optional

number of entries per request

Validations:

  • Must be String
>>>

GET /api/realms/:id
Show a realm

Params

Param name Description
id
required

Numerical ID or realm name

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
Create a realm

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

Params

Param name Description
realm
required

Validations:

  • Must be a Hash
realm[name]
required

The realm name, e.g. EXAMPLE.COM

Validations:

  • Must be String
realm[realm_proxy_id]
required , nil allowed

Proxy to use for this realm

Validations:

  • Must be a number.
realm[realm_type]
required

Realm type, e.g. FreeIPA or Active Directory

Validations:

  • Must be String
>>>

PUT /api/realms/:id
Update a realm

Params

Param name Description
id
required

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
required

Validations:

  • Must be a Hash
realm[name]
optional

The realm name, e.g. EXAMPLE.COM

Validations:

  • Must be String
realm[realm_proxy_id]
optional , nil allowed

Proxy to use for this realm

Validations:

  • Must be a number.
realm[realm_type]
optional

Realm type, e.g. FreeIPA or Active Directory

Validations:

  • Must be String
>>>

DELETE /api/realms/:id
Delete a realm

Params

Param name Description
id
required

Validations:

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