2020-07-27 10:59:08 -07:00
|
|
|
---
|
|
|
|
|
layout: docs
|
2020-10-12 16:19:13 -04:00
|
|
|
page_title: Domain Model - Auth Methods
|
2020-07-27 10:59:08 -07:00
|
|
|
description: |-
|
2020-10-12 16:19:13 -04:00
|
|
|
The anatomy of a Boundary auth method
|
2020-07-27 10:59:08 -07:00
|
|
|
---
|
|
|
|
|
|
2020-10-12 16:19:13 -04:00
|
|
|
# Auth Methods
|
2020-07-27 10:59:08 -07:00
|
|
|
|
2020-10-12 16:19:13 -04:00
|
|
|
An auth method is a resource
|
2020-10-11 14:19:01 -04:00
|
|
|
that provides a mechanism
|
|
|
|
|
for [users][] to authenticate to Boundary.
|
2020-10-12 16:19:13 -04:00
|
|
|
An auth method contains [accounts][]
|
2020-10-11 14:19:01 -04:00
|
|
|
which link an individual user to a set of credentials.
|
2020-10-12 16:19:13 -04:00
|
|
|
Auth methods can be defined at either a [Global][] or [Organization][] [scope][].
|
2020-10-11 14:19:01 -04:00
|
|
|
|
|
|
|
|
## Attributes
|
|
|
|
|
|
2020-10-12 16:19:13 -04:00
|
|
|
All auth methods have the following configurable attributes:
|
2020-10-11 14:19:01 -04:00
|
|
|
|
|
|
|
|
- `name` - (optional)
|
2020-10-12 16:19:13 -04:00
|
|
|
If set, the `name` must be unique within the auth method's scope.
|
2020-10-11 14:19:01 -04:00
|
|
|
|
|
|
|
|
- `description` - (optional)
|
|
|
|
|
|
2020-10-12 16:19:13 -04:00
|
|
|
### Password Auth Method Attributes
|
2020-10-11 14:19:01 -04:00
|
|
|
|
2020-10-12 16:19:13 -04:00
|
|
|
The password auth method has the following additional attributes:
|
2020-10-11 14:19:01 -04:00
|
|
|
|
|
|
|
|
- `min_login_name_length` - (required) The default is 3.
|
|
|
|
|
|
|
|
|
|
- `min_password_length` - (required) The default is 8.
|
|
|
|
|
|
|
|
|
|
## Referenced By
|
|
|
|
|
|
|
|
|
|
- [Account][]
|
|
|
|
|
- [Global][]
|
|
|
|
|
- [Organization][]
|
|
|
|
|
|
|
|
|
|
[account]: /docs/concepts/domain-model/accounts
|
|
|
|
|
[accounts]: /docs/concepts/domain-model/accounts
|
|
|
|
|
[global]: /docs/concepts/domain-model/scopes#global
|
|
|
|
|
[organization]: /docs/concepts/domain-model/scopes#organizations
|
|
|
|
|
[scope]: /docs/concepts/domain-model/scopes
|
|
|
|
|
[users]: /docs/concepts/domain-model/users
|
2020-10-12 17:40:42 -04:00
|
|
|
|
|
|
|
|
## Service API Docs
|
|
|
|
|
|
|
|
|
|
The following services are relevant to this resource:
|
|
|
|
|
|
2021-04-05 12:04:57 -05:00
|
|
|
- [Auth Method Service](/api-docs/auth-method-service)
|
|
|
|
|
- [Auth Token Service](/api-docs/auth-token-service)
|
