Sha256: 587ed3932e16cea949968f062966eed29c16a73f5af1c094c44e9528adf229dc
Contents?: true
Size: 1.23 KB
Versions: 6
Compression:
Stored size: 1.23 KB
Contents
# octopus_deploy_user
Describes an Octopus Deploy [User](https://octopus.com/docs/administration/managing-users-and-teams#Managingusersandteams-UserandServiceaccounts) resource.
## Example
```ruby
describe octopus_deploy_user('bobthedeveloper') do
it { should exist }
it { should be_active }
end
```
#### Type
This type can be instantiated in several ways, depending on [how you authenticate](authentication.md).
```ruby
octopus_deploy_user(url, api_key, user_name) # url and apikey provided
octopus_deploy_user(user_name) # using environment vars
octopus_user(url, api_key, user_name) # shorthand
octopus_user(user_name)
```
#### Matchers
| Matcher | Description |
|:--------|:------------|
| should exist | Tests for existence of a User account with the given name |
| should be_active | Tests if the User is enabled/has the 'Is Active' checkbox checked |
| should have_email(email) | Tests the email address associated with the User account |
| should have_api_key(purpose) | Tests if the User has an API Key with the stated purpose field |
| should have_display_name(name) | Tests the Display Name set for the User |
| should be_service_account | Tests if the User is a service account |
Version data entries
6 entries across 6 versions & 1 rubygems