Admin (ontrack-dsl feature-600-run-info-903c531 API)

net.nemerosa.ontrack.dsl.Admin

Administration management.

Constructor Summary

Constructors
Constructor and description
`Admin (Ontrack ontrack)`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`Account`	`account(java.lang.String name, java.lang.String fullName, java.lang.String email, java.lang.String password = '', java.util.List<java.lang.String> groupNames = [])` Creating or updating an account
	`AccountGroup`	`accountGroup(java.lang.String name, java.lang.String description)` Creating or updating a group
	`protected Account`	`findAccountByName(java.lang.String name)`
	`protected AccountGroup`	`findGroupByName(java.lang.String groupName)`
	`java.util.List<Role>`	`getAccountGlobalPermissions(java.lang.String accountName)` Gets the list of global roles an account has
	`java.util.List<Role>`	`getAccountGroupGlobalPermissions(java.lang.String groupName)` Gets the list of global roles an account group has
	`java.util.List<Role>`	`getAccountGroupProjectPermissions(java.lang.String projectName, java.lang.String groupName)` Gets the list of roles an account group has on a project
	`java.util.List<Role>`	`getAccountProjectPermissions(java.lang.String projectName, java.lang.String accountName)` Gets the list of roles an account has on a project
	`java.util.List<Account>`	`getAccounts()` Gets the list of accounts
	`java.util.List<AccountGroup>`	`getGroups()` Gets the list of groups
	`java.util.List<GroupMapping>`	`getLdapMappings()` Gets the list of LDAP mappings
	`GroupMapping`	`ldapMapping(java.lang.String name, java.lang.String groupName)` Creates or updates a LDAP mapping
	`void`	`setAccountGlobalPermission(java.lang.String accountName, java.lang.String globalRole)` Sets a global role on an account
	`void`	`setAccountGroupGlobalPermission(java.lang.String groupName, java.lang.String globalRole)` Sets a global role on an account group
	`void`	`setAccountGroupProjectPermission(java.lang.String projectName, java.lang.String groupName, java.lang.String projectRole)` Sets a project role on an account group
	`void`	`setAccountProjectPermission(java.lang.String projectName, java.lang.String accountName, java.lang.String projectRole)` Sets a project role on an account

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.lang.Object`	`java.lang.Object#wait(long, int), java.lang.Object#wait(long), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()`

- Constructor Detail
  - Admin(Ontrack ontrack)
- Method Detail
  - @DSLMethod(value = "Creates or updates an account.", count = 5) Account account(java.lang.String name, java.lang.String fullName, java.lang.String email, java.lang.String password = '', java.util.List<java.lang.String> groupNames = [])
    
    Creating or updating an account
  - @DSLMethod("Creates or updates an account group.") AccountGroup accountGroup(java.lang.String name, java.lang.String description)
    
    Creating or updating a group
  - protected Account findAccountByName(java.lang.String name)
  - protected AccountGroup findGroupByName(java.lang.String groupName)
  - @DSLMethod("Gets the list of global roles an account has. See <>.") java.util.List<Role> getAccountGlobalPermissions(java.lang.String accountName)
    
    Gets the list of global roles an account has
    Parameters:
    accountName - Name of the account to get the permissions for
    Returns:
    List of roles
  - @DSLMethod("Gets the list of global roles an account group has. See <>.") java.util.List<Role> getAccountGroupGlobalPermissions(java.lang.String groupName)
    
    Gets the list of global roles an account group has
    Parameters:
    groupName - Name of the account group to get the permissions for
    Returns:
    List of roles
  - @DSLMethod("Gets the list of roles an account group has on a project. See <>.") java.util.List<Role> getAccountGroupProjectPermissions(java.lang.String projectName, java.lang.String groupName)
    
    Gets the list of roles an account group has on a project
    Parameters:
    groupName - Name of the account group to get the permissions for
    Returns:
    List of roles
  - @DSLMethod("Gets the list of roles an account has on a project. See <>.") java.util.List<Role> getAccountProjectPermissions(java.lang.String projectName, java.lang.String accountName)
    
    Gets the list of roles an account has on a project
    Parameters:
    accountName - Name of the account to get the permissions for
    Returns:
    List of roles
  - @DSLMethod("Returns the list of all accounts.") java.util.List<Account> getAccounts()
    
    Gets the list of accounts
  - @DSLMethod("Returns the list of all groups.") java.util.List<AccountGroup> getGroups()
    
    Gets the list of groups
  - @DSLMethod("Gets the list of LDAP mappings.") java.util.List<GroupMapping> getLdapMappings()
    
    Gets the list of LDAP mappings
  - @DSLMethod("Creates or updates a LDAP mapping.") GroupMapping ldapMapping(java.lang.String name, java.lang.String groupName)
    
    Creates or updates a LDAP mapping
    Parameters:
    name - LDAP group name
    groupName - Group to map to
    Returns:
    Mapping
  - @DSLMethod("Sets a global role on an account. See <>.") void setAccountGlobalPermission(java.lang.String accountName, java.lang.String globalRole)
    
    Sets a global role on an account
  - @DSLMethod("Sets a global role on an account group. See <>.") void setAccountGroupGlobalPermission(java.lang.String groupName, java.lang.String globalRole)
    
    Sets a global role on an account group
  - @DSLMethod("Sets a project role on an account group. See <>.") void setAccountGroupProjectPermission(java.lang.String projectName, java.lang.String groupName, java.lang.String projectRole)
    
    Sets a project role on an account group
  - @DSLMethod("Sets a project role on an account. See <>.") void setAccountProjectPermission(java.lang.String projectName, java.lang.String accountName, java.lang.String projectRole)
    
    Sets a project role on an account

Summary:
Constructor
Method

| Detail:
Constructor
Method

Groovy Documentation

[Groovy] Class Admin

Constructor Summary

Methods Summary

Inherited Methods Summary

Constructor Detail

Admin(Ontrack ontrack)

Method Detail

@DSLMethod(value = "Creates or updates an account.", count = 5) Account account(java.lang.String name, java.lang.String fullName, java.lang.String email, java.lang.String password = '', java.util.List<java.lang.String> groupNames = [])

@DSLMethod("Creates or updates an account group.") AccountGroup accountGroup(java.lang.String name, java.lang.String description)

protected Account findAccountByName(java.lang.String name)

protected AccountGroup findGroupByName(java.lang.String groupName)

@DSLMethod("Gets the list of global roles an account has. See <>.") java.util.List<Role> getAccountGlobalPermissions(java.lang.String accountName)

@DSLMethod("Gets the list of global roles an account group has. See <>.") java.util.List<Role> getAccountGroupGlobalPermissions(java.lang.String groupName)

@DSLMethod("Gets the list of roles an account group has on a project. See <>.") java.util.List<Role> getAccountGroupProjectPermissions(java.lang.String projectName, java.lang.String groupName)

@DSLMethod("Gets the list of roles an account has on a project. See <>.") java.util.List<Role> getAccountProjectPermissions(java.lang.String projectName, java.lang.String accountName)

@DSLMethod("Returns the list of all accounts.") java.util.List<Account> getAccounts()

@DSLMethod("Returns the list of all groups.") java.util.List<AccountGroup> getGroups()

@DSLMethod("Gets the list of LDAP mappings.") java.util.List<GroupMapping> getLdapMappings()

@DSLMethod("Creates or updates a LDAP mapping.") GroupMapping ldapMapping(java.lang.String name, java.lang.String groupName)

@DSLMethod("Sets a global role on an account. See <>.") void setAccountGlobalPermission(java.lang.String accountName, java.lang.String globalRole)

@DSLMethod("Sets a global role on an account group. See <>.") void setAccountGroupGlobalPermission(java.lang.String groupName, java.lang.String globalRole)

@DSLMethod("Sets a project role on an account group. See <>.") void setAccountGroupProjectPermission(java.lang.String projectName, java.lang.String groupName, java.lang.String projectRole)

@DSLMethod("Sets a project role on an account. See <>.") void setAccountProjectPermission(java.lang.String projectName, java.lang.String accountName, java.lang.String projectRole)